com.openinventor.inventor.projectors

Class SbSphereSectionProjector

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.projectors.SbProjector

com.openinventor.inventor.projectors.SbSphereProjector

com.openinventor.inventor.projectors.SbSphereSectionProjector

Direct Known Subclasses:

SbSpherePlaneProjector

public class SbSphereSectionProjector
extends SbSphereProjector

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

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SbSphereSectionProjector() Calls SbSphereSectionProjector((float)0.9f, true).
SbSphereSectionProjector(float edgeTol) Calls SbSphereSectionProjector(edgeTol, true).
SbSphereSectionProjector(float edgeTol, boolean orientToEye) Constructor that uses a default sphere centered at the origin with radius 1.0.
SbSphereSectionProjector(SbSphere sph) Calls SbSphereSectionProjector(sph, (float)0.9f, true).
SbSphereSectionProjector(SbSphere sph, float edgeTol) Calls SbSphereSectionProjector(sph, edgeTol, true).
SbSphereSectionProjector(SbSphere sph, float edgeTol, boolean orientToEye) Constructor that uses a supplied sphere.

Method Summary

Modifier and Type	Method and Description
float	getRadialFactor() Gets the radial rotation factor.
float	getTolerance() Gets the edge tolerance as a fraction of the radius of the sphere.
boolean	isWithinTolerance(SbVec3f point) Finds whether this point on the sphere or tolerance plane is within tolerance.
void	setRadialFactor() Calls setRadialFactor((float)0.0).
void	setRadialFactor(float rad) Sets the radial rotation factor.
void	setTolerance(float edgeTol) Sets the edge tolerance as a fraction of the radius of the sphere.

Methods inherited from class com.openinventor.inventor.projectors.SbSphereProjector

getRotation, getSphere, isFront, isOrientToEye, isPointInFront, projectAndGetRotation, setFront, setOrientToEye, setSphere

Methods inherited from class com.openinventor.inventor.projectors.SbProjector

copy, getViewVolume, getWorkingSpace, intersect, project, setViewVolume, setWorkingSpace

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SbSphereSectionProjector

public SbSphereSectionProjector(SbSphere sph)

Calls SbSphereSectionProjector(sph, (float)0.9f, true).

SbSphereSectionProjector

public SbSphereSectionProjector(float edgeTol)

Calls SbSphereSectionProjector(edgeTol, true).

SbSphereSectionProjector

public SbSphereSectionProjector()

Calls SbSphereSectionProjector((float)0.9f, true).

SbSphereSectionProjector

public SbSphereSectionProjector(SbSphere sph,
                                float edgeTol)

Calls SbSphereSectionProjector(sph, edgeTol, true).

SbSphereSectionProjector

public SbSphereSectionProjector(float edgeTol,
                                boolean orientToEye)

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

public SbSphereSectionProjector(SbSphere sph,
                                float edgeTol,
                                boolean orientToEye)

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.

Method Detail

setRadialFactor

public void setRadialFactor()

Calls setRadialFactor((float)0.0).

setTolerance

public void 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.

setRadialFactor

public void setRadialFactor(float rad)

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

getTolerance

public float getTolerance()

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

getRadialFactor

public float getRadialFactor()

Gets the radial rotation factor.

isWithinTolerance

public boolean isWithinTolerance(SbVec3f point)

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