SbCylinderSectionProjector Class Reference
[Projectors]
Cylinder-section projector. More...
#include <Inventor/projectors/SbCylinderSectionProjector.h>
Public Member Functions | |
| SbCylinderSectionProjector (float edgeTol=0.9f, SbBool orientToEye=TRUE) | |
| SbCylinderSectionProjector (const SbCylinder &cyl, float edgeTol=0.9f, SbBool orientToEye=TRUE) | |
| ~SbCylinderSectionProjector () | |
| virtual SbProjector * | copy () const |
| virtual SbVec3f | project (const SbVec2f &point) |
| virtual SbVec3f | intersect (const SbLine &line) |
| virtual SbRotation | getRotation (const SbVec3f &point1, const SbVec3f &point2) |
| void | setTolerance (float edgeTol) |
| float | getTolerance () const |
| SbBool | isWithinTolerance (const SbVec3f &point) |
Detailed Description
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
Constructor & Destructor Documentation
| SbCylinderSectionProjector::SbCylinderSectionProjector | ( | float | edgeTol = 0.9f, |
|
| SbBool | orientToEye = TRUE | |||
| ) |
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::SbCylinderSectionProjector | ( | const SbCylinder & | cyl, | |
| float | edgeTol = 0.9f, |
|||
| SbBool | orientToEye = TRUE | |||
| ) |
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.
| SbCylinderSectionProjector::~SbCylinderSectionProjector | ( | ) | [inline] |
Destructor.
Member Function Documentation
| virtual SbProjector* SbCylinderSectionProjector::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 SbCylinderPlaneProjector.
| virtual SbRotation SbCylinderSectionProjector::getRotation | ( | const SbVec3f & | point1, | |
| const SbVec3f & | point2 | |||
| ) | [virtual] |
Computes a rotation based on two points on this projector.
Implements SbCylinderProjector.
Reimplemented in SbCylinderPlaneProjector.
| float SbCylinderSectionProjector::getTolerance | ( | ) | const [inline] |
Gets the edge tolerance as a fraction of the radius of the cylinder.
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 SbCylinderProjector.
Reimplemented in SbCylinderPlaneProjector.
Finds whether this point on the cylinder or tolerance plane is within tolerance.
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 SbCylinderProjector.
Reimplemented in SbCylinderPlaneProjector.
| void SbCylinderSectionProjector::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.
The documentation for this class was generated from the following file:
- Inventor/projectors/SbCylinderSectionProjector.h