Open Inventor Reference
SbSpherePlaneProjector Class Reference

Sphere-plane projector. More...

#include <Inventor/projectors/SbSpherePlaneProjector.h>

Inheritance diagram for SbSpherePlaneProjector:
SbSphereSectionProjector SbSphereProjector SbProjector

Public Member Functions

 SbSpherePlaneProjector (float edgeTol=0.9, bool orientToEye=TRUE)
 Default constructor. More...
 
 SbSpherePlaneProjector (const SbSphere &sph, float edgeTol=0.9, bool orientToEye=TRUE)
 Constructor taking the sphere. More...
 
 ~SbSpherePlaneProjector ()
 Destructor. More...
 
virtual SbProjectorcopy () const
 Returns an instance that is a copy of this instance. More...
 
virtual SbVec3f project (const SbVec2f &point)
 Apply the projector using the given point, returning the point in three dimensions that it projects to. More...
 
virtual SbRotation getRotation (const SbVec3f &point1, const SbVec3f &point2)
 Computes a rotation based on two points on this projector. More...
 
- Public Member Functions inherited from SbSphereSectionProjector
 SbSphereSectionProjector (float edgeTol=.9, bool orientToEye=TRUE)
 Default constructor. More...
 
 SbSphereSectionProjector (const SbSphere &sph, float edgeTol=.9, bool orientToEye=TRUE)
 Constructor taking the sphere. More...
 
 ~SbSphereSectionProjector ()
 Destructor. More...
 
void setTolerance (float edgeTol)
 
float getTolerance () const
 Set and get the edge tolerance as a fraction of the radius of the sphere. More...
 
void setRadialFactor (float rad=0.0)
 
float getRadialFactor () const
 Set and get the radial rotation factor. More...
 
bool isWithinTolerance (const SbVec3f &point)
 Find whether this point on the sphere or tolerance plane is within tolerance. More...
 
- Public Member Functions inherited from SbSphereProjector
SbVec3f projectAndGetRotation (const SbVec2f &point, SbRotation &rot)
 Apply the projector using the given point, returning the point in three dimensions that it projects to. More...
 
void setSphere (const SbSphere &sph)
 Set and get the sphere on which to project points. More...
 
const SbSpheregetSphere () const
 Set and get the sphere on which to project points. More...
 
void setOrientToEye (bool orientToEye)
 Set and get whether the projector should always be oriented towards the eye. More...
 
bool isOrientToEye () const
 Set and get whether the projector should always be oriented towards the eye. More...
 
void setFront (bool inFront)
 Set whether the projector should intersect the half of the sphere that faces the eye. More...
 
bool isFront () const
 Get whether the projector should intersect the half of the sphere that faces the eye. More...
 
bool isPointInFront (const SbVec3f &point) const
 Get whether the projector should intersect the half of the sphere that faces the eye. More...
 
virtual void setWorkingSpace (const SbMatrix &space)
 Set the transform space to work in. More...
 
 ~SbSphereProjector ()
 Destructor. More...
 
- Public Member Functions inherited from SbProjector
virtual void setViewVolume (const SbViewVolume &vol)
 Set the view volume to use for the projection. More...
 
const SbViewVolumegetViewVolume () const
 Get the view volume to use for the projection. More...
 
const SbMatrixgetWorkingSpace () const
 Get the transform space to work in. More...
 

Protected Member Functions

SbRotation getRotation (const SbVec3f &point1, bool tol1, const SbVec3f &point2, bool tol2)
 
- Protected Member Functions inherited from SbSphereSectionProjector
virtual void setupTolerance ()
 Sets up the tolerance slice. More...
 
- Protected Member Functions inherited from SbSphereProjector
 SbSphereProjector (bool orientToEye)
 Constructors The default sphere to use has a radius of 1.0 and is centered at (0,0,0). More...
 
 SbSphereProjector (const SbSphere &s, bool orientToEye)
 
- Protected Member Functions inherited from SbProjector
 SbProjector ()
 Default constructor. More...
 
virtual ~SbProjector ()
 
SbLine getWorkingLine (const SbVec2f &point) const
 Given this mouse point, return the line it projects to in working space. More...
 

Additional Inherited Members

- Protected Attributes inherited from SbSphereSectionProjector
float tolerance
 Information about the slice tolerance. More...
 
float tolDist
 dist from planePoint to tolerance slice More...
 
float radialFactor
 
SbVec3f planePoint
 Information about the plane used for intersection testing. More...
 
SbVec3f planeDir
 normal direction More...
 
float planeDist
 distance from sphere center More...
 
SbPlane tolPlane
 the plane itself More...
 
- Protected Attributes inherited from SbSphereProjector
bool intersectFront
 Are intersections done on the front half (if not, they're done on the back half) of the sphere? More...
 
SbSphere sphere
 The sphere being used. More...
 
bool orientToEye
 TRUE if always oriented to eye. More...
 
bool needSetup
 Set TRUE whenever sphere, work space or orientation changes. More...
 
SbVec3f lastPoint
 cached last point on this projector More...
 
- Protected Attributes inherited from SbProjector
SbViewVolume viewVol
 
SbMatrix worldToWorking
 
SbMatrix workingToWorld
 

Detailed Description

SbSpherePlaneProjector projects a window space point (usually based on the mouse location) onto a surface defined by a sphere and plane cutting through the sphere. Two projected points can produce a rotation about the sphere's center. When the mouse position projects onto the plane, the rotations will be as if the plane is being dragged, causing the sphere to roll beneath it.

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

See Also
SbCylinderProjector, SbCylinderPlaneProjector, SbCylinderSectionProjector, SbCylinderSheetProjector, SbLineProjector, SbPlaneProjector, SbSphereSheetProjector

Definition at line 92 of file SbSpherePlaneProjector.h.

Constructor & Destructor Documentation

◆ SbSpherePlaneProjector() [1/2]

SbSpherePlaneProjector::SbSpherePlaneProjector ( float  edgeTol = 0.9,
bool  orientToEye = TRUE 
)

The default view volume is undefined. The default working space is identity (world space). The default sphere to use has a radius of 1.0 and is centered at (0,0,0). The default edge tolerance is .9. The default eye orientation is TRUE.

◆ SbSpherePlaneProjector() [2/2]

SbSpherePlaneProjector::SbSpherePlaneProjector ( const SbSphere sph,
float  edgeTol = 0.9,
bool  orientToEye = TRUE 
)

◆ ~SbSpherePlaneProjector()

SbSpherePlaneProjector::~SbSpherePlaneProjector ( )
inline

Definition at line 109 of file SbSpherePlaneProjector.h.

Member Function Documentation

◆ copy()

virtual SbProjector* SbSpherePlaneProjector::copy ( ) const
virtual

The caller is responsible for deleting the copy when done.

Reimplemented from SbSphereSectionProjector.

◆ getRotation() [1/2]

SbRotation SbSpherePlaneProjector::getRotation ( const SbVec3f point1,
bool  tol1,
const SbVec3f point2,
bool  tol2 
)
protected

◆ getRotation() [2/2]

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

Reimplemented from SbSphereSectionProjector.

◆ project()

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

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

Reimplemented from SbSphereSectionProjector.


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