Base class for nodekits that move in response to click-drag-release mouse events.
More...
|
| void | addStartCallback (SoDraggerCB *f, void *userData=NULL) |
| | Start callbacks are made after the mouse button 1 goes down and the dragger determines that it has been picked.
|
| |
| void | removeStartCallback (SoDraggerCB *f, void *userData=NULL) |
| |
| void | addMotionCallback (SoDraggerCB *f, void *userData=NULL) |
| | Motion callbacks are called after each movement of the mouse during dragging.
|
| |
| void | removeMotionCallback (SoDraggerCB *f, void *userData=NULL) |
| | Motion callbacks are called after each movement of the mouse during dragging.
|
| |
| void | addFinishCallback (SoDraggerCB *f, void *userData=NULL) |
| | Finish callbacks are made after dragging ends and the dragger has stopped grabbing events.
|
| |
| void | removeFinishCallback (SoDraggerCB *f, void *userData=NULL) |
| | Finish callbacks are made after dragging ends and the dragger has stopped grabbing events.
|
| |
| void | addValueChangedCallback (SoDraggerCB *f, void *userData=NULL) |
| | Value-changed callbacks are made after a dragger changes any of its fields.
|
| |
| void | removeValueChangedCallback (SoDraggerCB *f, void *userData=NULL) |
| |
| void | setMinGesture (int pixels) |
| | Set and get the number of pixels of movement required to initiate a constraint gesture.
|
| |
| int | getMinGesture () const |
| | Set and get the number of pixels of movement required to initiate a constraint gesture.
|
| |
| bool | enableValueChangedCallbacks (bool newVal) |
| | You can temporarily disable a dragger's valueChangedCallbacks.
|
| |
| const SbMatrix & | getMotionMatrix () |
| | Get the motion matrix.
|
| |
| void | addOtherEventCallback (SoDraggerCB *f, void *userData=NULL) |
| | In addition to the public callback functions, these callback functions can also be used by subclasses to find out when things have happened.
|
| |
| void | removeOtherEventCallback (SoDraggerCB *f, void *userData=NULL) |
| |
| void | registerChildDragger (SoDragger *child) |
| | Compound draggers should call this for each child dragger so that user callbacks (valueChanged, start, motion, finish, other event) registered with the parent dragger will be invoked based on the child dragger.
|
| |
| void | unregisterChildDragger (SoDragger *child) |
| |
| void | registerChildDraggerMovingIndependently (SoDragger *child) |
| | These two routines tie the child to the parent, but WITHOUT the transferMotion callback.
|
| |
| void | unregisterChildDraggerMovingIndependently (SoDragger *child) |
| |
| SbMatrix | getLocalToWorldMatrix () |
| | Get the matrix which converts from one dragger space to another.
|
| |
| SbMatrix | getWorldToLocalMatrix () |
| |
| SbVec3f | getLocalStartingPoint () |
| | Returns the starting point in local coordinates.
|
| |
| SbVec3f | getWorldStartingPoint () |
| | Returns the starting point in world coordinates.
|
| |
| void | getPartToLocalMatrix (const SbName &partName, SbMatrix &partToLocalMatrix, SbMatrix &localToPartMatrix) |
| | Get the matrix which converts from the space of one part into local space.
|
| |
| void | transformMatrixLocalToWorld (const SbMatrix &fromMatrix, SbMatrix &toMatrix) |
| | Transforms a given matrix from one space into another space.
|
| |
| void | transformMatrixWorldToLocal (const SbMatrix &fromMatrix, SbMatrix &toMatrix) |
| |
| void | transformMatrixToLocalSpace (const SbMatrix &fromMatrix, SbMatrix &toMatrix, const SbName &fromSpacePartName) |
| |
| void | setMotionMatrix (const SbMatrix &newMatrix) |
| | Set the motion matrix.
|
| |
| void | valueChanged () |
| | Invokes the valueChangedCallbacks.
|
| |
| const SbMatrix & | getStartMotionMatrix () |
| | Used to calculate motion relative to the dragger's position at the beginning of the dragging.
|
| |
| virtual void | saveStartParameters () |
| | By default, saves the motionMatrix as the startMotionMatrix.
|
| |
| const SoPath * | getPickPath () const |
| | Information that's good to have during a valueChanged callback.
|
| |
| const SoEvent * | getEvent () const |
| |
| SoPath * | createPathToThis () |
| | Creates a new path leading to this dragger, if the last path given by setTempPathToThis() is still valid.
|
| |
| const SoPath * | getSurrogatePartPickedOwner () const |
| | Surrogate Pick Information.
|
| |
| const SbName & | getSurrogatePartPickedName () const |
| | Name:
Name of the surrogate part within the owners list.
|
| |
| const SoPath * | getSurrogatePartPickedPath () const |
| | SurrogatePath: The owner's surrogate path for this name.
|
| |
| void | setStartingPoint (const SoPickedPoint *newPoint) |
| | Set the point where the drag begins.
|
| |
| void | setStartingPoint (const SbVec3f &newPoint) |
| | The SbVec3f version would usually be a point saved from the end of another gesture.
|
| |
| const SbViewVolume & | getViewVolume () |
| | Information about the window an event occurred in.
|
| |
| void | setViewVolume (const SbViewVolume &vol) |
| |
| const SbViewportRegion & | getViewportRegion () |
| |
| void | setViewportRegion (const SbViewportRegion ®) |
| |
| SoHandleEventAction * | getHandleEventAction () const |
| | Get the most recent handleEventAction.
|
| |
| void | setHandleEventAction (SoHandleEventAction *newAction) |
| |
| void | setTempPathToThis (const SoPath *somethingClose) |
| | A path leading to 'this.
|
| |
| virtual void | grabEventsSetup () |
| | Called when the dragger gains or loses status as "grabber" of events.
|
| |
| virtual void | grabEventsCleanup () |
| |
| void | workFieldsIntoTransform (SbMatrix &mtx) |
| | Changes only that part of the matrix for which this dragger has fields.
|
| |
| void | setFrontOnProjector (ProjectorFrontSetting newVal) |
| |
| ProjectorFrontSetting | getFrontOnProjector () const |
| |
| virtual bool | setPartAsPath (const SbName &partName, SoPath *surrogatePath) |
| | Sets any public part in the interaction kit as a "surrogate" path instead.
|
| |
| virtual bool | affectsState () const |
| | Override the default behavior of SoNode.
|
| |
| virtual bool | setPartAsDefault (const SbName &partName, SoNode *newNode, bool onlyIfAlready=TRUE) |
| | Sets the part, then sets the field for that part to default using partField.setDefault(TRUE).
|
| |
| virtual bool | setPartAsDefault (const SbName &partName, const SbName &newNodeName, bool onlyIfAlready=TRUE) |
| |
| bool | isPathSurrogateInMySubgraph (const SoPath *pathToCheck) |
| | Is the 'inPath' valid as a surrogate path anywhere in this node's subgraph? Examines the surrogate paths of all InteractionKits from this node down.
|
| |
| bool | isPathSurrogateInMySubgraph (const SoPath *pathToCheck, SoPath *&pathToOwner, SbName &surrogateNameInOwner, SoPath *&surrogatePathInOwner, bool fillArgs=TRUE) |
| |
| virtual const SoNodekitCatalog * | getNodekitCatalog () const |
| | Returns the SoNodekitCatalog for this instance of SoBaseKit.
|
| |
| | SoBaseKit () |
| | Constructor.
|
| |
| virtual SoNode * | getPart (const SbName &partName, bool makeIfNeeded) |
| | Searches the nodekit catalog (and those of all nested nodekits) for the part named partName.
|
| |
| 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 SoNodeKitPath * | createPathToPart (const SbName &partName, bool makeIfNeeded, const SoPath *pathToExtend=NULL) |
| | Returns a path that begins at this nodekit and ends at partName.
|
| |
| virtual bool | setPart (const SbName &partName, SoNode *from) |
| | Inserts the given node (not a copy) as the new part specified by partName.
|
| |
| bool | set (char *nameValuePairListString) |
| | SETTING FIELDS OF PARTS.
|
| |
| bool | set (char *partNameString, char *parameterString) |
| |
| virtual void | doAction (SoAction *action) |
| | This method performs the "typical" operation of a node for any action.
|
| |
| virtual void | callback (SoCallbackAction *action) |
| | These functions implement all actions for nodekits.
|
| |
| virtual void | GLRender (SoGLRenderAction *action) |
| | These virtual functions implement all of the actions for nodes, Most of the default implementations do nothing.
|
| |
| virtual void | getBoundingBox (SoGetBoundingBoxAction *action) |
| |
| virtual void | getMatrix (SoGetMatrixAction *action) |
| |
| virtual void | handleEvent (SoHandleEventAction *action) |
| |
| virtual void | rayPick (SoRayPickAction *action) |
| |
| virtual void | search (SoSearchAction *action) |
| |
| virtual void | write (SoWriteAction *action) |
| |
| virtual SoChildList * | getChildren () const |
| | Returns pointer to children.
|
| |
| void | printDiagram () |
| |
| void | printSubDiagram (const SbName &rootName, int level) |
| |
| void | printTable () |
| |
| virtual void | addWriteReference (SoOutput *out, bool isFromField=FALSE) |
| | Overrides the default method to use countMyFields() instead of the regular SoFieldData writing mechanism.
|
| |
| bool | forceChildDrivenWriteRefs (SoOutput *out) |
| | This returns TRUE if the nodekit intends to write out.
|
| |
| void | setOverride (bool state) |
| | Turns override flag on or off.
|
| |
| bool | isOverride () const |
| | Returns the state of the override flag.
|
| |
| SoNode * | copy (bool copyConnections=FALSE) const |
| | Creates and returns an exact copy of the node.
|
| |
| virtual bool | affectsState () const |
| | Returns TRUE if a node has an effect on the state during traversal.
|
| |
| virtual void | doAction (SoAction *action) |
| | This method performs the "typical" operation of a node for any action.
|
| |
| virtual void | GLRender (SoGLRenderAction *action) |
| | These virtual functions implement all of the actions for nodes, Most of the default implementations do nothing.
|
| |
| virtual void | callback (SoCallbackAction *action) |
| |
| virtual void | getBoundingBox (SoGetBoundingBoxAction *action) |
| |
| virtual void | getMatrix (SoGetMatrixAction *action) |
| |
| virtual void | handleEvent (SoHandleEventAction *action) |
| |
| virtual void | pick (SoPickAction *action) |
| |
| virtual void | rayPick (SoRayPickAction *action) |
| |
| virtual void | search (SoSearchAction *action) |
| |
| virtual void | write (SoWriteAction *action) |
| |
| virtual void | GLRenderBelowPath (SoGLRenderAction *action) |
| | These methods make render traversal faster by implementing different rendering paths corresponding to different action path codes.
|
| |
| virtual void | GLRenderInPath (SoGLRenderAction *action) |
| |
| virtual void | GLRenderOffPath (SoGLRenderAction *action) |
| |
| virtual void | grabEventsSetup () |
| | These virtual functions are called when a node gains or loses status as "grabber" of events (see HandleEventAction::setGrabber()).
|
| |
| virtual void | grabEventsCleanup () |
| |
| virtual void | startNotify () |
| | Initiates notification from an instance.
|
| |
| virtual void | notify (SoNotList *list) |
| | Propagates modification notification through an instance.
|
| |
| SbNodeIdType | getNodeId () const |
| | Returns the unique id for a node.
|
| |
| virtual SoChildList * | getChildren () const |
| | Returns pointer to children, or NULL if none.
|
| |
| virtual void | writeInstance (SoOutput *out) |
| | Writes instance to SoOutput. (Used for either stage of writing.)
|
| |
| virtual SoNode * | addToCopyDict () const |
| | Recursively adds this node and all nodes under it to the copy dictionary.
|
| |
| virtual void | copyContents (const SoFieldContainer *fromFC, bool copyConnections) |
| | Copies the contents of the given node into this instance.
|
| |
| virtual SoFieldContainer * | copyThroughConnection () const |
| | Copies an instance that is encountered through a field connection.
|
| |
| void | setToDefaults () |
| | Sets all fields in this object to their default values.
|
| |
| bool | hasDefaultValues () const |
| | Returns TRUE if all of the object's fields have their default values.
|
| |
| bool | fieldsAreEqual (const SoFieldContainer *fc) const |
| | Returns TRUE if this object's fields are exactly equal to fc's fields.
|
| |
| void | copyFieldValues (const SoFieldContainer *fc, bool copyConnections=FALSE) |
| | Copies the contents of fc's fields into this object's fields.
|
| |
| bool | 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 Inventor file format.
|
| |
| void | get (SbString &fieldDataString) |
| | Returns the values of the fields of this object in the Inventor ASCII file format in the given string.
|
| |
| virtual int | getFields (SoFieldList &list) const |
| | Appends pointers to all of this object's fields to resultList, and returns the number of fields appended.
|
| |
| virtual SoField * | getField (const SbName &fieldName) const |
| | Returns a pointer to the field with the given name.
|
| |
| bool | getFieldName (const SoField *field, SbName &fieldName) const |
| | Returns the name of the given field in the fieldName argument.
|
| |
| bool | enableNotify (bool flag) |
| | Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
|
| |
| bool | isNotifyEnabled () const |
| | Notification is the process of telling interested objects that this object has changed.
|
| |
| bool | set (const char *fieldDataString, SoInput *dictIn) |
| | Sets one or more fields in this object to the values specified in the given string, which should be a string in the Inventor file format.
|
| |
| void | get (SbString &fieldDataString, SoOutput *dictOut) |
| | Returns the values of the fields of this object in the Inventor ASCII file format in the given string.
|
| |
| virtual void | notify (SoNotList *) |
| | Propagates modification notification through an instance.
|
| |
| virtual void | addWriteReference (SoOutput *out, bool isFromField=FALSE) |
| | Adds a reference to the instance when writing.
|
| |
| virtual void | writeInstance (SoOutput *out) |
| | Writes instance to SoOutput. (Used only for last stage of writing)
|
| |
| bool | getIsBuiltIn () const |
| | Returns whether or not instance is considered 'built-in' to the library.
|
| |
| virtual const SoFieldData * | getFieldData () const |
| | Returns an SoFieldData structure for the node.
|
| |
| virtual void | copyContents (const SoFieldContainer *fromFC, bool copyConnections) |
| | Copies the contents of the given node into this instance.
|
| |
| virtual SoFieldContainer * | copyThroughConnection () const |
| | During a copy operation, this copies an instance that is encountered through a field connection.
|
| |
| void | addManagedSensor (SoSensor *sensor) |
| | Adds a sensor which is managed by the field container.
|
| |
| void | ref () const |
| | Adds and removes a reference to an instance.
|
| |
| void | unref () const |
| |
| void | unrefNoDelete () const |
| |
| void | touch () |
| | Marks an instance as modified, simulating a change to it.
|
| |
| virtual SoType | getTypeId () const =0 |
| | Returns the type identifier for a specific instance.
|
| |
| bool | isOfType (SoType type) const |
| | Returns TRUE if this object is of the type specified in type or is derived from that type.
|
| |
| virtual SbName | getName () const |
| | Returns the name of an instance.
|
| |
| virtual void | setName (const SbName &name) |
| | Sets the name of an instance.
|
| |
| virtual void | startNotify () |
| | Initiates notification from an instance.
|
| |
| virtual void | notify (SoNotList *list) |
| | Propagates modification notification through an instance.
|
| |
| void | addAuditor (void *auditor, SoNotRec::Type type) |
| | Adds/removes an auditor to/from list.
|
| |
| void | removeAuditor (void *auditor, SoNotRec::Type type) |
| |
| const SoAuditorList & | getAuditors () |
| | Returns auditor list– used by SoField and SoEngineOutput to trace forward connections.
|
| |
| int | getRefCount () const |
| | Returns current reference count.
|
| |
| virtual void | addWriteReference (SoOutput *out, bool isFromField=FALSE) |
| | Adds a reference to the instance when writing.
|
| |
| bool | shouldWrite () |
| | Returns TRUE if the instance should be written, based on the write-reference info already accumulated.
|
| |
|
| static void | setMinScale (float newMinScale) |
| | The smallest scale that any dragger will write.
|
| |
| static float | getMinScale () |
| | Get min scale.
|
| |
| static void | workValuesIntoTransform (SbMatrix &mtx, const SbVec3f *translationPtr, const SbRotation *rotationPtr, const SbVec3f *scaleFactorPtr, const SbRotation *scaleOrientationPtr, const SbVec3f *centerPtr) |
| | Same as above, but values are given explicitly as pointers.
|
| |
| static void | getTransformFast (SbMatrix &mtx, SbVec3f &translation, SbRotation &rotation, SbVec3f &scaleFactor, SbRotation &scaleOrientation, const SbVec3f ¢er) |
| | Faster versions of getTransform() and factor() that take advantage of the case where there is no scaleOrientation.
|
| |
| static void | getTransformFast (SbMatrix &mtx, SbVec3f &translation, SbRotation &rotation, SbVec3f &scaleFactor, SbRotation &scaleOrientation) |
| |
| static SbMatrix | appendTranslation (const SbMatrix &mtx, const SbVec3f &translation, const SbMatrix *conversion=NULL) |
| | Appends the given motion to the end of 'mtx'.
|
| |
| static SbMatrix | appendScale (const SbMatrix &mtx, const SbVec3f &scale, const SbVec3f &scaleCenter, const SbMatrix *conversion=NULL) |
| |
| static SbMatrix | appendRotation (const SbMatrix &mtx, const SbRotation &rot, const SbVec3f &rotCenter, const SbMatrix *conversion=NULL) |
| |
| static void | initClass () |
| |
| static void | initClasses () |
| | Initialize ALL Inventor detail classes.
|
| |
| static void | setSwitchValue (SoNode *n, int newVal) |
| |
| static void | initClass () |
| | initialize the class
|
| |
| static const SoNodekitCatalog * | getClassNodekitCatalog () |
| | Returns the SoNodekitCatalog for the class SoBaseKit.
|
| |
| static bool | isSearchingChildren () |
| | Sets and queries if nodekit children are searched during SoSearchAction traversal.
|
| |
| static void | setSearchingChildren (bool newVal) |
| | Sets and queries if nodekit children are searched during SoSearchAction traversal.
|
| |
| static void | initClass () |
| |
| static SoNode * | typeCheck (const SbName &partName, const SoType &partType, SoNode *node) |
| |
| static SoType | getClassTypeId () |
| | Returns type identifier for the SoNode class.
|
| |
| static SoNode * | getByName (const SbName &name) |
| | Returns the last node given the specified name.
|
| |
| static int | getByName (const SbName &name, SoNodeList &list) |
| | Returns the number of nodes with the given name, and adds to list pointers to those nodes.
|
| |
| static void | initClass () |
| | Initializes base node class.
|
| |
| static void | initClasses () |
| | Initialize ALL Inventor node classes.
|
| |
| static SbNodeIdType | getNextNodeId () |
| | Returns the next available unique id.
|
| |
| static int | getActionMethodIndex (SoType t) |
| | Returns the index of this node in the action/method table, given its type.
|
| |
| static SoType | getClassTypeId () |
| | Returns the type of this class.
|
| |
| static void | initClass () |
| | Setup type information.
|
| |
| static void | initCopyDict () |
| | During a copy operation, copies of nodes and engines are stored in a dictionary, keyed by the original node or engine pointer, so that copies can be re-used.
|
| |
| static void | addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) |
| | Adds an instance to the dictionary.
|
| |
| static SoFieldContainer * | checkCopy (const SoFieldContainer *orig) |
| | If a copy of the given instance is in the dictionary, this returns it.
|
| |
| static SoFieldContainer * | findCopy (const SoFieldContainer *orig, bool copyConnections) |
| | If a copy of the given instance is not in the dictionary, this returns NULL.
|
| |
| static void | copyDone () |
| | Cleans up the dictionary when done.
|
| |
| static SoType | getClassTypeId () |
| | Returns type identifier for this class.
|
| |
| static void | initClass () |
| | Setup type information.
|
| |
| static void | incrementCurrentWriteCounter () |
| | Increments the current write counter at the start of a write operation.
|
| |
| static void | decrementCurrentWriteCounter () |
| | Decrements the current write counter after a write operation, in some rare cases.
|
| |
| static void | addName (SoBase *, const char *) |
| | Internal methods used to maintain the global name dictionary.
|
| |
| static void | removeName (SoBase *, const char *) |
| |
| static SoBase * | getNamedBase (const SbName &, SoType) |
| | Helper routines used to get stuff out of nameDict.
|
| |
| static int | getNamedBases (const SbName &, SoBaseList &, SoType) |
| |
| static bool | read (SoInput *in, SoBase *&base, SoType expectedType) |
| | Reads one instance of some subclass of SoBase.
|
| |
| static void | setInstancePrefix (const SbString &c) |
| | This defaults to "+" and is used when naming nodes that are DEF's and USE'd.
|
| |
|
| | SoDragger () |
| | Constructor.
|
| |
| SbVec2f | getNormalizedLocaterPosition () |
| | Get the last known position of the locator (mouse).
|
| |
| SbVec2s | getLocaterPosition () |
| |
| SbVec2s | getStartLocaterPosition () const |
| | Get the position of the locater when dragging started.
|
| |
| void | setStartLocaterPosition (SbVec2s p) |
| | The start locater position is automatically set when button 1 goes down over the dragger.
|
| |
| bool | isAdequateConstraintMotion () |
| | Has the locater moved far enough from where it started to choose a constraint gesture.
|
| |
| virtual bool | shouldGrabBasedOnSurrogate (const SoPath *pickPath, const SoPath *surrogatePath) |
| | Given a pickPath and a surrogatePath, decides whether it should grab based on the surrogate.
|
| |
| void | setCameraInfo (SoAction *action) |
| | The dragger looks in this action to get information about the camera and the viewport.
|
| |
| virtual void | handleEvent (SoHandleEventAction *ha) |
| | This is called during traversal by a HandleEventAction.
|
| |
| virtual bool | mouseButtonPressed (const SoEvent *ev) |
| | This is called during handleEvent.
|
| |
| virtual bool | mouseButtonReleased (const SoEvent *ev) |
| | This is called during handleEvent.
|
| |
| void | transferMotion (SoDragger *child) |
| | This should be called by every child dragger of a compound dragger as a result of compoundDragger->registerChildDragger( childDragger ); Called on the compoundDragger when childDragger's value changes.
|
| |
| void | setIgnoreInBbox (bool newVal) |
| | Set/get whether the dragger should be ignored during bounding box calculations.
|
| |
| bool | isIgnoreInBbox () |
| |
| virtual void | getBoundingBox (SoGetBoundingBoxAction *action) |
| | Implements getBoundingBox action.
|
| |
| void | setActiveChildDragger (SoDragger *newChildDragger) |
| | Called by the above child callbacks.
|
| |
| SoDragger * | getActiveChildDragger () const |
| |
| virtual void | setDefaultOnNonWritingFields () |
| | Called by the SoBaseKit::write() method.
|
| |
| virtual | ~SoDragger () |
| |
| | SoInteractionKit () |
| |
| | ~SoInteractionKit () |
| |
| virtual void | copyContents (const SoFieldContainer *fromFC, bool copyConnections) |
| | Copies the contents of the given instance into this instance This copies the surrogatePartPathList and the surrogatePartNameList.
|
| |
| virtual SoNode * | getAnyPart (const SbName &partName, bool makeIfNeeded, bool leafCheck=FALSE, bool publicCheck=FALSE) |
| | These are overloaded to set the surrogate path to NULL after completing their work.
|
| |
| virtual SoNodeKitPath * | createPathToAnyPart (const SbName &partName, bool makeIfNeeded, bool leafCheck=FALSE, bool publicCheck=FALSE, const SoPath *pathToExtend=NULL) |
| |
| virtual bool | setAnyPart (const SbName &partName, SoNode *from, bool anyPart=TRUE) |
| |
| virtual bool | setAnyPartAsPath (const SbName &partName, SoPath *surrogatePath, bool leafCheck=FALSE, bool publicCheck=FALSE) |
| | This allows you to set any part in the nodekit as a surrogate path.
|
| |
| virtual bool | readInstance (SoInput *in, unsigned short flags) |
| | Reads in from file.
|
| |
| virtual bool | setAnyPartAsDefault (const SbName &partName, SoNode *newNode, bool anyPart=TRUE, bool onlyIfAlready=TRUE) |
| | Protected versions of these methods that allow you to set non-leaf and/or private parts.
|
| |
| virtual bool | setAnyPartAsDefault (const SbName &partName, const SbName &newNodeName, bool anyPart=TRUE, bool onlyIfAlready=TRUE) |
| |
| bool | setAnySurrogatePath (const SbName &inName, SoPath *inPath, bool leafCheck=FALSE, bool publicCheck=FALSE) |
| |
| virtual bool | setUpConnections (bool onOff, bool doItAlways=FALSE) |
| | detach/attach any sensors, callbacks, and/or field connections.
|
| |
| void | connectSeparatorFields (SoSeparator *dest, bool onOff) |
| |
| | SO_KIT_CATALOG_ENTRY_HEADER (callbackList) |
| | Define fields for the new parts of the kit...
|
| |
| virtual SoNode * | addToCopyDict () const |
| | Redefines this to add this node and all part nodes to the dictionary.
|
| |
| virtual void | copyContents (const SoFieldContainer *fromFC, bool copyConnections) |
| | Copies the contents of the given nodekit into this instance.
|
| |
| SoGroup * | getContainerNode (const SbName &listName, bool makeIfNeeded=TRUE) |
| | Returns the containerNode within the SoNodeKitListPart given by listName.
|
| |
| virtual SoNode * | getAnyPart (const SbName &partName, bool makeIfNeeded, bool leafCheck=FALSE, bool publicCheck=FALSE) |
| | like their public versions, but are allowed access to non-leaf and private parts.
|
| |
| virtual SoNodeKitPath * | createPathToAnyPart (const SbName &partName, bool makeIfNeeded, bool leafCheck=FALSE, bool publicCheck=FALSE, const SoPath *pathToExtend=NULL) |
| |
| virtual bool | setAnyPart (const SbName &partName, SoNode *from, bool anyPart=TRUE) |
| |
| void | createNodekitPartsList () |
| | called during construction to create parts list
|
| |
| virtual void | createDefaultParts () |
| | called during construction to create any parts that are created by default (such as the cube in the SoCubeKit)
|
| |
| const SoNodekitParts * | getNodekitPartsList () const |
| | Return the node's partsList.
|
| |
| void | catalogError () |
| | Prints an Error when there's trouble building a catalog.
|
| |
| virtual bool | setUpConnections (bool onOff, bool doItAlways=FALSE) |
| | detach/attach any sensors, callbacks, and/or field connections.
|
| |
| virtual bool | readInstance (SoInput *in, unsigned short flags) |
| | Reads in from file. Takes care of setting parts and stuff.
|
| |
| virtual void | setDefaultOnNonWritingFields () |
| | This is called during countMyFields() method.
|
| |
| void | countMyFields (SoOutput *out) |
| | This is called during addWriteReference() to write the fields.
|
| |
| virtual | ~SoBaseKit () |
| |
| | SoNode () |
| | Constructor, destructor.
|
| |
| virtual | ~SoNode () |
| |
| | SoFieldContainer () |
| |
| | ~SoFieldContainer () |
| |
| virtual bool | readInstance (SoInput *in, unsigned short flags) |
| | Reads stuff into instance. Returns FALSE on error.
|
| |
| | SoBase () |
| | Constructor is protected - this is an abstract class.
|
| |
| virtual | ~SoBase () |
| | Virtual destructor so that subclasses are deleted properly.
|
| |
| virtual void | destroy () |
| | Actually deletes an instance.
|
| |
| bool | hasMultipleWriteRefs () const |
| | Returns TRUE if the instance has multiple write references.
|
| |
| bool | writeHeader (SoOutput *out, bool isGroup, bool isEngine) const |
| | Writes a header (name, open brace) or footer (close brace) to file defined by SoOutput.
|
| |
| void | writeFooter (SoOutput *out) const |
| |
| virtual const char * | getFileFormatName () const |
| | Unknown nodes and engines write a different name for themselves than their typeId; this virtual method lets them do that (by default the typeId name is returned)
|
| |
| virtual bool | readInstance (SoInput *in, unsigned short flags)=0 |
| | Reads stuff into instance of subclass.
|
| |
SoDragger is the base class for all nodekits you move by using the mouse to click-drag-and-release. More specifically, they are operated by a start (mouse button 1 pressed over dragger to pick it), followed by dragging (mouse motion events are interpreted by the dragger and result in some form of motion and/or change to a field), followed by finish (mouse up).
Each dragger has a different paradigm for interpreting mouse motion and changing its fields as a result. Draggers map 2D mouse motion into motion of a point on 3D lines, planes, spheres or cylinders. (See the SbProjector reference pages.) Then they react to this motion of a point through 3-space by scaling, translating, or rotating. For example, SoTranslate2Dragger maps mouse motion onto a 3D plane, then translates to follow the cursor as it moves within that plane.
Every dragger has fields that describe its current state. Scaling draggers have a scaleFactor field, rotational draggers have a rotation field, etc. All draggers have the isActive field, defined in this class. It is TRUE while the dragger is being dragged, FALSE otherwise.
Draggers that have only one part to pick and one motion field are called simple draggers. Examples are the SoRotateDiscDragger, SoScale1Dragger, and SoTranslate2Dragger.
Draggers that create assemblies out of other draggers and then orchestrate the motion of the whole assembly are call composite draggers. SoTransformBoxDragger is a composite dragger made entirely of simple draggers. SoDirectionalLightDragger contains both a simple dragger (SoRotateSphericalDragger) and a composite dragger (SoDragPointDragger) When using a composite dragger, the fields of the composite dragger are the ones you should work with. Draggers lower down in the assemblage usually have zeroed out values. For example, when you drag the face of a transformBox, an SoTranslate2Dragger, the transformBox "steals" the translation from the child dragger and transfers it up to the top of the composite dragger, where it effects all pieces of the assemblage.
Draggers always keep their fields up to date, including while they are being dragged. So you can use field-to-field connections and engines to connect dragger values to other parts of your scene graph.
Hence draggers can be easily utilized as input devices for mouse-driven 3D interface elements. You can also register value-changed callbacks, which are called whenever any of the fields is changed.
Also, if you set the field of a dragger through some method other than dragging, (by calling setValue(), for example), the dragger's internal SoFieldSensor will sense this and the dragger will move to satisfy that new value.
This makes it easy to constrain draggers to keep their fields within certain limits: if the limit is exceeded, just set it back to the exceeded maximum or minimum. You can do this even as the dragger is in use, by constraining the field value within a value-changed callback that you add with addValueChangedCallback(). In this case, be sure to temporarily disable the other value-changed callbacks using enableValueChangedCallbacks(). Doing this will prevent infinite-looping; changing the value followed by calling the callbacks which change the value ad infinitum.
When you drag a dragger, the dragger only moves itself. Draggers do not change the state or affect objects that follow in the scene graph. For example a dragger does not ever behave like an SoTransform and change the current transformation matrix. Draggers are not transforms, even if they have field names like translation, rotation, scaleFactor. Many draggers, such as SoTrackballDragger, have a corresponding SoTransformManip, in this case SoTrackballManip. The manipulator is a subclass of SoTransform, and affects other objects in the scene; it uses a trackball dragger to provide its user interface.
In this way, draggers are employed extensively by manipulators. Callback functions on the dragger allow its employer to be notified of start, motion, finish, and value changes. In all cases, the callback function is passed a pointer to the dragger which initiated the callback. (See the various man pages for more details on specific draggers and manipulators).
All draggers are nodekits. However, draggers do not list their parts in the Parts section of the reference page. Instead, there is a section called Dragger Resources, more suited to describe the parts made available to the programmer. Because of space limitations, the Dragger Resources section only appears in the online versions of the reference pages. Each dragger has some parts you can pick on, and other parts that replace them when they are active or moving. These active parts are often just the same geometry in another color.
Draggers also have pieces for displaying feedback. Each of these pieces has a default scene graph, as well as a special function within the dragger. Each part also has a resource name. All this information is contained in the DRAGGER RESOURCES section.
Since draggers are nodekits, you can set the parts in any instance of a dragger using setPart().
But draggers also give each part a resource name. When a dragger builds a part, it looks in the global dictionary for the node with that resourceName . By putting a new entry in the dictionary, you can override that default. The default part geometries are defined as resources for each class, and each class has a file you can change to alter the defaults. The files are listed in each dragger's man page. You can make your program use different default resources for the parts by copying the listed file from the directory /usr/share/data/draggerDefaults into your own directory, editing the file, and then setting the environment variable SO_DRAGGER_DIR to be a path to that directory.
- See Also
- SoInteractionKit, SoCenterballDragger, SoDirectionalLightDragger, SoDragPointDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger, SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger, SoTranslate2Dragger
Definition at line 225 of file SoDragger.h.
Public Types inherited from SoInteractionKit