SbSpherePlaneProjector Class Reference

Sphere-plane projector. More...

#include <Inventor/projectors/SbSpherePlaneProjector.h>

Inheritance diagram for SbSpherePlaneProjector:

Public Member Functions
	SbSpherePlaneProjector (float edgeTol=0.9f, SbBool orientToEye=TRUE)
	Constructor that uses a default sphere centered at the origin with radius 1.0.
	SbSpherePlaneProjector (const SbSphere &sph, float edgeTol=0.9f, SbBool orientToEye=TRUE)
	Constructor that uses a supplied sphere.
	~SbSpherePlaneProjector ()
	Destructor.
virtual SbProjector *	copy () 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 SbVec3f	intersect (const SbLine &line)
	Apply 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.
Public Member Functions inherited from SbSphereSectionProjector
	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.
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 SbSphere &	getSphere () 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 SbViewVolume &	getViewVolume () const
	Get the view volume to use for the projection.
const SbMatrix &	getWorkingSpace () const
	Get the transform space to work in.

Detailed Description

Sphere-plane projector.

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 83 of file SbSpherePlaneProjector.h.

Constructor & Destructor Documentation

SbSpherePlaneProjector() [1/2]

SbSpherePlaneProjector::SbSpherePlaneProjector	(	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 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.

SbSpherePlaneProjector() [2/2]

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

Constructor that uses a supplied sphere.

The position of the plane 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.

~SbSpherePlaneProjector()

SbSpherePlaneProjector::~SbSpherePlaneProjector ( )

inline

Destructor.

Definition at line 122 of file SbSpherePlaneProjector.h.

Member Function Documentation

copy()

virtual SbProjector * SbSpherePlaneProjector::copy ( ) const

virtual

Returns an instance that is a copy of this instance.

The caller is responsible for deleting the copy when done.

Reimplemented from SbSphereSectionProjector.

getRotation()

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

virtual

Computes a rotation based on two points on this projector.

Reimplemented from SbSphereSectionProjector.

intersect()

virtual SbVec3f SbSpherePlaneProjector::intersect ( const SbLine &  line )

virtual

Apply the projector using the given line in world coordinates, returning the point in three dimensions that it projects to.

New for v3.0.

Reimplemented from SbSphereSectionProjector.

project()

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

virtual

Apply 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.

Reimplemented from SbSphereSectionProjector.

---

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

• Inventor/projectors/SbSpherePlaneProjector.h