SbCylinderSheetProjector Class Reference

Cylinder-sheet projector. More...

#include <Inventor/projectors/SbCylinderSheetProjector.h>

Inheritance diagram for SbCylinderSheetProjector:

Public Member Functions
	SbCylinderSheetProjector (bool orientToEye=TRUE)
	SbCylinderSheetProjector (const SbCylinder &cyl, bool orientToEye=TRUE)
	Constructors.
	~SbCylinderSheetProjector ()
	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 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
virtual void	setupPlane ()
	Sets up the tolerance plane.
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.

Protected Attributes
SbVec3f	workingProjPoint
	The projection point in working space.
SbVec3f	planeDir
	Information about the plane used for intersection testing.
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

SbCylinderSheetProjector projects a window space point (usually based on the mouse location) onto the surface of a cylinder with a hyperbolic sheet draped over it. This allows smooth transitions onto and off of the cylinder. Two projected points can produce a rotation along the cylinder's axis. When the mouse position projects on to the sheet, the rotations will be as if the sheet 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

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

Definition at line 89 of file SbCylinderSheetProjector.h.

Constructor & Destructor Documentation

SbCylinderSheetProjector() [1/2]

SbCylinderSheetProjector::SbCylinderSheetProjector

(

bool

orientToEye = TRUE

)

See also

SbCylinderSheetProjector(const SbCylinder &cyl,bool orientToEye)

SbCylinderSheetProjector() [2/2]

SbCylinderSheetProjector::SbCylinderSheetProjector	(	const SbCylinder &	cyl,
		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 orientToEye parameter determines whether the sheet 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.

~SbCylinderSheetProjector()

SbCylinderSheetProjector::~SbCylinderSheetProjector ( )

inline

Definition at line 110 of file SbCylinderSheetProjector.h.

Member Function Documentation

copy()

virtual SbProjector * SbCylinderSheetProjector::copy ( ) const

virtual

The caller is responsible for deleting the copy when done.

Implements SbProjector.

getRotation()

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

virtual

Implements SbCylinderProjector.

project()

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

virtual

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

Implements SbCylinderProjector.

setupPlane()

virtual void SbCylinderSheetProjector::setupPlane ( )

protectedvirtual

Member Data Documentation

planeDir

SbVec3f SbCylinderSheetProjector::planeDir

protected

normal direction

Definition at line 134 of file SbCylinderSheetProjector.h.

tolPlane

SbPlane SbCylinderSheetProjector::tolPlane

protected

Definition at line 135 of file SbCylinderSheetProjector.h.

workingProjPoint

SbVec3f SbCylinderSheetProjector::workingProjPoint

protected

Definition at line 131 of file SbCylinderSheetProjector.h.

---

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/SbCylinderSheetProjector.h