Cylinder-plane projector. More...

#include <Inventor/projectors/SbCylinderPlaneProjector.h>

Inheritance diagram for SbCylinderPlaneProjector:

Public Member Functions
	SbCylinderPlaneProjector (float edgeTol=.9, bool orientToEye=TRUE)

	SbCylinderPlaneProjector (const SbCylinder &cyl, float edgeTol=.9, bool orientToEye=TRUE)
	Constructors.

	~SbCylinderPlaneProjector ()
	Destructor.

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

virtual SbVec3f	project (const SbVec2f &point)
	Apply the projector using the given point, 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=.9, bool orientToEye=TRUE)
	Default constructor.

	SbCylinderSectionProjector (const SbCylinder &cyl, float edgeTol=.9, bool orientToEye=TRUE)
	Constructor taking the cylinder.

	~SbCylinderSectionProjector ()
	Destructor.

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

virtual SbVec3f	project (const SbVec2f &point)
	Apply the projector using the given point, 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.

void	setTolerance (float edgeTol)

float	getTolerance () const
	Set and get the edge tolerance as a fraction of the radius of the cylinder.

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

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

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

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

virtual SbRotation	getRotation (const SbVec3f &point1, const SbVec3f &point2)=0
	Get a rotation given two points on this cylinder projector.

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

const SbCylinder &	getCylinder () const
	Set and get the cylinder on which to project points.

void	setOrientToEye (bool orientToEye)
	Set and get whether the projector should always be oriented towards the eye.

bool	isOrientToEye () const
	Set and get whether the projector should always be oriented towards the eye.

void	setFront (bool isFront)
	Set and get whether the projector should intersect the half of the cylinder that faces the eye.

bool	isFront () const
	Set and get whether the projector should intersect the half of the cylinder that faces the eye.

bool	isPointInFront (const SbVec3f &point) const
	Set and get whether the projector should intersect the half of the cylinder that faces the eye.

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

Public Member Functions inherited from SbProjector
virtual SbVec3f	project (const SbVec2f &point)=0
	Apply the projector using the given point, returning the point in three dimensions that it projects to.

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.

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

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

virtual SbProjector *	copy () const =0
	Creates and returns an exact copy of the projector.

Protected Member Functions
SbRotation	getRotation (const SbVec3f &point1, bool tol1, const SbVec3f &point2, bool tol2)

Protected Member Functions inherited from SbCylinderSectionProjector
virtual void	setupTolerance ()
	Sets up the tolerance ring.

Protected Member Functions inherited from SbCylinderProjector
	SbCylinderProjector (bool orientToEye)
	Constructors The default cylinder to is centered about the Y axis and has a radius of 1.0.

	SbCylinderProjector (const SbCylinder &cyl, bool orientToEye)

Protected Member Functions inherited from SbProjector
	SbProjector ()
	Default constructor.

virtual	~SbProjector ()

SbLine	getWorkingLine (const SbVec2f &point) const
	Given this mouse point, return the line it projects to in working space.

Additional Inherited Members
Protected Attributes inherited from SbCylinderSectionProjector
float	tolerance
	Information about the ring tolerance.

float	tolDist
	dist from planeLine to cylinder

SbVec3f	planeDir
	Information about the plane used for intersection testing.

SbLine	planeLine
	line parallel to axis, but in plane

float	planeDist
	distance from cylinder center

SbPlane	tolPlane
	the plane itself

Protected Attributes inherited from SbCylinderProjector
bool	intersectFront
	Are intersections done on the front half ( if not, they're done on th e back half) of the cylinder?

SbCylinder	cylinder
	Cylinder for this projector.

bool	orientToEye
	TRUE if always oriented to eye.

bool	needSetup
	Set TRUE whenever cylinder, work space or orientation changes.

SbVec3f	lastPoint
	Cached last point on this projector.

Protected Attributes inherited from SbProjector
SbViewVolume	viewVol

SbMatrix	worldToWorking

SbMatrix	workingToWorld

Detailed Description

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.

See Also

: SbCylinderSheetProjector, SbLineProjector, SbPlaneProjector, SbSpherePlaneProjector, SbSphereProjector, SbSphereSectionProjector, SbSphereSheetProjector

Definition at line 91 of file SbCylinderPlaneProjector.h.

Constructor & Destructor Documentation

◆ SbCylinderPlaneProjector() [1/2]

SbCylinderPlaneProjector::SbCylinderPlaneProjector	(	float	edgeTol = `.9`,
		bool	orientToEye = `TRUE`
	)

See also: SbCylinderPlaneProjector(const SbCylinder &cyl,float edgeTol,bool orientToEye)

◆ SbCylinderPlaneProjector() [2/2]

SbCylinderPlaneProjector::SbCylinderPlaneProjector	(	const SbCylinder &	cyl,
		float	edgeTol = `.9`,
		bool	orientToEye = `TRUE`
	)

The first uses a default cylinder aligned with the Y axis with radius 1.0; the cylinder is supplied in the second. 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 .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

Definition at line 120 of file SbCylinderPlaneProjector.h.

Member Function Documentation

◆ copy()

virtual SbProjector * SbCylinderPlaneProjector::copy ( ) const

virtual

The caller is responsible for deleting the copy when done.

Reimplemented from SbCylinderSectionProjector.

◆ getRotation() [1/2]

SbRotation SbCylinderPlaneProjector::getRotation	(	const SbVec3f &	point1,
		bool	tol1,
		const SbVec3f &	point2,
		bool	tol2
	)

protected

◆ getRotation() [2/2]

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

virtual

Reimplemented from SbCylinderSectionProjector.

◆ project()

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

virtual

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:

C:/jh/mevislab/4.0.2_1/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/projectors/SbCylinderPlaneProjector.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SbCylinderPlaneProjector() [1/2]

◆ SbCylinderPlaneProjector() [2/2]

◆ ~SbCylinderPlaneProjector()

Member Function Documentation

◆ copy()

◆ getRotation() [1/2]

◆ getRotation() [2/2]

◆ project()