Open Inventor Release 2024.1.3
 
Loading...
Searching...
No Matches
SbSphereSectionProjector Class Reference

Sphere-section projector. More...

#include <Inventor/projectors/SbSphereSectionProjector.h>

+ Inheritance diagram for SbSphereSectionProjector:

Public Member Functions

 SbSphereSectionProjector (float edgeTol=0.9f, SbBool orientToEye=TRUE)
 Constructor that uses a default sphere centered at the origin with radius 1.0.
 
 SbSphereSectionProjector (const SbSphere &sph, float edgeTol=0.9f, SbBool orientToEye=TRUE)
 Constructor that uses a supplied sphere.
 
 ~SbSphereSectionProjector ()
 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 sphere.
 
float getTolerance () const
 Gets the edge tolerance as a fraction of the radius of the sphere.
 
void setRadialFactor (float rad=0.0)
 Sets the radial rotation factor.
 
float getRadialFactor () const
 Gets the radial rotation factor.
 
SbBool isWithinTolerance (const SbVec3f &point)
 Finds whether this point on the sphere or tolerance plane is within tolerance.
 
- Public Member Functions inherited from SbSphereProjector
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 setSphere (const SbSphere &sph)
 Sets the sphere on which to project points.
 
const SbSpheregetSphere () const
 Gets the sphere 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 inFront)
 Sets whether the projector should intersect the half of the sphere that faces the eye.
 
SbBool isFront () const
 Gets whether the projector should intersect the half of the sphere that faces the eye.
 
SbBool isPointInFront (const SbVec3f &point) const
 Gets whether the projector should intersect the half of the sphere that faces the eye.
 
virtual void setWorkingSpace (const SbMatrix &space)
 Sets the transform space to work in.
 
virtual ~SbSphereProjector ()
 Destructor.
 
- 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

Sphere-section projector.

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 84 of file SbSphereSectionProjector.h.

Constructor & Destructor Documentation

◆ SbSphereSectionProjector() [1/2]

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

Constructor that uses a default sphere centered at the origin with radius 1.0.

The position of the plane which slices the sphere into a section is specified as a fraction of the sphere radius with the parameter edgeTol. A tolerance value of 1.0 positions the plane down the center of the sphere. A tolerance value of 0.5 defines the longitudinal plane halfway between the center and the outside edge of the sphere. The default value is 0.9, so that almost half the sphere is in front of the plane. The orientToEye parameter determines whether the plane is perpendicular to the eye, or perpendicular to the sphere'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.

◆ SbSphereSectionProjector() [2/2]

SbSphereSectionProjector::SbSphereSectionProjector ( const SbSphere sph,
float  edgeTol = 0.9f,
SbBool  orientToEye = TRUE 
)

Constructor that uses a supplied sphere.

The position of the plane which slices the sphere into a section is specified as a fraction of the sphere radius with the parameter edgeTol. A tolerance value of 1.0 positions the plane down the center of the sphere. A tolerance value of 0.5 defines the longitudinal plane halfway between the center and the outside edge of the sphere. The default value is 0.9, so that almost half the sphere is in front of the plane. The orientToEye parameter determines whether the plane is perpendicular to the eye, or perpendicular to the sphere'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.

◆ ~SbSphereSectionProjector()

SbSphereSectionProjector::~SbSphereSectionProjector ( )
inline

Destructor.

Definition at line 126 of file SbSphereSectionProjector.h.

Member Function Documentation

◆ copy()

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

◆ getRadialFactor()

float SbSphereSectionProjector::getRadialFactor ( ) const
inline

Gets the radial rotation factor.

Definition at line 178 of file SbSphereSectionProjector.h.

◆ getRotation()

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

Computes a rotation based on two points on this projector.

Implements SbSphereProjector.

Reimplemented in SbSpherePlaneProjector.

◆ getTolerance()

float SbSphereSectionProjector::getTolerance ( ) const
inline

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

Definition at line 160 of file SbSphereSectionProjector.h.

◆ intersect()

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

Reimplemented in SbSpherePlaneProjector.

◆ isWithinTolerance()

SbBool SbSphereSectionProjector::isWithinTolerance ( const SbVec3f point)

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

◆ project()

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

Reimplemented in SbSpherePlaneProjector.

◆ setRadialFactor()

void SbSphereSectionProjector::setRadialFactor ( float  rad = 0.0)
inline

Sets the radial rotation factor.

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 174 of file SbSphereSectionProjector.h.

◆ setTolerance()

void SbSphereSectionProjector::setTolerance ( float  edgeTol)

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

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


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