com.openinventor.inventor.projectors

Class SbCylinderSectionProjector

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.projectors.SbProjector

com.openinventor.inventor.projectors.SbCylinderProjector

com.openinventor.inventor.projectors.SbCylinderSectionProjector

Direct Known Subclasses:

SbCylinderPlaneProjector

public class SbCylinderSectionProjector
extends SbCylinderProjector

Cylinder-section projector. SbCylinderSectionProjector projects a window space point (usually based on the mouse location) onto the section of a cylinder that has been sliced by a plane. Two projected points can produce a rotation along the cylinder's axis. The tolerance slice can be specified as a fraction of the radius of the cylinder. The projection point will not extend beyond the sliced portion of the cylinder.

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

See also:

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

Method Summary

Modifier and Type	Method and Description
float	getTolerance() Gets the edge tolerance as a fraction of the radius of the cylinder.
boolean	isWithinTolerance(SbVec3f point) Finds whether this point on the cylinder or tolerance plane is within tolerance.
void	setTolerance(float edgeTol) Sets the edge tolerance as a fraction of the radius of the cylinder.

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

SbCylinderSectionProjector

public SbCylinderSectionProjector()

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

SbCylinderSectionProjector

public SbCylinderSectionProjector(SbCylinder cyl)

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

SbCylinderSectionProjector

public SbCylinderSectionProjector(float edgeTol)

Calls SbCylinderSectionProjector(edgeTol, true).

SbCylinderSectionProjector

public SbCylinderSectionProjector(SbCylinder cyl,
                                  float edgeTol)

Calls SbCylinderSectionProjector(cyl, edgeTol, true).

SbCylinderSectionProjector

public SbCylinderSectionProjector(float edgeTol,
                                  boolean orientToEye)

Constructor that uses a default cylinder aligned with the Y axis with radius 1.0. The position of the plane which slices the cylinder into a section 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.

SbCylinderSectionProjector

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

Constructor. The position of the plane which slices the cylinder into a section 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.

Method Detail

setTolerance

public void setTolerance(float edgeTol)

Sets the edge tolerance as a fraction of the radius of the cylinder. If this is 1.0, the projector is a half cylinder. If this is 0.1, the projector is a slice of the cylinder with radius 0.1*radius. Default is 0.9.

getTolerance

public float getTolerance()

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

isWithinTolerance

public boolean isWithinTolerance(SbVec3f point)

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