Provided by: inventor-doc_2.1.6+ds-2_all bug

NAME

       SoRotateCylindricalDragger — object you rotate along a cylindrical surface by dragging with the mouse

INHERITS FROM

       SoBase    >    SoFieldContainer    >    SoNode   >   SoBaseKit   >   SoInteractionKit   >   SoDragger   >
       SoRotateCylindricalDragger

SYNOPSIS

       #include <Inventor/draggers/SoRotateCylindricalDragger.h>

          Fields from class SoRotateCylindricalDragger:

     SoSFRotation        rotation

          Fields from class SoDragger:

     SoSFBool            isActive

          Fields from class SoInteractionKit:

     SoSFEnum            renderCaching
     SoSFEnum            boundingBoxCaching
     SoSFEnum            renderCulling
     SoSFEnum            pickCulling

          Parts from class SoBaseKit:

     (SoNodeKitListPart)  callbackList

          Methods from class SoRotateCylindricalDragger:

                                  SoRotateCylindricalDragger()
     void                         setProjector(SbCylinderProjector *p)
     const SbCylinderProjector *  getProjector() const
     static const SoNodekitCatalog *
                                  getClassNodekitCatalog() const
     static SoType                getClassTypeId()

          Methods from class SoDragger:

     void                addStartCallback(SoDraggerCB *f, void *userData = NULL)
     void                removeStartCallback(SoDraggerCB *f, void *userData = NULL)
     void                addMotionCallback(SoDraggerCB *f, void *userData = NULL)
     void                removeMotionCallback(SoDraggerCB *f, void *userData = NULL)
     void                addFinishCallback(SoDraggerCB *f, void *userData = NULL)
     void                removeFinishCallback(SoDraggerCB *f, void *userData = NULL)
     void                addValueChangedCallback(SoDraggerCB *f, void *userData = NULL)
     void                removeValueChangedCallback(SoDraggerCB *f, void *userData = NULL)
     SbBool              enableValueChangedCallbacks()
     void                setMinGesture(int pixels)
     int                 getMinGesture() const
     static void         setMinScale(float newMinScale)
     static float        getMinScale()

          Methods from class SoInteractionKit:

     virtual SbBool      setPartAsPath(const SbName &partName, SoPath *surrogatePath )

          Methods from class SoBaseKit:

     virtual const SoNodekitCatalog *
                              getNodekitCatalog() const
     virtual SoNode *         getPart(const SbName &partName, SbBool makeIfNeeded)
     SbString                 getPartString(const SoBase *part)
     virtual  SoNodeKitPath  *  createPathToPart(const  SbName  &partName,  SbBool  makeIfNeeded,  const  SoPath
                                   *pathToExtend = NULL)
     virtual SbBool           setPart(const SbName &partName, SoNode *newPart)
     SbBool                   set(char *partName, char *parameters)
     SbBool                   set(char *nameValuePairs)
     static SbBool            isSearchingChildren()
     static void              setSearchingChildren(SbBool newVal)

          Methods from class SoNode:

     void                setOverride(SbBool state)
     SbBool              isOverride() const
     SoNode *            copy(SbBool copyConnections = FALSE) const
     virtual SbBool      affectsState() const
     static SoNode *     getByName(const SbName &name)
     static int          getByName(const SbName &name, SoNodeList &list)

          Methods from class SoFieldContainer:

     void                setToDefaults()
     SbBool              hasDefaultValues() const
     SbBool              fieldsAreEqual(const SoFieldContainer *fc) const
     void                copyFieldValues(const SoFieldContainer *fc, SbBool copyConnections = FALSE)
     void                get(SbString &fieldDataString)
     virtual int         getFields(SoFieldList &resultList) const
     virtual SoField *   getField(const SbName &fieldName) const
     SbBool              getFieldName(const SoField *field, SbName &fieldName) const
     SbBool              isNotifyEnabled() const
     SbBool              enableNotify(SbBool flag)

          Methods from class SoBase:

     void                ref()
     void                unref() const
     void                unrefNoDelete() const
     void                touch()
     virtual SoType      getTypeId() const
     SbBool              isOfType(SoType type) const
     virtual void        setName(const SbName &name)
     virtual SbName      getName() const

          Macros from class SoBaseKit:

     SO_GET_PART(kit, partName, partClass)
     SO_CHECK_PART(kit, partName, partClass)

DESCRIPTION

       SoRotateCylindricalDragger is a simple dragger that rotates about the y axis of its local space. The feel
       of  the  rotation  is  as  if you were spinning a cylinder about its axis of rotation. The local space is
       determined by its location in the scene graph. Transformation nodes placed before it will affect both the
       dragger and the direction of motion.

       This node has a rotation field which always reflects its orientation in  local  space.  If  you  set  the
       field,  the  dragger  will rotate accordingly. You can also connect fields of other nodes or engines from
       this one to make them follow the dragger's orientation.

       This dragger contains four parts, rotator, rotatorActive, feedback, and feedbackActive.

       Each of these is set by default from a resource described in the Dragger Resources section of the  online
       reference page for this class. You can change the parts in any instance of this dragger using setPart().

       You  can  make  your  program  use  different  default  resources  for  the  parts  by  copying  the file
       /usr/share/data/draggerDefaults/rotateCylindricalDragger.iv into your own directory,  editing  the  file,
       and then setting the environment variable SO_DRAGGER_DIR to be a path to that directory.

FIELDS

     SoSFRotation        rotation
          Orientation of the dragger.

METHODS

                                  SoRotateCylindricalDragger()
          Constructor.

     void                         setProjector(SbCylinderProjector *p)
     const SbCylinderProjector *  getProjector() const
          Set and get a different cylinder projector. See the SbCylinderProjector man pages to find out how each
          kind affects the feel of your dragger's motion. The default uses an SbCylinderPlaneProjector.

          Passing  in  NULL will cause this default type of projector to be used. Any projector you pass in will
          be deleted by this dragger when this dragger is deleted. Note that the axis and radius of the cylinder
          are determined by the dragger, based on the y-axis in local space and how far the initial mouse  click
          occured from the center of rotation.

     static const SoNodekitCatalog *
                                  getClassNodekitCatalog() const
          Returns an SoNodekitCatalog for this class

     static SoType                getClassTypeId()
          Returns type identifier for this class.

CATALOG PARTS

       ┌───────────────────────────────────────────────────────────┐
       │                         All parts                         │
       │                                                   NULL by │
       │ Part Name        Part Type         Default Type   Default │
       │                                                           │
       │ callbackList     NodeKitListPart   --               yes   │
       │ rotator          Separator         --               yes   │
       │ rotatorActive    Separator         --               yes   │
       │ feedback         Separator         --               yes   │
       │ feedbackActive   Separator         --               yes   │
       │                                                           │
       └───────────────────────────────────────────────────────────┘
       ┌────────────────────────────────────────────────────────────────┐
       │       Extra information for list parts from above table        │
       │                                                                │
       │ Part Name      Container Type   Permissible Types              │
       │                                                                │
       │ callbackList   Separator        Callback, EventCallback        │
       │                                                                │
       └────────────────────────────────────────────────────────────────┘

DRAGGER RESOURCES

       .in 0n+.5i
     Resource:         rotateCylindricalRotator
       .in 0n+.5i
     Part:             rotator
     Appearance:       white cylinder (with vertical axis) made of lines
     Description:      picking this initiates rotation

                         .in 0n+.5i
     Resource:         rotateCylindricalRotatorActive
                         .in 0n+.5i
     Part:             rotatorActive
     Appearance:       yellow version of rotator
     Description:      displayed while in motion instead of the rotator

                         .in 0n+.5i
     Resource:         rotateCylindricalFeedback
                         .in 0n+.5i
     Part:             feedback
     Appearance:       thin purple line along local y-axis
     Description:      shows center of rotation when not moving

                         .in 0n+.5i
     Resource:         rotateCylindricalFeedbackActive
                         .in 0n+.5i
     Part:             feedbackActive
     Appearance:       thin, slightly brighter purple line along local y-axis
     Description:      shows center of rotation when moving

FILE FORMAT/DEFAULTS

       RotateCylindricalDragger {
          renderCaching       AUTO
          boundingBoxCaching  AUTO
          renderCulling       AUTO
          pickCulling         AUTO
          isActive            FALSE
          rotation            0 0 1  0
          callbackList        NULL
          rotator             <rotateCylindricalRotator resource>
          rotatorActive       <rotateCylindricalRotatorActive resource>
          feedback            <rotateCylindricalFeedback resource>
          feedbackActive      <rotateCylindricalFeedbackActive resource>
     }

SEE ALSO

       SoInteractionKit,    SoDragger,   SoCenterballDragger,   SoDirectionalLightDragger,   SoDragPointDragger,
       SoHandleBoxDragger, SoJackDragger,  SoPointLightDragger,  SoRotateDiscDragger,  SoRotateSphericalDragger,
       SoScale1Dragger,   SoScale2Dragger,  SoScale2UniformDragger,  SoScaleUniformDragger,  SoSpotLightDragger,
       SoTabBoxDragger,  SoTabPlaneDragger,  SoTrackballDragger,  SoTransformBoxDragger,   SoTransformerDragger,
       SoTranslate1Dragger, SoTranslate2Dragger

                                                                               SoRotateCylindricalDragger(3IV)()