SbCylinderPlaneProjector Class Reference
[Projectors]

Cylinder-plane projector. More...

#include <Inventor/projectors/SbCylinderPlaneProjector.h>

Inheritance diagram for SbCylinderPlaneProjector:
SbCylinderSectionProjector SbCylinderProjector SbProjector

List of all members.

Public Member Functions

 SbCylinderPlaneProjector (float edgeTol=0.9f, SbBool orientToEye=TRUE)
 SbCylinderPlaneProjector (const SbCylinder &cyl, float edgeTol=0.9f, SbBool orientToEye=TRUE)
 ~SbCylinderPlaneProjector ()
virtual SbProjectorcopy () const
virtual SbVec3f project (const SbVec2f &point)
virtual SbVec3f intersect (const SbLine &line)
virtual SbRotation getRotation (const SbVec3f &point1, const SbVec3f &point2)

Detailed Description

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


Constructor & Destructor Documentation

SbCylinderPlaneProjector::SbCylinderPlaneProjector ( 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 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::SbCylinderPlaneProjector ( const SbCylinder cyl,
float  edgeTol = 0.9f,
SbBool  orientToEye = TRUE 
)

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.

SbCylinderPlaneProjector::~SbCylinderPlaneProjector (  )  [inline]

Destructor.


Member Function Documentation

virtual SbProjector* SbCylinderPlaneProjector::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 SbCylinderSectionProjector.

virtual SbRotation SbCylinderPlaneProjector::getRotation ( const SbVec3f point1,
const SbVec3f point2 
) [virtual]

Computes a rotation based on two points on this projector.

Reimplemented from SbCylinderSectionProjector.

virtual SbVec3f SbCylinderPlaneProjector::intersect ( const SbLine line  )  [virtual]

Applies 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 SbCylinderSectionProjector.

virtual SbVec3f SbCylinderPlaneProjector::project ( const SbVec2f point  )  [virtual]

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.

Reimplemented from SbCylinderSectionProjector.


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

Open Inventor Toolkit reference manual, generated on 16 Mar 2021
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/