SbCylinderProjector Class Reference

Cylinder projector. More...

#include <Inventor/projectors/SbCylinderProjector.h>

Inheritance diagram for SbCylinderProjector:

Public Member Functions
virtual	~SbCylinderProjector ()
	Destructor.
virtual SbVec3f	project (const SbVec2f &point)=0
	Applies the projector using the given point, returning the point in three dimensions that it projects to.
virtual SbVec3f	intersect (const SbLine &line)=0
	Applies the projector using the given line in world coordinates, returning the point in three dimensions that it projects to.
SbVec3f	projectAndGetRotation (const SbVec2f &point, SbRotation &rot)
	Applies 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
	Gets a rotation given two points on this cylinder projector.
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.
virtual SbProjector *	copy () const =0
	Creates and returns an exact copy of the projector.

Detailed Description

Cylinder projector.

SbCylinderProjector is an abstract base class for projectors that use a cylinder in their projection. The getRotation() method for an SbCylinderProjector will always return a rotation that is about the axis of the cylinder. Cylinder projectors are typically used to write interactive 3D manipulators and viewers.

SEE ALSO

SbCylinderPlaneProjector, SbCylinderSectionProjector, SbCylinderSheetProjector, SbLineProjector, SbPlaneProjector, SbSpherePlaneProjector, SbSphereProjector, SbSphereSectionProjector, SbSphereSheetProjector

Definition at line 79 of file SbCylinderProjector.h.

Constructor & Destructor Documentation

~SbCylinderProjector()

virtual SbCylinderProjector::~SbCylinderProjector ( )

inlinevirtual

Destructor.

Definition at line 85 of file SbCylinderProjector.h.

Member Function Documentation

getCylinder()

const SbCylinder & SbCylinderProjector::getCylinder ( ) const

inline

Gets the cylinder on which to project points.

Definition at line 127 of file SbCylinderProjector.h.

getRotation()

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

pure virtual

Gets a rotation given two points on this cylinder projector.

The rotation will be about the axis of the cylinder.

Implemented in SbCylinderPlaneProjector, SbCylinderSectionProjector, and SbCylinderSheetProjector.

intersect()

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

pure 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

Implements SbProjector.

Implemented in SbCylinderPlaneProjector, SbCylinderSectionProjector, and SbCylinderSheetProjector.

isFront()

SbBool SbCylinderProjector::isFront ( ) const

inline

Gets whether the projector should intersect the half of the cylinder that faces the eye.

Definition at line 148 of file SbCylinderProjector.h.

isOrientToEye()

SbBool SbCylinderProjector::isOrientToEye ( ) const

inline

Gets whether the projector should always be oriented towards the eye.

Definition at line 137 of file SbCylinderProjector.h.

isPointInFront()

SbBool SbCylinderProjector::isPointInFront

(

const SbVec3f &

point

)

const

Gets whether the projector should intersect the half of the cylinder that faces the eye.

project()

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

pure 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.

Implements SbProjector.

Implemented in SbCylinderPlaneProjector, SbCylinderSectionProjector, and SbCylinderSheetProjector.

projectAndGetRotation()

SbVec3f SbCylinderProjector::projectAndGetRotation	(	const SbVec2f &	point,
		SbRotation &	rot
	)

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

This also returns in rot a rotation about the axis of the cylinder from the last projected point to this one. The passed point should be normalized (i.e. lie in the range [0.0,1.0]), with (0,0) at the lower-left.

setCylinder()

void SbCylinderProjector::setCylinder

(

const SbCylinder &

cyl

)

Sets the cylinder on which to project points.

The default cylinder is aligned with the Y axis and has radius 1.0.

setFront()

void SbCylinderProjector::setFront

(

SbBool

isFront

)

Sets whether the projector should intersect the half of the cylinder that faces the eye.

Set to FALSE if the projector should intersect with the rear half.

setOrientToEye()

void SbCylinderProjector::setOrientToEye

(

SbBool

orientToEye

)

Sets whether the projector should always be oriented towards the eye.

Set to FALSE if the tolerance should be evaluated in working space.

setWorkingSpace()

virtual void SbCylinderProjector::setWorkingSpace ( const SbMatrix &  space )

virtual

Sets the transform space to work in.

Reimplemented from SbProjector.

---

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

• Inventor/projectors/SbCylinderProjector.h