Open Inventor Reference
SbSphereSectionProjector Class Reference

Sphere-section projector. More...

#include <Inventor/projectors/SbSphereSectionProjector.h>

Inheritance diagram for SbSphereSectionProjector:
SbSphereProjector SbProjector SbSpherePlaneProjector

List of all members.

Public Member Functions

 SbSphereSectionProjector (float edgeTol=.9, SbBool orientToEye=TRUE)
 Default constructor.
 SbSphereSectionProjector (const SbSphere &sph, float edgeTol=.9, SbBool 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.
SbBool isWithinTolerance (const SbVec3f &point)
 Find whether this point on the sphere or tolerance plane is within tolerance.

Protected Member Functions

virtual void setupTolerance ()
 Sets up the tolerance slice.

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

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::SbSphereSectionProjector ( float  edgeTol = .9,
SbBool  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::SbSphereSectionProjector ( const SbSphere sph,
float  edgeTol = .9,
SbBool  orientToEye = TRUE 
)
SbSphereSectionProjector::~SbSphereSectionProjector ( ) [inline]

Definition at line 113 of file SbSphereSectionProjector.h.


Member Function Documentation

virtual SbProjector* SbSphereSectionProjector::copy ( ) const [virtual]

The caller is responsible for deleting the copy when done.

Implements SbProjector.

Reimplemented in SbSpherePlaneProjector.

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.

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

Implements SbSphereProjector.

Reimplemented in SbSpherePlaneProjector.

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.

SbBool SbSphereSectionProjector::isWithinTolerance ( const SbVec3f point)
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.

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

Definition at line 138 of file SbSphereSectionProjector.h.

void SbSphereSectionProjector::setTolerance ( float  edgeTol)
See also:
getTolerance
virtual void SbSphereSectionProjector::setupTolerance ( ) [protected, virtual]

Member Data Documentation

Definition at line 173 of file SbSphereSectionProjector.h.

point on plane

Definition at line 171 of file SbSphereSectionProjector.h.

Definition at line 168 of file SbSphereSectionProjector.h.

Definition at line 166 of file SbSphereSectionProjector.h.

the edge tolerance

Definition at line 165 of file SbSphereSectionProjector.h.


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