Open Inventor Reference
SbCylinderPlaneProjector Class Reference

Cylinder-plane projector. More...

#include <Inventor/projectors/SbCylinderPlaneProjector.h>

Inheritance diagram for SbCylinderPlaneProjector:
SbCylinderSectionProjector SbCylinderProjector SbProjector

List of all members.

Public Member Functions

 SbCylinderPlaneProjector (float edgeTol=.9, SbBool orientToEye=TRUE)
 SbCylinderPlaneProjector (const SbCylinder &cyl, float edgeTol=.9, SbBool orientToEye=TRUE)
 Constructors.
 ~SbCylinderPlaneProjector ()
 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

SbRotation getRotation (const SbVec3f &point1, SbBool tol1, const SbVec3f &point2, SbBool tol2)

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::SbCylinderPlaneProjector ( float  edgeTol = .9,
SbBool  orientToEye = TRUE 
)
SbCylinderPlaneProjector::SbCylinderPlaneProjector ( const SbCylinder cyl,
float  edgeTol = .9,
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 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 ( ) [inline]

Definition at line 120 of file SbCylinderPlaneProjector.h.


Member Function Documentation

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

The caller is responsible for deleting the copy when done.

Reimplemented from SbCylinderSectionProjector.

SbRotation SbCylinderPlaneProjector::getRotation ( const SbVec3f point1,
SbBool  tol1,
const SbVec3f point2,
SbBool  tol2 
) [protected]
virtual SbRotation SbCylinderPlaneProjector::getRotation ( const SbVec3f point1,
const SbVec3f point2 
) [virtual]

Reimplemented from SbCylinderSectionProjector.

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: