Package com.openinventor.inventor.projectors

Class SbCylinderPlaneProjector

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.projectors.SbProjector

com.openinventor.inventor.projectors.SbCylinderProjector

com.openinventor.inventor.projectors.SbCylinderSectionProjector

com.openinventor.inventor.projectors.SbCylinderPlaneProjector

public class SbCylinderPlaneProjector
extends SbCylinderSectionProjector

Cylinder-plane projector. SbCylinderPlaneProjector projects a window space point (usually based on the mouse location) onto a surface defined by a cylinder and plane cutting through the cylinder. Two projected points can produce a rotation along the cylinder's axis. When the mouse position projects onto the plane, the rotations will be as if the plane is being dragged, causing the cylinder to roll beneath it.

Incremental changes (delta rotation) can be computed during interactive sessions. Cylinder projectors are typically used to write interactive 3D manipulators and viewers.

See Also:

SbCylinderSheetProjector, SbLineProjector, SbPlaneProjector, SbSpherePlaneProjector, SbSphereProjector, SbSphereSectionProjector, 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	Description
SbCylinderPlaneProjector()	Calls SbCylinderPlaneProjector((float)0.9f, true).
SbCylinderPlaneProjector(float edgeTol)	Calls SbCylinderPlaneProjector(edgeTol, true).
SbCylinderPlaneProjector(float edgeTol, boolean orientToEye)	Constructor that uses a default cylinder aligned with the Y axis with radius 1.0.
SbCylinderPlaneProjector(SbCylinder cyl)	Calls SbCylinderPlaneProjector(cyl, (float)0.9f, true).
SbCylinderPlaneProjector(SbCylinder cyl, float edgeTol)	Calls SbCylinderPlaneProjector(cyl, edgeTol, true).
SbCylinderPlaneProjector(SbCylinder cyl, float edgeTol, boolean orientToEye)	Constructor.

Method Summary

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

getTolerance, isWithinTolerance, setTolerance

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

getCylinder, getRotation, isFront, isOrientToEye, isPointInFront, projectAndGetRotation, setCylinder, setFront, setOrientToEye

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, getNativeResourceHandle

Methods inherited from class java.lang.Object

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

Constructor Detail

SbCylinderPlaneProjector

public SbCylinderPlaneProjector(SbCylinder cyl)

Calls SbCylinderPlaneProjector(cyl, (float)0.9f, true).

SbCylinderPlaneProjector

public SbCylinderPlaneProjector(SbCylinder cyl,
                                float edgeTol)

Calls SbCylinderPlaneProjector(cyl, edgeTol, true).

SbCylinderPlaneProjector

public SbCylinderPlaneProjector(float edgeTol)

Calls SbCylinderPlaneProjector(edgeTol, true).

SbCylinderPlaneProjector

public SbCylinderPlaneProjector()

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

SbCylinderPlaneProjector

public SbCylinderPlaneProjector(float edgeTol,
                                boolean orientToEye)

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

SbCylinderPlaneProjector

public SbCylinderPlaneProjector(SbCylinder cyl,
                                float edgeTol,
                                boolean orientToEye)

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