Open Inventor Reference
SbCylinderSectionProjector Class Reference

Cylinder-section projector. More...

#include <Inventor/projectors/SbCylinderSectionProjector.h>

Inheritance diagram for SbCylinderSectionProjector:
SbCylinderProjector SbProjector SbCylinderPlaneProjector

Public Member Functions

 SbCylinderSectionProjector (float edgeTol=.9, bool orientToEye=TRUE)
 Default constructor.
 
 SbCylinderSectionProjector (const SbCylinder &cyl, float edgeTol=.9, bool orientToEye=TRUE)
 Constructor taking the cylinder.
 
 ~SbCylinderSectionProjector ()
 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.
 
void setTolerance (float edgeTol)
 
float getTolerance () const
 Set and get the edge tolerance as a fraction of the radius of the cylinder.
 
bool isWithinTolerance (const SbVec3f &point)
 Find whether this point on the cylinder or tolerance plane is within tolerance.
 
- Public Member Functions inherited from SbCylinderProjector
 ~SbCylinderProjector ()
 Destructor.
 
virtual SbVec3f project (const SbVec2f &point)=0
 Apply the projector using the given point, returning the point in three dimensions that it projects to.
 
SbVec3f projectAndGetRotation (const SbVec2f &point, SbRotation &rot)
 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)=0
 Get a rotation given two points on this cylinder projector.
 
void setCylinder (const SbCylinder &cyl)
 Set and get the cylinder on which to project points.
 
const SbCylindergetCylinder () const
 Set and get the cylinder on which to project points.
 
void setOrientToEye (bool orientToEye)
 Set and get whether the projector should always be oriented towards the eye.
 
bool isOrientToEye () const
 Set and get whether the projector should always be oriented towards the eye.
 
void setFront (bool isFront)
 Set and get whether the projector should intersect the half of the cylinder that faces the eye.
 
bool isFront () const
 Set and get whether the projector should intersect the half of the cylinder that faces the eye.
 
bool isPointInFront (const SbVec3f &point) const
 Set and get whether the projector should intersect the half of the cylinder that faces the eye.
 
virtual void setWorkingSpace (const SbMatrix &space)
 Set the transform space to work in.
 
- Public Member Functions inherited from SbProjector
virtual SbVec3f project (const SbVec2f &point)=0
 Apply the projector using the given point, returning the point in three dimensions that it projects to.
 
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.
 
virtual void setWorkingSpace (const SbMatrix &space)
 Set the transform space to work in.
 
const SbMatrixgetWorkingSpace () const
 Get the transform space to work in.
 
virtual SbProjectorcopy () const =0
 Creates and returns an exact copy of the projector.
 

Protected Member Functions

virtual void setupTolerance ()
 Sets up the tolerance ring.
 
- 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.
 
 SbCylinderProjector (const SbCylinder &cyl, bool orientToEye)
 
- Protected Member Functions inherited from SbProjector
 SbProjector ()
 Default constructor.
 
virtual ~SbProjector ()
 
SbLine getWorkingLine (const SbVec2f &point) const
 Given this mouse point, return the line it projects to in working space.
 

Protected Attributes

float tolerance
 Information about the ring tolerance.
 
float tolDist
 dist from planeLine to cylinder
 
SbVec3f planeDir
 Information about the plane used for intersection testing.
 
SbLine planeLine
 line parallel to axis, but in plane
 
float planeDist
 distance from cylinder center
 
SbPlane tolPlane
 the plane itself
 
- 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?
 
SbCylinder cylinder
 Cylinder for this projector.
 
bool orientToEye
 TRUE if always oriented to eye.
 
bool needSetup
 Set TRUE whenever cylinder, work space or orientation changes.
 
SbVec3f lastPoint
 Cached last point on this projector.
 
- Protected Attributes inherited from SbProjector
SbViewVolume viewVol
 
SbMatrix worldToWorking
 
SbMatrix workingToWorld
 

Detailed Description

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 91 of file SbCylinderSectionProjector.h.

Constructor & Destructor Documentation

◆ SbCylinderSectionProjector() [1/2]

SbCylinderSectionProjector::SbCylinderSectionProjector ( float  edgeTol = .9,
bool  orientToEye = TRUE 
)

The default view volume is undefined. The default working space is identity (world space). The default cylinder is centered about the Y axis and has a radius of 1.0. The default edge tolerance is .9. The default eye orientation is TRUE.

◆ SbCylinderSectionProjector() [2/2]

SbCylinderSectionProjector::SbCylinderSectionProjector ( const SbCylinder cyl,
float  edgeTol = .9,
bool  orientToEye = TRUE 
)

◆ ~SbCylinderSectionProjector()

SbCylinderSectionProjector::~SbCylinderSectionProjector ( )
inline

Definition at line 109 of file SbCylinderSectionProjector.h.

Member Function Documentation

◆ copy()

virtual SbProjector * SbCylinderSectionProjector::copy ( ) const
virtual

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

Implements SbCylinderProjector.

Reimplemented in SbCylinderPlaneProjector.

◆ getTolerance()

float SbCylinderSectionProjector::getTolerance ( ) const
inline

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

Definition at line 131 of file SbCylinderSectionProjector.h.

◆ isWithinTolerance()

bool SbCylinderSectionProjector::isWithinTolerance ( const SbVec3f point)

◆ project()

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

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)
See also
getTolerance

◆ setupTolerance()

virtual void SbCylinderSectionProjector::setupTolerance ( )
protectedvirtual

Member Data Documentation

◆ planeDir

SbVec3f SbCylinderSectionProjector::planeDir
protected

normal direction

Definition at line 146 of file SbCylinderSectionProjector.h.

◆ planeDist

float SbCylinderSectionProjector::planeDist
protected

Definition at line 148 of file SbCylinderSectionProjector.h.

◆ planeLine

SbLine SbCylinderSectionProjector::planeLine
protected

Definition at line 147 of file SbCylinderSectionProjector.h.

◆ tolDist

float SbCylinderSectionProjector::tolDist
protected

Definition at line 143 of file SbCylinderSectionProjector.h.

◆ tolerance

float SbCylinderSectionProjector::tolerance
protected

the edge tolerance

Definition at line 142 of file SbCylinderSectionProjector.h.

◆ tolPlane

SbPlane SbCylinderSectionProjector::tolPlane
protected

Definition at line 149 of file SbCylinderSectionProjector.h.


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