SbCylinderProjector(3IV)

NAME
     SbCylinderProjector (SbCylProj) - cylinder projector

INHERITS FROM
     SbProjector > SbCylinderProjector

SYNOPSIS
     #include <Inventor_c/projectors/SbCylinderProjector.h>

     typedef SbCylinderProjector  SbCylProj

          Functions from class SbCylinderProjector:

     void                SbCylProjDelete(SbCylProj *this)
     SbVec3f             SbCylProjProjectGetRot(SbCylProj *this, const SbVec2f
                              *point, SbRotation *rot)
     SbRotation          SbCylProjGetRot(SbCylProj *this, const SbVec3f
                              *point1, const SbVec3f *point2)
     void                SbCylProjSetCyl(SbCylProj *this, const SbCylinder
                              *cyl)
     const SbCylinder *  SbCylProjGetCyl(const SbCylProj *this)
     void                SbCylProjSetOrientToEye(SbCylProj *this, SbBool
                              orientToEye)
     SbBool              SbCylProjIsOrientToEye(const SbCylProj *this)
     void                SbCylProjSetFront(SbCylProj *this, SbBool isFront)
     SbBool              SbCylProjIsFront(const SbCylProj *this)
     SbBool              SbCylProjIsPointInFront(const SbCylProj *this, const
                              SbVec3f *point)

          Functions from class SbProjector:

     SbVec3f               SbCylProjProject(SbCylProj *this, const SbVec2f
                                *point)
     void                  SbCylProjSetViewVol(SbCylProj *this, const
                                SbViewVolume *vol)
     const SbViewVolume *  SbCylProjGetViewVol(const SbCylProj *this)
     void                  SbCylProjSetWorkSpace(SbCylProj *this, const
                                SbMatrix *space)
     const SbMatrix *      SbCylProjGetWorkSpace(const SbCylProj *this)
     SbProjector *         SbCylProjCopy(const SbCylProj *this)


DESCRIPTION
     SbCylinderProjector is an abstract base class for projectors that use a
     cylinder in their projection. The  SbCylProjGetRot() function for an
     SbCylinderProjector will always return a rotation that is about the axis
     of the cylinder. Cylinder projectors are typically used to write
     interactive 3D manipulators and viewers.

FUNCTIONS
     void                SbCylProjDelete(SbCylProj *this)
          Destructor.
     SbVec3f             SbCylProjProjectGetRot(SbCylProj *this, const SbVec2f
                              *point, SbRotation *rot)
          Apply the projector using the given point, returning the point in
          three dimensions that it projects to. This also returns in rot a
          rotation about the axis of the cylinder from the last projected
          point to this one. The passed point should be normalized (i.e. lie
          in the range [0.0,1.0]), with (0,0) at the lower-left.

     SbRotation          SbCylProjGetRot(SbCylProj *this, const SbVec3f
                              *point1, const SbVec3f *point2)
          Get a rotation given two points on this cylinder projector. The
          rotation will be about the axis of the cylinder.

     void                SbCylProjSetCyl(SbCylProj *this, const SbCylinder
                              *cyl)
     const SbCylinder *  SbCylProjGetCyl(const SbCylProj *this)
          Set and get the cylinder on which to project points. The default
          cylinder is aligned with the Y axis and has radius 1.0.

     void                SbCylProjSetOrientToEye(SbCylProj *this, SbBool
                              orientToEye)
     SbBool              SbCylProjIsOrientToEye(const SbCylProj *this)
          Set and get whether the projector should always be oriented towards
          the eye. Set to FALSE if the tolerance should be evaluated in
          working space.

     void                SbCylProjSetFront(SbCylProj *this, SbBool isFront)
     SbBool              SbCylProjIsFront(const SbCylProj *this)
     SbBool              SbCylProjIsPointInFront(const SbCylProj *this, const
                              SbVec3f *point)
          Set and get whether the projector should intersect the half of the
          cylinder that faces the eye. Set to FALSE if the projector should
          intersect with the rear half.


FILE FORMAT/DEFAULTS
     CylinderProjector {
     }

SEE ALSO
     SbCylinderPlaneProjector, SbCylinderSectionProjector,
     SbCylinderSheetProjector, SbLineProjector, SbPlaneProjector,
     SbSpherePlaneProjector, SbSphereProjector, SbSphereSectionProjector,
     SbSphereSheetProjector