SoTranslate1Dragger(3IV)

SoTranslate1Dragger (SoXlate1Drag) - object you can translate along a line by dragging With the mouse

Showing IRIX 6.5.30 (default release). Added in IRIX 6.5.22.

NAME
     SoTranslate1Dragger (SoXlate1Drag) - object you can translate along a
     line by dragging With the mouse

INHERITS FROM
     SoBase > SoFieldContainer > SoNode > SoBaseKit > SoInteractionKit >
     SoDragger > SoTranslate1Dragger

SYNOPSIS
     #include <Inventor_c/draggers/SoTranslate1Dragger.h>

     typedef SoTranslate1Dragger  SoXlate1Drag

          Fields from class SoTranslate1Dragger:

     SoSFVec3f           translation

          Fields from class SoDragger:

     SoSFBool            isActive

          Fields from class SoInteractionKit:

     SoSFEnum            renderCaching
     SoSFEnum            boundingBoxCaching
     SoSFEnum            renderCulling
     SoSFEnum            pickCulling

          Parts from class SoBaseKit:

     (SoNodeKitListPart)  callbackList

          Functions from class SoTranslate1Dragger:

     SoTranslate1Dragger *     SoXlate1DragCreate()
     const SoNodekitCatalog *  SoXlate1DragGetClassNkitCat()
     SoType                    SoXlate1DragGetClassTypeId()

          Functions from class SoDragger:

     void                SoXlate1DragAddStartCB(SoXlate1Drag *this,
                              SoDraggerCB *f, void *userData = NULL)
     void                SoXlate1DragRemoveStartCB(SoXlate1Drag *this,
                              SoDraggerCB *f, void *userData = NULL)
     void                SoXlate1DragAddMotionCB(SoXlate1Drag *this,
                              SoDraggerCB *f, void *userData = NULL)
     void                SoXlate1DragRemoveMotionCB(SoXlate1Drag *this,
                              SoDraggerCB *f, void *userData = NULL)
     void                SoXlate1DragAddFinishCB(SoXlate1Drag *this,
                              SoDraggerCB *f, void *userData = NULL)
     void                SoXlate1DragRemoveFinishCB(SoXlate1Drag *this,
                              SoDraggerCB *f, void *userData = NULL)
     void                SoXlate1DragAddValueChangedCB(SoXlate1Drag *this,
                              SoDraggerCB *f, void *userData = NULL)
     void                SoXlate1DragRemoveValueChangedCB(SoXlate1Drag *this,
                              SoDraggerCB *f, void *userData = NULL)
     SbBool              SoXlate1DragEnableValueChangedCBs(SoXlate1Drag *this)
     void                SoXlate1DragSetMinGesture(SoXlate1Drag *this, int
                              pixels)
     int                 SoXlate1DragGetMinGesture(const SoXlate1Drag *this)
     void                SoXlate1DragSetMinScale(float newMinScale)
     float               SoXlate1DragGetMinScale()

          Functions from class SoInteractionKit:

     SbBool              SoXlate1DragSetPartAsPath(SoXlate1Drag *this, const
                              char *partName, SoPath *surrogatePath )

          Functions from class SoBaseKit:

     const SoNodekitCatalog *  SoXlate1DragGetCat(const SoXlate1Drag *this)
     SoNode *                  SoXlate1DragGetPart(SoXlate1Drag *this, const
                                    char *partName, SbBool makeIfNeeded)
     SbString                  SoXlate1DragGetPartString(SoXlate1Drag *this,
                                    const SoBase *part)
     SoNodeKitPath *           SoXlate1DragCreatePathToPart(SoXlate1Drag
                                    *this, const char *partName, SbBool
                                    makeIfNeeded, const SoPath *pathToExtend =
                                    NULL)
     SbBool                    SoXlate1DragSetPart(SoXlate1Drag *this, const
                                    char *partName, SoNode *newPart)
     SbBool                    SoXlate1DragSet(SoXlate1Drag *this, char
                                    *partName, char *parameters)
     SbBool                    SoXlate1DragSet2(SoXlate1Drag *this, char
                                    *nameValuePairs)
     SbBool                    SoXlate1DragIsSearchingChildren()
     void                      SoXlate1DragSetSearchingChildren(SbBool newVal)

          Functions from class SoNode:

     void                SoXlate1DragSetOverride(SoXlate1Drag *this, SbBool
                              state)
     SbBool              SoXlate1DragIsOverride(const SoXlate1Drag *this)
     SoNode *            SoXlate1DragCopy(const SoXlate1Drag *this, SbBool
                              copyConnections = FALSE)
     SbBool              SoXlate1DragAffectsState(const SoXlate1Drag *this)
     SoNode *            SoXlate1DragGetByName(const char *name)
     int                 SoXlate1DragGetByNameList(const char *name,
                              SoNodeList *list)

          Functions from class SoFieldContainer:

     void                SoXlate1DragSetToDflts(SoXlate1Drag *this)

     SbBool              SoXlate1DragHasDfltVals(const SoXlate1Drag *this)
     SbBool              SoXlate1DragFldsAreEq(const SoXlate1Drag *this, const
                              SoFieldContainer *fc)
     void                SoXlate1DragCopyFieldVals(SoXlate1Drag *this, const
                              SoFieldContainer *fc, SbBool copyConnections =
                              FALSE)
     void                SoXlate1DragGet(SoXlate1Drag *this, SbString
                              *fieldDataString)
     int                 SoXlate1DragGetFields(const SoXlate1Drag *this,
                              SoFieldList *resultList)
     SoField *           SoXlate1DragGetField(const SoXlate1Drag *this, const
                              char *fieldName)
     SbBool              SoXlate1DragGetFieldName(const SoXlate1Drag *this,
                              const SoField *field, SbName *fieldName)
     SbBool              SoXlate1DragIsNotifyEnabled(const SoXlate1Drag *this)
     SbBool              SoXlate1DragEnableNotify(SoXlate1Drag *this, SbBool
                              flag)

          Functions from class SoBase:

     void                SoXlate1DragRef(SoXlate1Drag *this)
     void                SoXlate1DragUnref(const SoXlate1Drag *this)
     void                SoXlate1DragUnrefNoDelete(const SoXlate1Drag *this)
     void                SoXlate1DragTouch(SoXlate1Drag *this)
     SoType              SoXlate1DragGetTypeId(const SoXlate1Drag *this)
     SbBool              SoXlate1DragIsOfType(const SoXlate1Drag *this, SoType
                              type)
     void                SoXlate1DragSetName(SoXlate1Drag *this, const char
                              *name)
     SbName              SoXlate1DragGetName(const SoXlate1Drag *this)


DESCRIPTION
     SoTranslate1Dragger is a simple dragger that translates in one dimension
     when dragged with the mouse. It moves along the x axis of its local
     space, 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 translation field which always reflects its position in
     local space. If you set the field, the dragger will move accordingly.
     You can also connect fields of other nodes or engines from this one to
     make them follow the dragger's motion.

     This dragger contains four parts, translator, translatorActive, 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
     SoDraggerSetPart().

     You can make your program use different default resources for the parts
     by copying the file /usr/share/data/draggerDefaults/translate1Dragger.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
     SoSFVec3f           translation
          Position of the dragger.


FUNCTIONS
     SoTranslate1Dragger *     SoXlate1DragCreate()
          Constructor.

     const SoNodekitCatalog *  SoXlate1DragGetClassNkitCat()
          Returns an SoNodekitCatalog for this class

     SoType                    SoXlate1DragGetClassTypeId()
          Returns type identifier for this class.


CATALOG PARTS
     _____________________________________________________________
                               All parts
                                                          NULL by
      Part Name          Part Type         Default Type   Default

      callbackList       NodeKitListPart   --               yes
      translator         Separator         --               yes
      translatorActive   Separator         --               yes
      feedback           Separator         --               yes
      feedbackActive     Separator         --               yes

     _____________________________________________________________
     |








                                                                  |









     ________________________________________________________________
            Extra information for list parts from above table

      Part Name      Container Type   Permissible Types

                                      Callback, EventCallback
      callbackList   Separator

     ________________________________________________________________
     |




                                                                     |






DRAGGER RESOURCES
     Resource:         translate1Translator
     Part:             translator
     Appearance:       white arrow
     Description:      picking this initiates translation

     Resource:         translate1TranslatorActive
     Part:             translatorActive
     Appearance:       yellow arrow
     Description:      displayed during translation instead of the translator

     Resource:         translate1Feedback
     Part:             feedback
     Appearance:       empty Separator by default
     Description:      feedback displayed when not in motion

     Resource:         translate1FeedbackActive
     Part:             feedbackActive
     Appearance:       empty Separator by default
     Description:      feedback displayed while moving


FILE FORMAT/DEFAULTS
     Translate1Dragger {
          renderCaching       AUTO
          boundingBoxCaching  AUTO
          renderCulling       AUTO
          pickCulling         AUTO
          isActive            FALSE
          translation         0 0 0
          callbackList        NULL
          translator          <translate1Translator resource>
          translatorActive    <translate1TranslatorActive resource>
          feedback            <translate1Feedback resource>
          feedbackActive      <translate1FeedbackActive resource>
     }

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