Open Inventor Reference
SbCylinderPlaneProjector Class Reference

Cylinder-plane projector. More...

#include <Inventor/projectors/SbCylinderPlaneProjector.h>

Inheritance diagram for SbCylinderPlaneProjector:
SbCylinderSectionProjector SbCylinderProjector SbProjector

Public Member Functions

 SbCylinderPlaneProjector (float edgeTol=.9, bool orientToEye=TRUE)
 
 SbCylinderPlaneProjector (const SbCylinder &cyl, float edgeTol=.9, bool orientToEye=TRUE)
 Constructors. More...
 
 ~SbCylinderPlaneProjector ()
 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 SbCylinderSectionProjector
 SbCylinderSectionProjector (float edgeTol=.9, bool orientToEye=TRUE)
 Default constructor. More...
 
 SbCylinderSectionProjector (const SbCylinder &cyl, float edgeTol=.9, bool orientToEye=TRUE)
 Constructor taking the cylinder. More...
 
 ~SbCylinderSectionProjector ()
 Destructor. More...
 
void setTolerance (float edgeTol)
 
float getTolerance () const
 Set and get the edge tolerance as a fraction of the radius of the cylinder. More...
 
bool isWithinTolerance (const SbVec3f &point)
 Find whether this point on the cylinder or tolerance plane is within tolerance. 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

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

Additional Inherited Members

- Protected Attributes inherited from SbCylinderSectionProjector
float tolerance
 Information about the ring tolerance. More...
 
float tolDist
 dist from planeLine to cylinder More...
 
SbVec3f planeDir
 Information about the plane used for intersection testing. More...
 
SbLine planeLine
 line parallel to axis, but in plane More...
 
float planeDist
 distance from cylinder center 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

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 
)

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