Cylinder-plane projector. More...

#include <Inventor/projectors/SbCylinderPlaneProjector.h>

Inheritance diagram for SbCylinderPlaneProjector:

Public Member Functions
	SbCylinderPlaneProjector (float edgeTol=0.9f, SbBool orientToEye=TRUE)
	Constructor that uses a default cylinder aligned with the Y axis with radius 1.0.

	SbCylinderPlaneProjector (const SbCylinder &cyl, float edgeTol=0.9f, SbBool orientToEye=TRUE)
	Constructor.

	~SbCylinderPlaneProjector ()
	Destructor.

virtual SbProjector *	copy () const
	Returns an instance that is a copy of this instance.

virtual SbVec3f	project (const SbVec2f &point)
	Applies the projector using the given point, returning the point in three dimensions that it projects to.

virtual SbVec3f	intersect (const SbLine &line)
	Applies the projector using the given line in world coordinates, returning the point in three dimensions that it projects to.

virtual SbRotation	getRotation (const SbVec3f &point1, const SbVec3f &point2)
	Computes a rotation based on two points on this projector.

Public Member Functions inherited from SbCylinderSectionProjector
	SbCylinderSectionProjector (float edgeTol=0.9f, SbBool orientToEye=TRUE)
	Constructor that uses a default cylinder aligned with the Y axis with radius 1.0.

	SbCylinderSectionProjector (const SbCylinder &cyl, float edgeTol=0.9f, SbBool orientToEye=TRUE)
	Constructor.

	~SbCylinderSectionProjector ()
	Destructor.

void	setTolerance (float edgeTol)
	Sets the edge tolerance as a fraction of the radius of the cylinder.

float	getTolerance () const
	Gets the edge tolerance as a fraction of the radius of the cylinder.

SbBool	isWithinTolerance (const SbVec3f &point)
	Finds whether this point on the cylinder or tolerance plane is within tolerance.

Public Member Functions inherited from SbCylinderProjector
virtual	~SbCylinderProjector ()
	Destructor.

SbVec3f	projectAndGetRotation (const SbVec2f &point, SbRotation &rot)
	Applies the projector using the given point, returning the point in three dimensions that it projects to.

void	setCylinder (const SbCylinder &cyl)
	Sets the cylinder on which to project points.

const SbCylinder &	getCylinder () const
	Gets the cylinder on which to project points.

void	setOrientToEye (SbBool orientToEye)
	Sets whether the projector should always be oriented towards the eye.

SbBool	isOrientToEye () const
	Gets whether the projector should always be oriented towards the eye.

void	setFront (SbBool isFront)
	Sets whether the projector should intersect the half of the cylinder that faces the eye.

SbBool	isFront () const
	Gets whether the projector should intersect the half of the cylinder that faces the eye.

SbBool	isPointInFront (const SbVec3f &point) const
	Gets whether the projector should intersect the half of the cylinder that faces the eye.

virtual void	setWorkingSpace (const SbMatrix &space)
	Sets the transform space to work in.

Public Member Functions inherited from SbProjector
virtual	~SbProjector ()
	Destructor.

virtual void	setViewVolume (const SbViewVolume &vol)
	Set the view volume to use for the projection.

const SbViewVolume &	getViewVolume () const
	Get the view volume to use for the projection.

const SbMatrix &	getWorkingSpace () const
	Get the transform space to work in.

Detailed Description

Cylinder-plane projector.

SbCylinderPlaneProjector projects a window space point (usually based on the mouse location) onto a surface defined by a cylinder and plane cutting through the cylinder. Two projected points can produce a rotation along the cylinder's axis. When the mouse position projects onto the plane, the rotations will be as if the plane is being dragged, causing the cylinder to roll beneath it.

Incremental changes (delta rotation) can be computed during interactive sessions. Cylinder projectors are typically used to write interactive 3D manipulators and viewers.

Constructor & Destructor Documentation

◆ SbCylinderPlaneProjector() [1/2]

SbCylinderPlaneProjector::SbCylinderPlaneProjector	(	float	edgeTol = `0.9f`,
		SbBool	orientToEye = `TRUE`
	)

Constructor that uses a default cylinder aligned with the Y axis with radius 1.0.

The position of the plane is specified as a fraction of the cylinder radius with the parameter edgeTol. A tolerance value of 1.0 positions the plane down the center of the cylinder. A tolerance value of 0.5 defines the longitudinal plane halfway between the center and the outside edge of the cylinder. The default value is 0.9, so that almost half the cylinder is in front of the plane. The orientToEye parameter determines whether the plane is perpendicular to the eye, or perpendicular to the cylinder's Z axis. Setting that parameter to TRUE (the default) specifies that the plane be perpendicular to the eye, which is most often the desired behavior.

The default view volume is undefined, and the working space is identity.

◆ SbCylinderPlaneProjector() [2/2]

SbCylinderPlaneProjector::SbCylinderPlaneProjector	(	const SbCylinder &	cyl,
		float	edgeTol = `0.9f`,
		SbBool	orientToEye = `TRUE`
	)

Constructor.

The position of the plane is specified as a fraction of the cylinder radius with the parameter edgeTol. A tolerance value of 1.0 positions the plane down the center of the cylinder. A tolerance value of 0.5 defines the longitudinal plane halfway between the center and the outside edge of the cylinder. The default value is 0.9, so that almost half the cylinder is in front of the plane. The orientToEye parameter determines whether the plane is perpendicular to the eye, or perpendicular to the cylinder's Z axis. Setting that parameter to TRUE (the default) specifies that the plane be perpendicular to the eye, which is most often the desired behavior.

The default view volume is undefined, and the working space is identity.

◆ ~SbCylinderPlaneProjector()

SbCylinderPlaneProjector::~SbCylinderPlaneProjector ( )

inline

Destructor.

Definition at line 125 of file SbCylinderPlaneProjector.h.

Member Function Documentation

◆ copy()

virtual SbProjector * SbCylinderPlaneProjector::copy ( ) const

virtual

Returns an instance that is a copy of this instance.

The caller is responsible for deleting the copy when done.

Reimplemented from SbCylinderSectionProjector.

◆ getRotation()

virtual SbRotation SbCylinderPlaneProjector::getRotation	(	const SbVec3f &	point1,
		const SbVec3f &	point2
	)

virtual

Computes a rotation based on two points on this projector.

Reimplemented from SbCylinderSectionProjector.

◆ intersect()

virtual SbVec3f SbCylinderPlaneProjector::intersect ( const SbLine & line )

virtual

Applies the projector using the given line in world coordinates, returning the point in three dimensions that it projects to.

New for v3.0

Reimplemented from SbCylinderSectionProjector.

◆ project()

virtual SbVec3f SbCylinderPlaneProjector::project ( const SbVec2f & point )

virtual

Applies the projector using the given point, returning the point in three dimensions that it projects to.

The point should be normalized from 0-1, with (0,0) at the lower-left.

Reimplemented from SbCylinderSectionProjector.

The documentation for this class was generated from the following file:

Inventor/projectors/SbCylinderPlaneProjector.h

Open Inventor Release 2023.2.3

Public Member Functions

Detailed Description

SEE ALSO

Constructor & Destructor Documentation

◆ SbCylinderPlaneProjector() [1/2]

◆ SbCylinderPlaneProjector() [2/2]

◆ ~SbCylinderPlaneProjector()

Member Function Documentation

◆ copy()

◆ getRotation()

◆ intersect()

◆ project()