Open Inventor Reference
SbCylinderSheetProjector Class Reference

Cylinder-sheet projector. More...

#include <Inventor/projectors/SbCylinderSheetProjector.h>

Inheritance diagram for SbCylinderSheetProjector:
SbCylinderProjector SbProjector

Public Member Functions

 SbCylinderSheetProjector (bool orientToEye=TRUE)
 
 SbCylinderSheetProjector (const SbCylinder &cyl, bool orientToEye=TRUE)
 Constructors. More...
 
 ~SbCylinderSheetProjector ()
 Destructor. More...
 
virtual SbProjectorcopy () const
 Returns an instance that is a copy of this instance. More...
 
virtual SbVec3f project (const SbVec2f &point)
 Apply the projector using the given point, returning the point in three dimensions that it projects to. More...
 
virtual SbRotation getRotation (const SbVec3f &point1, const SbVec3f &point2)
 Computes a rotation based on two points on this projector. More...
 
- Public Member Functions inherited from SbCylinderProjector
 ~SbCylinderProjector ()
 Destructor. More...
 
SbVec3f projectAndGetRotation (const SbVec2f &point, SbRotation &rot)
 Apply the projector using the given point, returning the point in three dimensions that it projects to. More...
 
void setCylinder (const SbCylinder &cyl)
 Set and get the cylinder on which to project points. More...
 
const SbCylindergetCylinder () const
 Set and get the cylinder on which to project points. More...
 
void setOrientToEye (bool orientToEye)
 Set and get whether the projector should always be oriented towards the eye. More...
 
bool isOrientToEye () const
 Set and get whether the projector should always be oriented towards the eye. More...
 
void setFront (bool isFront)
 Set and get whether the projector should intersect the half of the cylinder that faces the eye. More...
 
bool isFront () const
 Set and get whether the projector should intersect the half of the cylinder that faces the eye. More...
 
bool isPointInFront (const SbVec3f &point) const
 Set and get whether the projector should intersect the half of the cylinder that faces the eye. More...
 
virtual void setWorkingSpace (const SbMatrix &space)
 Set the transform space to work in. More...
 
- Public Member Functions inherited from SbProjector
virtual void setViewVolume (const SbViewVolume &vol)
 Set the view volume to use for the projection. More...
 
const SbViewVolumegetViewVolume () const
 Get the view volume to use for the projection. More...
 
const SbMatrixgetWorkingSpace () const
 Get the transform space to work in. More...
 

Protected Member Functions

virtual void setupPlane ()
 Sets up the tolerance plane. More...
 
- 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. More...
 
 SbCylinderProjector (const SbCylinder &cyl, bool orientToEye)
 
- Protected Member Functions inherited from SbProjector
 SbProjector ()
 Default constructor. More...
 
virtual ~SbProjector ()
 
SbLine getWorkingLine (const SbVec2f &point) const
 Given this mouse point, return the line it projects to in working space. More...
 

Protected Attributes

SbVec3f workingProjPoint
 The projection point in working space. More...
 
SbVec3f planeDir
 Information about the plane used for intersection testing. More...
 
SbPlane tolPlane
 the plane itself More...
 
- 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? More...
 
SbCylinder cylinder
 Cylinder for this projector. More...
 
bool orientToEye
 TRUE if always oriented to eye. More...
 
bool needSetup
 Set TRUE whenever cylinder, work space or orientation changes. More...
 
SbVec3f lastPoint
 Cached last point on this projector. More...
 
- 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)

◆ 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: