Open Inventor Release 2024.1.3
 
Loading...
Searching...
No Matches
SoJackDragger Class Reference

Jack-shaped object you rotate, translate, or scale by dragging with the mouse. More...

#include <Inventor/draggers/SoJackDragger.h>

+ Inheritance diagram for SoJackDragger:

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
virtual const SoNodekitCataloggetNodekitCatalog () const
 Returns the SoNodekitCatalog for this instance.
 
 SoJackDragger ()
 Constructor.
 
- Public Member Functions inherited from SoDragger
void addStartCallback (SoDraggerCB *f, void *userData=NULL)
 Adds start callback.
 
void removeStartCallback (SoDraggerCB *f, void *userData=NULL)
 Removes start callback.
 
void addMotionCallback (SoDraggerCB *f, void *userData=NULL)
 Adds motion callback.
 
void removeMotionCallback (SoDraggerCB *f, void *userData=NULL)
 Removes motion callback.
 
void addFinishCallback (SoDraggerCB *f, void *userData=NULL)
 Adds finish callback.
 
void removeFinishCallback (SoDraggerCB *f, void *userData=NULL)
 Removes finish callback.
 
void addValueChangedCallback (SoDraggerCB *f, void *userData=NULL)
 Adds value-changed callback.
 
void removeValueChangedCallback (SoDraggerCB *f, void *userData=NULL)
 Removes value-changed callback.
 
void setMinGesture (int pixels)
 Sets the number of pixels of movement required to initiate a constraint gesture.
 
void setMinGesture (float pixels)
 Float version of setMinGesture.
 
int getMinGesture () const
 Gets the number of pixels of movement required to initiate a constraint gesture.
 
float getMinGestureFloat () const
 Float version of getMinGesture.
 
SbBool enableValueChangedCallbacks (SbBool newVal)
 You can temporarily disable a dragger's valueChangedCallbacks.
 
void setTrackerDirectMode (TrackerDirectMode mode=DEFAULT)
 Sets the tracker direct mode for this dragger (see description above).
 
TrackerDirectMode getTrackerDirectMode () const
 Get the current tracker direct mode for this dragger.
 
void setMotionMatrix (const SbMatrix &newMatrix)
 Set the motion matrix.
 
const SbMatrixgetMotionMatrix ()
 Get the motion matrix.
 
- Public Member Functions inherited from SoInteractionKit
virtual SbBool setPartAsPath (const SbName &partName, SoPath *surrogatePath)
 Sets any public part in the interaction kit as a "surrogate" path instead.
 
virtual SbBool affectsState () const
 Returns TRUE if a node has an effect on the state during traversal.
 
- Public Member Functions inherited from SoBaseKit
 SoBaseKit ()
 Constructor.
 
virtual SoNodegetPart (const SbName &partName, SbBool makeIfNeeded)
 Searches the nodekit catalog (and those of all nested nodekits) for the part named partName.
 
template<typename PartType >
PartType * getPart (const SbName &partName)
 Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to TRUE.
 
template<typename PartType >
PartType * checkPart (const SbName &partName)
 Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to FALSE.
 
SbString getPartString (const SoBase *part)
 Given a node or a path to a node, checks if the part exists in the nodekit, in a nested nodekit, or an element of a list part.
 
virtual SoNodeKitPathcreatePathToPart (const SbName &partName, SbBool makeIfNeeded, const SoPath *pathToExtend=NULL)
 Returns a path that begins at this nodekit and ends at partName.
 
virtual SbBool setPart (const SbName &partName, SoNode *newPart)
 Inserts the given node (not a copy) as the new part specified by partName.
 
SoNONUNICODE SbBool set (char *nameValuePairListString)
 This function allows field values of parts (nodes) to be set in several different parts simultaneously.
 
SbBool set (const SbString &nameValuePairListString)
 This function allows field values of parts (nodes) to be set in several different parts simultaneously.
 
SoNONUNICODE SbBool set (const char *partNameString, const char *parameterString)
 This function allows field values of parts (nodes) to be set.
 
SbBool set (const SbString &partNameString, const SbString &parameterString)
 This function allows field values of parts (nodes) to be set.
 
- Public Member Functions inherited from SoNode
virtual void setOverride (const SbBool state)
 Turns the override flag on or off.
 
virtual SbBool isOverride () const
 Returns the state of the override flag.
 
virtual SoNodecopy (SbBool copyConnections=FALSE) const
 Creates and returns an exact copy of the node.
 
virtual void touch ()
 Marks an instance as modified, simulating a change to it.
 
- Public Member Functions inherited from SoFieldContainer
void setToDefaults ()
 Sets all fields in this object to their default values.
 
SbBool hasDefaultValues () const
 Returns TRUE if all of the object's fields have their default values.
 
SbBool fieldsAreEqual (const SoFieldContainer *fc) const
 Returns TRUE if this object's fields are exactly equal to fc's fields.
 
void copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
 Copies the contents of fc's fields into this object's fields.
 
SoNONUNICODE SbBool set (const char *fieldDataString)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
 
SbBool set (const SbString &fieldDataString)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
 
void get (SbString &fieldDataString)
 Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
 
virtual int getFields (SoFieldList &list) const
 Appends references to all of this object's fields to resultList, and returns the number of fields appended.
 
virtual int getAllFields (SoFieldList &list) const
 Returns a list of fields, including the eventIn's and eventOut's.
 
virtual SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (const SbName &fieldName) const
 Returns the eventOut with the given name.
 
SbBool getFieldName (const SoField *field, SbName &fieldName) const
 Returns the name of the given field in the fieldName argument.
 
SbBool enableNotify (SbBool flag)
 Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
 
SbBool isNotifyEnabled () const
 Notification is the process of telling interested objects that this object has changed.
 
virtual void setUserData (void *data)
 Sets application data.
 
void * getUserData (void) const
 Gets user application data.
 
- Public Member Functions inherited from SoBase
virtual SbName getName () const
 Returns the name of an instance.
 
virtual void setName (const SbName &name)
 Sets the name of an instance.
 
void setSynchronizable (const bool b)
 Sets this to be a ScaleViz synchronizable object.
 
bool isSynchronizable () const
 Gets the ScaleViz synchronizable state of this object.
 
- Public Member Functions inherited from SoRefCounter
void ref () const
 Adds a reference to an instance.
 
void unref () const
 Removes a reference from an instance.
 
void unrefNoDelete () const
 unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
 
int getRefCount () const
 Returns current reference count.
 
void lock () const
 lock this instance.
 
void unlock () const
 unlock this instance.
 
- Public Member Functions inherited from SoTypedObject
SbBool isOfType (const SoType &type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type.
 
template<typename TypedObjectClass >
SbBool isOfType () const
 Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.
 
- Public Member Functions inherited from SoGetView
 SoGetView ()
 Default constructor.
 
virtual ~SoGetView ()
 
virtual SbBool getViewportIsEnabled () const
 Returns TRUE if SoGetView functionalities are enabled, FALSE otherwise.
 
virtual const SbVec2f getViewportOrigin () const
 Returns SbViewportRegion origin.
 
virtual const SbVec2f getViewportSize () const
 Returns SbViewportRegion size.
 

Static Public Member Functions

static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static const SoNodekitCataloggetClassNodekitCatalog ()
 Returns the SoNodekitCatalog for this class.
 
- Static Public Member Functions inherited from SoDragger
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static const SoNodekitCataloggetClassNodekitCatalog ()
 Returns the SoNodekitCatalog for this class.
 
static void setMinScale (float newMinScale)
 Sets the smallest scale that any dragger will write.
 
static float getMinScale ()
 Gets the smallest scale that any dragger will write.
 
static void setInitialTrackerDirectMode (TrackerDirectMode mode=DEFAULT)
 Set the initial tracker direct mode for draggers not yet created.
 
static TrackerDirectMode getInitialTrackerDirectMode ()
 Get the initial tracker direct mode.
 
- Static Public Member Functions inherited from SoInteractionKit
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static const SoNodekitCataloggetClassNodekitCatalog ()
 Returns the SoNodekitCatalog for this class.
 
- Static Public Member Functions inherited from SoBaseKit
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static const SoNodekitCataloggetClassNodekitCatalog ()
 Returns the SoNodekitCatalog for the class SoBaseKit.
 
static void setSearchingChildren (SbBool newVal)
 Sets if nodekit children are searched during SoSearchAction traversal.
 
static SbBool isSearchingChildren ()
 Returns TRUE if nodekit children are searched during SoSearchAction traversal.
 
- Static Public Member Functions inherited from SoNode
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static SoNodegetByName (const SbName &name)
 A node's name can be set using SoBase::setName().
 
static int getByName (const SbName &name, SoNodeList &list)
 A node's name can be set using SoBase::setName().
 
- Static Public Member Functions inherited from SoFieldContainer
static SoType getClassTypeId ()
 Returns the type of this class.
 
- Static Public Member Functions inherited from SoBase
static SoType getClassTypeId ()
 Returns type identifier for this class.
 
- Static Public Member Functions inherited from SoTypedObject
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 

Public Attributes

SoSFRotation rotation
 Orientation of the dragger.
 
SoSFVec3f translation
 Position of the dragger.
 
SoSFVec3f scaleFactor
 Scale of the dragger.
 
- Public Attributes inherited from SoDragger
SoSFBool isActive
 TRUE when mouse is down and dragging, else FALSE.
 
SoSFBool enableCallbacks
 If set to FALSE, motion, start and finish callbacks are disabled.
 
- Public Attributes inherited from SoInteractionKit
SoSFEnum boundingBoxCaching
 Set bounding box caching mode.
 
SoSFEnum renderCulling
 Set render culling mode.
 
SoSFEnum pickCulling
 Set pick caching mode.
 
SoDEPRECATED SoSFEnum renderCaching
 Set render caching mode.
 
- Public Attributes inherited from SoBaseKit
SoSFBool boundingBoxIgnoring
 Whether to ignore this node during bounding box traversal.
 

Additional Inherited Members

- Public Types inherited from SoDragger
enum  TrackerDirectMode {
  NONE ,
  MOVE ,
  ROTATE ,
  FREE ,
  DEFAULT
}
 Tracker direct mode. More...
 
typedef void SoDraggerCB(void *userData, SoDragger *dragger)
 Used in defining the callback function lists.
 
- Public Types inherited from SoInteractionKit
enum  CacheEnabled {
  OFF ,
  ON ,
  AUTO
}
 Possible values for caching. More...
 

Detailed Description

Jack-shaped object you rotate, translate, or scale by dragging with the mouse.

SoJackDragger is a composite dragger in the shape of a jack from the children's game jacks. Three lines along the x, y, and z axes form the central star shape, which you can drag with the mouse to rotate the jack. Dragging any of the small cubes mounted at the end of the axes will scale the jack uniformly in all 3 dimensions. At the core of the jack is an SoDragPointDragger for translating the jack.

Each of these shapes is a different dragger with the default geometry changed. All of them are parts of the jack dragger, which keeps them moving together. The star is an SoRotateSphericalDragger, and dragging it updates the rotation field of the jack dragger. The small cubes are an SoScaleUniformDragger, tied to the scaleFactor field. The position of the SoDragPointDragger is given by the translation field. As with all draggers, if you change the fields the dragger will move to match the new settings.

Remember: This is not an SoTransform ! . If you want to move other objects with this dragger, you can either:

  • Use an SoJackManip, which is subclassed from SoTransform. It creates one of these draggers and uses it as the interface to change its fields. (see the SoJackManip reference page).
  • Use field-to-field connections to connect the fields of this dragger to those of any SoTransformation node.

You can change the parts in any instance of this dragger using setPart(). The default part geometries are defined as resources for this SoJackDragger class. They are detailed in the Dragger Resources section of the online reference page for this class. You can make your program use different default resources for the parts by copying the file $OIVHOME/data/draggerDefaults/jackDragger.iv into your own directory, editing the file, and then setting the environment variable SO_DRAGGER_DIR to be a path to that directory.

This dragger has both a default and a WYSIWYG version:

Default Dragger WYSIWYG Dragger

See SoDragger for more information about using and customizing draggers, including code examples, using draggers in an immersive VR environment and using WYSIWYG draggers.

FILE FORMAT/DEFAULT

    JackDragger {
    boundingBoxCaching AUTO
    renderCulling AUTO
    pickCulling AUTO
    isActive FALSE
    rotation 0 0 1 0
    translation 0 0 0
    scaleFactor 1 1 1
    callbackList NULL
    surroundScale NULL
    antiSquish AntiSquish {
    sizing BIGGEST_DIMENSION
    }
    scaler ScaleUniformDragger { }
    rotator RotateSphericalDragger { }
    translator DragPointDragger { }
    rotator.rotator <jackRotatorRotator resource>
    rotator.rotatorActive <jackRotatorRotatorActive resource>
    rotator.feedback <jackRotatorFeedback resource>
    rotator.feedbackActive <jackRotatorFeedbackActive resource>
    scaler.scaler <jackScalerScaler resource>
    scaler.scalerActive <jackScalerScalerActive resource>
    scaler.feedback <jackScalerFeedback resource>
    scaler.feedbackActive <jackScalerFeedbackActive resource>
    translator.xTranslator.translator <jackTranslatorLineTranslator resource>
    translator.yTranslator.translator <jackTranslatorLineTranslator resource>
    translator.zTranslator.translator <jackTranslatorLineTranslator resource>
    translator.xTranslator.translatorActive <jackTranslatorLineTranslatorActive resource>
    translator.yTranslator.translatorActive <jackTranslatorLineTranslatorActive resource>
    translator.zTranslator.translatorActive <jackTranslatorLineTranslatorActive resource>
    translator.yzTranslator.translator <jackTranslatorPlaneTranslator resource>
    translator.xzTranslator.translator <jackTranslatorPlaneTranslator resource>
    translator.xyTranslator.translator <jackTranslatorPlaneTranslator resource>
    translator.yzTranslator.translatorActive <jackTranslatorPlaneTranslatorActive resource>
    translator.xzTranslator.translatorActive <jackTranslatorPlaneTranslatorActive resource>
    translator.xyTranslator.translatorActive <jackTranslatorPlaneTranslatorActive resource>
    xFeedback <jackTranslatorXFeedback resource>
    yFeedback <jackTranslatorYFeedback resource>
    zFeedback <jackTranslatorZFeedback resource>
    yzFeedback <jackTranslatorYZFeedback resource>
    xzFeedback <jackTranslatorXZFeedback resource>
    xyFeedback <jackTranslatorXYFeedback resource>
    }

DRAGGER RESOURCES

    Resource: jackRotatorRotator
    Part: rotator.rotator
    Appearance: The 'star' of the jack. Set of 3 white axes (lines)
    Description: Picking star begins rotational dragging of the jackDragger.

    Resource: jackRotatorRotatorActive
    Part: rotator.rotatorActive
    Appearance: Yellow version of the rotator.rotator part.
    Description: Displayed while the jackDragger is being rotated

    Resource: jackRotatorFeedback
    Part: rotator.feedback
    Appearance: Empty separator
    Description: Removes any feedback geometry created in the constructor of the SoRotateSphericalDragger.

    Resource: jackRotatorFeedbackActive
    Part: rotator.feedbackActive
    Appearance: Empty separator
    Description: Removes any feedbackActive geometry created in the constructor of the SoRotateSphericalDragger.

    Resource: jackScalerScaler
    Part: scaler.scaler
    Appearance: Six small white cubes, the tips of the rotator star
    Description: Picking this initiates uniform 3D scaling of the dragger.

    Resource: jackScalerScalerActive
    Part: scaler.scalerActive
    Appearance: Yellow version of the scaler.scaler resource.
    Description: Displayed while the dragger is being scaled.

    Resource: jackScalerFeedback
    Part: scaler.feedback
    Appearance: Empty separator
    Description: Removes any feedback geometry created in the constructor of the SoScaleUniformDragger.

    Resource: jackScalerFeedbackActive
    Part: scaler.feedbackActive
    Appearance: Empty separator
    Description: Removes any feedbackActive geometry created in the constructor of the SoScaleUniformDragger.

    Resource: jackTranslatorLineTranslator
    Parts: translator.xTranslator.translator<BR> translator.yTranslator.translator<BR> translator.zTranslator.translator
    Appearance: Skinny white cylinder aligned with axes of motion
    Description: Picking these parts initiates dragging in the x, y, and z linear draggers respectively.

    Resource: jackTranslatorLineTranslatorActive
    Parts: translator.xTranslator.translatorActive<BR> translator.yTranslator.translatorActive<BR> translator.zTranslator.translatorActive
    Appearance: Skinny yellow cylinder aligned with axes of motion
    Description: Shown during linear dragging in the x, y, and z directions respectively.

    Resource: jackTranslatorPlaneTranslator
    Parts: translator.yzTranslator.translator<BR> translator.xzTranslator.translator<BR> translator.xyTranslator.translator
    Appearance: White flattened cube, drawn in wireframe
    Description: Picking these parts initiates dragging by the yz, xz, and xy planar draggers respectively.

    Resource: jackTranslatorPlaneTranslatorActive
    Parts: translator.yzTranslator.translatorActive<BR> translator.xzTranslator.translatorActive<BR> translator.xyTranslator.translatorActive
    Appearance: Yellow flattened cube, drawn in wireframe
    Description: Shown during planar dragging in the yz, xz, and xy planes respectively.

    Resource: jackTranslatorXFeedback
    Part: xFeedback
    Appearance: Double-headed purple arrow
    Description: Feedback for motion in x direction

    Resource: jackTranslatorYFeedback
    Part: yFeedback
    Appearance: Double-headed purple arrow
    Description: Feedback for motion in y direction

    Resource: jackTranslatorZFeedback
    Part: zFeedback
    Appearance: Double-headed purple arrow
    Description: Feedback for motion in z direction

    Resource: jackTranslatorYZFeedback
    Part: yzFeedback
    Appearance: Semi-transparent green square in yz plane
    Description: Feedback for motion in yz plane

    Resource: jackTranslatorXZFeedback
    Part: xzFeedback
    Appearance: Semi-transparent green square in yz plane
    Description: Feedback for motion in xz plane

    Resource: jackTranslatorXYFeedback
    Part: xyFeedback
    Appearance: Semi-transparent green square in yz plane
    Description: Feedback for motion in xy plane

CATALOG PARTS

    All Parts
    Part Name Part Type Default Type NULL Default
    callbackList NodeKitListPart yes
    surroundScale SurroundScale yes
    antiSquish AntiSquish no
    scaler ScaleUniformDragger yes
    rotator RotateSphericalDragger yes
    translator DragPointDragger yes

    Extra Information for List Parts from Above Table

    Part Name Container Type Possible Types
    callbackList Separator Callback, EventCallback

SEE ALSO

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

Definition at line 311 of file SoJackDragger.h.

Constructor & Destructor Documentation

◆ SoJackDragger()

SoJackDragger::SoJackDragger ( )

Constructor.

Member Function Documentation

◆ getClassNodekitCatalog()

static const SoNodekitCatalog * SoJackDragger::getClassNodekitCatalog ( )
static

Returns the SoNodekitCatalog for this class.

◆ getClassTypeId()

static SoType SoJackDragger::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getNodekitCatalog()

virtual const SoNodekitCatalog * SoJackDragger::getNodekitCatalog ( ) const
virtual

Returns the SoNodekitCatalog for this instance.

Reimplemented from SoDragger.

◆ getTypeId()

virtual SoType SoJackDragger::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from SoDragger.

Member Data Documentation

◆ rotation

SoSFRotation SoJackDragger::rotation

Orientation of the dragger.

Definition at line 335 of file SoJackDragger.h.

◆ scaleFactor

SoSFVec3f SoJackDragger::scaleFactor

Scale of the dragger.

Note: The dragger will always scale uniformly in all 3 dimensions, using the highest value in the scaleFactor field. E.g. (10, 1, 1) is equivalent to (10, 10, 10). This behavior is consistent with scaling the dragger in user interactions because the scaling component of the dragger is an SoScaleUniformDragger.

Definition at line 350 of file SoJackDragger.h.

◆ translation

SoSFVec3f SoJackDragger::translation

Position of the dragger.

Definition at line 340 of file SoJackDragger.h.


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