Open Inventor Release 2024.1.3
 
Loading...
Searching...
No Matches
SbCylinderSheetProjector Class Reference

Cylinder-sheet projector. More...

#include <Inventor/projectors/SbCylinderSheetProjector.h>

+ Inheritance diagram for SbCylinderSheetProjector:

Public Member Functions

 SbCylinderSheetProjector (SbBool orientToEye=TRUE)
 Constructor that uses a default cylinder aligned with the Y axis with radius 1.0.
 
 SbCylinderSheetProjector (const SbCylinder &cyl, SbBool orientToEye=TRUE)
 Constructor.
 
 ~SbCylinderSheetProjector ()
 Destructor.
 
virtual SbProjectorcopy () const
 Returns an instance that is a copy of this instance.
 
virtual SbVec3f project (const SbVec2f &point)
 Applies the projector using the given point, returning the point in three dimensions that it projects to.
 
virtual SbVec3f intersect (const SbLine &line)
 Applies the projector using the given line in world coordinates, 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
virtual ~SbCylinderProjector ()
 Destructor.
 
SbVec3f projectAndGetRotation (const SbVec2f &point, SbRotation &rot)
 Applies the projector using the given point, returning the point in three dimensions that it projects to.
 
void setCylinder (const SbCylinder &cyl)
 Sets the cylinder on which to project points.
 
const SbCylindergetCylinder () const
 Gets the cylinder on which to project points.
 
void setOrientToEye (SbBool orientToEye)
 Sets whether the projector should always be oriented towards the eye.
 
SbBool isOrientToEye () const
 Gets whether the projector should always be oriented towards the eye.
 
void setFront (SbBool isFront)
 Sets whether the projector should intersect the half of the cylinder that faces the eye.
 
SbBool isFront () const
 Gets whether the projector should intersect the half of the cylinder that faces the eye.
 
SbBool isPointInFront (const SbVec3f &point) const
 Gets whether the projector should intersect the half of the cylinder that faces the eye.
 
virtual void setWorkingSpace (const SbMatrix &space)
 Sets the transform space to work in.
 
- Public Member Functions inherited from SbProjector
virtual ~SbProjector ()
 Destructor.
 
virtual void setViewVolume (const SbViewVolume &vol)
 Set the view volume to use for the projection.
 
const SbViewVolumegetViewVolume () const
 Get the view volume to use for the projection.
 
const SbMatrixgetWorkingSpace () const
 Get the transform space to work in.
 

Detailed Description

Cylinder-sheet projector.

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 85 of file SbCylinderSheetProjector.h.

Constructor & Destructor Documentation

◆ SbCylinderSheetProjector() [1/2]

SbCylinderSheetProjector::SbCylinderSheetProjector ( SbBool  orientToEye = TRUE)

Constructor that uses a default cylinder aligned with the Y axis with radius 1.0.

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() [2/2]

SbCylinderSheetProjector::SbCylinderSheetProjector ( const SbCylinder cyl,
SbBool  orientToEye = TRUE 
)

Constructor.

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

Destructor.

Definition at line 115 of file SbCylinderSheetProjector.h.

Member Function Documentation

◆ copy()

virtual SbProjector * SbCylinderSheetProjector::copy ( ) const
virtual

Returns an instance that is a copy of this instance.

The caller is responsible for deleting the copy when done.

Implements SbProjector.

◆ getRotation()

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

Computes a rotation based on two points on this projector.

Implements SbCylinderProjector.

◆ intersect()

virtual SbVec3f SbCylinderSheetProjector::intersect ( const SbLine line)
virtual

Applies the projector using the given line in world coordinates, returning the point in three dimensions that it projects to.

New for v3.0.

Implements SbCylinderProjector.

◆ project()

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

Applies the projector using the given point, returning the point in three dimensions that it projects to.

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

Implements SbCylinderProjector.


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