Open Inventor Reference
SbSphereSectionProjector Class Reference

Sphere-section projector. More...

#include <Inventor/projectors/SbSphereSectionProjector.h>

Inheritance diagram for SbSphereSectionProjector:
SbSphereProjector SbProjector SbSpherePlaneProjector

Public Member Functions

 SbSphereSectionProjector (float edgeTol=.9, bool orientToEye=TRUE)
 Default constructor.
 
 SbSphereSectionProjector (const SbSphere &sph, float edgeTol=.9, bool orientToEye=TRUE)
 Constructor taking the sphere.
 
 ~SbSphereSectionProjector ()
 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 sphere.
 
void setRadialFactor (float rad=0.0)
 
float getRadialFactor () const
 Set and get the radial rotation factor.
 
bool isWithinTolerance (const SbVec3f &point)
 Find whether this point on the sphere or tolerance plane is within tolerance.
 
- Public Member Functions inherited from SbSphereProjector
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 sphere projector.
 
void setSphere (const SbSphere &sph)
 Set and get the sphere on which to project points.
 
const SbSpheregetSphere () const
 Set and get the sphere 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 inFront)
 Set whether the projector should intersect the half of the sphere that faces the eye.
 
bool isFront () const
 Get whether the projector should intersect the half of the sphere that faces the eye.
 
bool isPointInFront (const SbVec3f &point) const
 Get whether the projector should intersect the half of the sphere that faces the eye.
 
virtual void setWorkingSpace (const SbMatrix &space)
 Set the transform space to work in.
 
 ~SbSphereProjector ()
 Destructor.
 
- 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 slice.
 
- 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).
 
 SbSphereProjector (const SbSphere &s, 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 slice tolerance.
 
float tolDist
 dist from planePoint to tolerance slice
 
float radialFactor
 
SbVec3f planePoint
 Information about the plane used for intersection testing.
 
SbVec3f planeDir
 normal direction
 
float planeDist
 distance from sphere center
 
SbPlane tolPlane
 the plane itself
 
- 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?
 
SbSphere sphere
 The sphere being used.
 
bool orientToEye
 TRUE if always oriented to eye.
 
bool needSetup
 Set TRUE whenever sphere, 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

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

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, SbCylinderSectionProjector, SbCylinderPlaneProjector, SbCylinderSheetProjector, SbLineProjector, SbPlaneProjector, SbSpherePlaneProjector, SbSphereSheetProjector

Definition at line 95 of file SbSphereSectionProjector.h.

Constructor & Destructor Documentation

◆ SbSphereSectionProjector() [1/2]

SbSphereSectionProjector::SbSphereSectionProjector ( float  edgeTol = .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.

◆ SbSphereSectionProjector() [2/2]

SbSphereSectionProjector::SbSphereSectionProjector ( const SbSphere sph,
float  edgeTol = .9,
bool  orientToEye = TRUE 
)

◆ ~SbSphereSectionProjector()

SbSphereSectionProjector::~SbSphereSectionProjector ( )
inline

Definition at line 113 of file SbSphereSectionProjector.h.

Member Function Documentation

◆ copy()

virtual SbProjector * SbSphereSectionProjector::copy ( ) const
virtual

The caller is responsible for deleting the copy when done.

Implements SbProjector.

Reimplemented in SbSpherePlaneProjector.

◆ getRadialFactor()

float SbSphereSectionProjector::getRadialFactor ( ) const
inline

When the mouse is dragged off the edge of the sphere, the mouse motion can be classified as either tangential (moving in a circle around the sphere) or radial (moving toward or away from the center). The tangential motion will always map to a rotation around the center, (like the hands of a clock). The radial motion, by default, has no effect. But if you set the radialFactor to be > 0.0, this motion will make the sphere rotate as if the mouse is pulling the top of the sphere out toward the mouse. If radialFactor = 1.0, then pulling has a ‘normal’ feel (that is, the mouse motion causes the same amount of rotation as if you had rotated by hitting the actual surface of the sphere). Default is 0.0

Definition at line 153 of file SbSphereSectionProjector.h.

◆ getRotation()

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

Implements SbSphereProjector.

Reimplemented in SbSpherePlaneProjector.

◆ getTolerance()

float SbSphereSectionProjector::getTolerance ( ) const
inline

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

Definition at line 135 of file SbSphereSectionProjector.h.

◆ isWithinTolerance()

bool SbSphereSectionProjector::isWithinTolerance ( const SbVec3f point)

◆ project()

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

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

Implements SbSphereProjector.

Reimplemented in SbSpherePlaneProjector.

◆ setRadialFactor()

void SbSphereSectionProjector::setRadialFactor ( float  rad = 0.0)
inline
See also
getRadialFactor

Definition at line 138 of file SbSphereSectionProjector.h.

◆ setTolerance()

void SbSphereSectionProjector::setTolerance ( float  edgeTol)
See also
getTolerance

◆ setupTolerance()

virtual void SbSphereSectionProjector::setupTolerance ( )
protectedvirtual

Member Data Documentation

◆ planeDir

SbVec3f SbSphereSectionProjector::planeDir
protected

Definition at line 172 of file SbSphereSectionProjector.h.

◆ planeDist

float SbSphereSectionProjector::planeDist
protected

Definition at line 173 of file SbSphereSectionProjector.h.

◆ planePoint

SbVec3f SbSphereSectionProjector::planePoint
protected

point on plane

Definition at line 171 of file SbSphereSectionProjector.h.

◆ radialFactor

float SbSphereSectionProjector::radialFactor
protected

Definition at line 168 of file SbSphereSectionProjector.h.

◆ tolDist

float SbSphereSectionProjector::tolDist
protected

Definition at line 166 of file SbSphereSectionProjector.h.

◆ tolerance

float SbSphereSectionProjector::tolerance
protected

the edge tolerance

Definition at line 165 of file SbSphereSectionProjector.h.

◆ tolPlane

SbPlane SbSphereSectionProjector::tolPlane
protected

Definition at line 174 of file SbSphereSectionProjector.h.


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