Open Inventor Reference
SbCylinderSheetProjector Class Reference

Cylinder-sheet projector. More...

#include <Inventor/projectors/SbCylinderSheetProjector.h>

Inheritance diagram for SbCylinderSheetProjector:
SbCylinderProjector SbProjector

List of all members.

Public Member Functions

 SbCylinderSheetProjector (SbBool orientToEye=TRUE)
 SbCylinderSheetProjector (const SbCylinder &cyl, SbBool orientToEye=TRUE)
 Constructors.
 ~SbCylinderSheetProjector ()
 Destructor.
virtual SbProjectorcopy () 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.

Protected Member Functions

virtual void setupPlane ()
 Sets up the tolerance plane.

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

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::SbCylinderSheetProjector ( SbBool  orientToEye = TRUE)
SbCylinderSheetProjector::SbCylinderSheetProjector ( const SbCylinder cyl,
SbBool  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 ( ) [inline]

Definition at line 110 of file SbCylinderSheetProjector.h.


Member Function Documentation

virtual SbProjector* SbCylinderSheetProjector::copy ( ) const [virtual]

The caller is responsible for deleting the copy when done.

Implements SbProjector.

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

Implements SbCylinderProjector.

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.

virtual void SbCylinderSheetProjector::setupPlane ( ) [protected, virtual]

Member Data Documentation

normal direction

Definition at line 134 of file SbCylinderSheetProjector.h.


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