Open Inventor Release 2023.2.2
 
Loading...
Searching...
No Matches
SbCylinderSectionProjector Class Reference

Cylinder-section projector. More...

#include <Inventor/projectors/SbCylinderSectionProjector.h>

+ Inheritance diagram for SbCylinderSectionProjector:

Public Member Functions

 SbCylinderSectionProjector (float edgeTol=0.9f, SbBool orientToEye=TRUE)
 Constructor that uses a default cylinder aligned with the Y axis with radius 1.0.
 
 SbCylinderSectionProjector (const SbCylinder &cyl, float edgeTol=0.9f, SbBool orientToEye=TRUE)
 Constructor.
 
 ~SbCylinderSectionProjector ()
 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.
 
void setTolerance (float edgeTol)
 Sets the edge tolerance as a fraction of the radius of the cylinder.
 
float getTolerance () const
 Gets the edge tolerance as a fraction of the radius of the cylinder.
 
SbBool isWithinTolerance (const SbVec3f &point)
 Finds whether this point on the cylinder or tolerance plane is within tolerance.
 
- 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-section projector.

SbCylinderSectionProjector projects a window space point (usually based on the mouse location) onto the section of a cylinder that has been sliced by a plane. Two projected points can produce a rotation along the cylinder's axis. The tolerance slice can be specified as a fraction of the radius of the cylinder. The projection point will not extend beyond the sliced portion of the cylinder.

Incremental changes (delta rotation) can be computed during interactive sessions. Cylinder projectors are typically used to write interactive 3D manipulators and viewers.

SEE ALSO

SbCylinderPlaneProjector, SbCylinderSheetProjector, SbLineProjector, SbPlaneProjector, SbSpherePlaneProjector, SbSphereProjector, SbSphereSectionProjector, SbSphereSheetProjector

Definition at line 85 of file SbCylinderSectionProjector.h.

Constructor & Destructor Documentation

◆ SbCylinderSectionProjector() [1/2]

SbCylinderSectionProjector::SbCylinderSectionProjector ( float  edgeTol = 0.9f,
SbBool  orientToEye = TRUE 
)

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

The position of the plane which slices the cylinder into a section 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 0.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.

◆ SbCylinderSectionProjector() [2/2]

SbCylinderSectionProjector::SbCylinderSectionProjector ( const SbCylinder cyl,
float  edgeTol = 0.9f,
SbBool  orientToEye = TRUE 
)

Constructor.

The position of the plane which slices the cylinder into a section 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 0.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.

◆ ~SbCylinderSectionProjector()

SbCylinderSectionProjector::~SbCylinderSectionProjector ( )
inline

Destructor.

Definition at line 127 of file SbCylinderSectionProjector.h.

Member Function Documentation

◆ copy()

virtual SbProjector * SbCylinderSectionProjector::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.

Reimplemented in SbCylinderPlaneProjector.

◆ getRotation()

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

Computes a rotation based on two points on this projector.

Implements SbCylinderProjector.

Reimplemented in SbCylinderPlaneProjector.

◆ getTolerance()

float SbCylinderSectionProjector::getTolerance ( ) const
inline

Gets the edge tolerance as a fraction of the radius of the cylinder.

Definition at line 162 of file SbCylinderSectionProjector.h.

◆ intersect()

virtual SbVec3f SbCylinderSectionProjector::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.

Reimplemented in SbCylinderPlaneProjector.

◆ isWithinTolerance()

SbBool SbCylinderSectionProjector::isWithinTolerance ( const SbVec3f point)

Finds whether this point on the cylinder or tolerance plane is within tolerance.

◆ project()

virtual SbVec3f SbCylinderSectionProjector::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.

Reimplemented in SbCylinderPlaneProjector.

◆ setTolerance()

void SbCylinderSectionProjector::setTolerance ( float  edgeTol)

Sets the edge tolerance as a fraction of the radius of the cylinder.

If this is 1.0, the projector is a half cylinder. If this is 0.1, the projector is a slice of the cylinder with radius 0.1*radius. Default is 0.9.


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