SbCylinderSectionProjector(3IV)

NAME
     SbCylinderSectionProjector (SbCylSectProj) - cylinder-section projector

INHERITS FROM
     SbProjector > SbCylinderProjector > SbCylinderSectionProjector

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

     typedef SbCylinderSectionProjector
                         SbCylSectProj

          Functions from class SbCylinderSectionProjector:

     SbCylinderSectionProjector *
                         SbCylSectProjCreate(float edgeTol = .9, SbBool
                              orientToEye = TRUE)
     SbCylinderSectionProjector *
                         SbCylSectProjCreateCyl(const SbCylinder *cyl, float
                              edgeTol = .9, SbBool orientToEye = TRUE)
     void                SbCylSectProjDelete(SbCylSectProj *this)
     void                SbCylSectProjSetTol(SbCylSectProj *this, float
                              edgeTol)
     float               SbCylSectProjGetTol(const SbCylSectProj *this)
     SbBool              SbCylSectProjIsWithinTol(SbCylSectProj *this, const
                              SbVec3f *point)

          Functions from class SbCylinderProjector:

     SbVec3f             SbCylSectProjProjectGetRot(SbCylSectProj *this, const
                              SbVec2f *point, SbRotation *rot)
     SbRotation          SbCylSectProjGetRot(SbCylSectProj *this, const
                              SbVec3f *point1, const SbVec3f *point2)
     void                SbCylSectProjSetCyl(SbCylSectProj *this, const
                              SbCylinder *cyl)
     const SbCylinder *  SbCylSectProjGetCyl(const SbCylSectProj *this)
     void                SbCylSectProjSetOrientToEye(SbCylSectProj *this,
                              SbBool orientToEye)
     SbBool              SbCylSectProjIsOrientToEye(const SbCylSectProj *this)
     void                SbCylSectProjSetFront(SbCylSectProj *this, SbBool
                              isFront)
     SbBool              SbCylSectProjIsFront(const SbCylSectProj *this)
     SbBool              SbCylSectProjIsPointInFront(const SbCylSectProj
                              *this, const SbVec3f *point)

          Functions from class SbProjector:

     SbVec3f               SbCylSectProjProject(SbCylSectProj *this, const
                                SbVec2f *point)
     void                  SbCylSectProjSetViewVol(SbCylSectProj *this, const
                                SbViewVolume *vol)

     const SbViewVolume *  SbCylSectProjGetViewVol(const SbCylSectProj *this)
     void                  SbCylSectProjSetWorkSpace(SbCylSectProj *this,
                                const SbMatrix *space)
     const SbMatrix *      SbCylSectProjGetWorkSpace(const SbCylSectProj
                                *this)
     SbProjector *         SbCylSectProjCopy(const SbCylSectProj *this)


DESCRIPTION
     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.

FUNCTIONS
     SbCylinderSectionProjector *
                         SbCylSectProjCreate(float edgeTol = .9, SbBool
                              orientToEye = TRUE)
     SbCylinderSectionProjector *
                         SbCylSectProjCreateCyl(const SbCylinder *cyl, float
                              edgeTol = .9, SbBool orientToEye = TRUE)
          Constructors. The first uses a default cylinder aligned with the Y
          axis with radius 1.0; the cylinder is supplied in the second. 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 .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.

     void                SbCylSectProjDelete(SbCylSectProj *this)
          Destructor.

     void                SbCylSectProjSetTol(SbCylSectProj *this, float
                              edgeTol)
     float               SbCylSectProjGetTol(const SbCylSectProj *this)
          Set and get 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 .1, the projector is a slice of the cylinder with radius
          .1*radius.  Default is .9.

     SbBool              SbCylSectProjIsWithinTol(SbCylSectProj *this, const
                              SbVec3f *point)
          Find whether this point on the cylinder or tolerance plane is within
          tolerance.


FILE FORMAT/DEFAULTS
     CylinderSectionProjector {
     }

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