|
| virtual bool | setPartAsPath (const SbName &partName, SoPath *surrogatePath) |
| | Sets any public part in the interaction kit as a "surrogate" path instead. More...
|
| |
| virtual bool | affectsState () const |
| | Override the default behavior of SoNode. More...
|
| |
| virtual const SoNodekitCatalog * | getNodekitCatalog () const |
| | Returns the SoNodekitCatalog for this instance of SoBaseKit. More...
|
| |
| | SoBaseKit () |
| | Constructor. More...
|
| |
| virtual SoNode * | getPart (const SbName &partName, bool makeIfNeeded) |
| | Searches the nodekit catalog (and those of all nested nodekits) for the part named partName. More...
|
| |
| 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. More...
|
| |
| virtual SoNodeKitPath * | createPathToPart (const SbName &partName, bool makeIfNeeded, const SoPath *pathToExtend=NULL) |
| | Returns a path that begins at this nodekit and ends at partName. More...
|
| |
| virtual bool | setPart (const SbName &partName, SoNode *from) |
| | Inserts the given node (not a copy) as the new part specified by partName. More...
|
| |
| bool | set (char *nameValuePairListString) |
| | SETTING FIELDS OF PARTS. More...
|
| |
| bool | set (char *partNameString, char *parameterString) |
| |
| virtual void | doAction (SoAction *action) |
| | This method performs the "typical" operation of a node for any action. More...
|
| |
| virtual void | callback (SoCallbackAction *action) |
| | These functions implement all actions for nodekits. More...
|
| |
| virtual void | GLRender (SoGLRenderAction *action) |
| | These virtual functions implement all of the actions for nodes, Most of the default implementations do nothing. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| bool | forceChildDrivenWriteRefs (SoOutput *out) |
| | This returns TRUE if the nodekit intends to write out. More...
|
| |
| void | setOverride (bool state) |
| | Turns override flag on or off. More...
|
| |
| bool | isOverride () const |
| | Returns the state of the override flag. More...
|
| |
| SoNode * | copy (bool copyConnections=FALSE) const |
| | Creates and returns an exact copy of the node. More...
|
| |
| virtual void | pick (SoPickAction *action) |
| |
| virtual void | GLRenderBelowPath (SoGLRenderAction *action) |
| | These methods make render traversal faster by implementing different rendering paths corresponding to different action path codes. More...
|
| |
| 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()). More...
|
| |
| virtual void | grabEventsCleanup () |
| |
| virtual void | startNotify () |
| | Initiates notification from an instance. More...
|
| |
| virtual void | notify (SoNotList *list) |
| | Propagates modification notification through an instance. More...
|
| |
| SbNodeIdType | getNodeId () const |
| | Returns the unique id for a node. More...
|
| |
| virtual void | writeInstance (SoOutput *out) |
| | Writes instance to SoOutput. (Used for either stage of writing.) More...
|
| |
| virtual SoFieldContainer * | copyThroughConnection () const |
| | Copies an instance that is encountered through a field connection. More...
|
| |
| void | setToDefaults () |
| | Sets all fields in this object to their default values. More...
|
| |
| bool | hasDefaultValues () const |
| | Returns TRUE if all of the object's fields have their default values. More...
|
| |
| bool | fieldsAreEqual (const SoFieldContainer *fc) const |
| | Returns TRUE if this object's fields are exactly equal to fc's fields. More...
|
| |
| void | copyFieldValues (const SoFieldContainer *fc, bool copyConnections=FALSE) |
| | Copies the contents of fc's fields into this object's fields. More...
|
| |
| 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. More...
|
| |
| void | get (SbString &fieldDataString) |
| | Returns the values of the fields of this object in the Inventor ASCII file format in the given string. More...
|
| |
| virtual int | getFields (SoFieldList &list) const |
| | Appends pointers to all of this object's fields to resultList, and returns the number of fields appended. More...
|
| |
| virtual SoField * | getField (const SbName &fieldName) const |
| | Returns a pointer to the field with the given name. More...
|
| |
| bool | getFieldName (const SoField *field, SbName &fieldName) const |
| | Returns the name of the given field in the fieldName argument. More...
|
| |
| bool | enableNotify (bool flag) |
| | Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE). More...
|
| |
| bool | isNotifyEnabled () const |
| | Notification is the process of telling interested objects that this object has changed. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| bool | getIsBuiltIn () const |
| | Returns whether or not instance is considered 'built-in' to the library. More...
|
| |
| virtual const SoFieldData * | getFieldData () const |
| | Returns an SoFieldData structure for the node. More...
|
| |
| void | addManagedSensor (SoSensor *sensor) |
| | Adds a sensor which is managed by the field container. More...
|
| |
| void | ref () const |
| | Adds and removes a reference to an instance. More...
|
| |
| void | unref () const |
| |
| void | unrefNoDelete () const |
| |
| void | touch () |
| | Marks an instance as modified, simulating a change to it. More...
|
| |
| virtual SoType | getTypeId () const =0 |
| | Returns the type identifier for a specific instance. More...
|
| |
| bool | isOfType (SoType type) const |
| | Returns TRUE if this object is of the type specified in type or is derived from that type. More...
|
| |
| virtual SbName | getName () const |
| | Returns the name of an instance. More...
|
| |
| virtual void | setName (const SbName &name) |
| | Sets the name of an instance. More...
|
| |
| void | addAuditor (void *auditor, SoNotRec::Type type) |
| | Adds/removes an auditor to/from list. More...
|
| |
| void | removeAuditor (void *auditor, SoNotRec::Type type) |
| |
| const SoAuditorList & | getAuditors () |
| | Returns auditor list– used by SoField and SoEngineOutput to trace forward connections. More...
|
| |
| int | getRefCount () const |
| | Returns current reference count. More...
|
| |
| bool | shouldWrite () |
| | Returns TRUE if the instance should be written, based on the write-reference info already accumulated. More...
|
| |
|
| SoSFEnum | renderCaching |
| | Set render caching mode. Default is AUTO. More...
|
| |
| SoSFEnum | boundingBoxCaching |
| | Set bounding box caching mode. More...
|
| |
| SoSFEnum | renderCulling |
| | Set render culling mode. More...
|
| |
| SoSFEnum | pickCulling |
| | Set pick caching mode. Default is AUTO. More...
|
| |
| SoFieldSensor * | fieldSensor |
| | This sensor will watch the topSeparator part. More...
|
| |
| SoSeparator * | oldTopSep |
| |
| 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). More...
|
| |
| 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. More...
|
| |
| bool | isPathSurrogateInMySubgraph (const SoPath *pathToCheck, SoPath *&pathToOwner, SbName &surrogateNameInOwner, SoPath *&surrogatePathInOwner, bool fillArgs=TRUE) |
| |
| static void | setSwitchValue (SoNode *n, int newVal) |
| |
| static void | initClass () |
| | initialize the class More...
|
| |
| | 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. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| virtual bool | readInstance (SoInput *in, unsigned short flags) |
| | Reads in from file. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| virtual void | setDefaultOnNonWritingFields () |
| | Called by the SoBaseKit::write() method. More...
|
| |
| void | connectSeparatorFields (SoSeparator *dest, bool onOff) |
| |
| static void | readDefaultParts (const char *fileName, const char defaultBuffer[], int defBufSize) |
| | read from buffer More...
|
| |
| static void | fieldSensorCB (void *, SoSensor *) |
| |
|
| static const SoNodekitCatalog * | getClassNodekitCatalog () |
| | Returns the SoNodekitCatalog for the class SoBaseKit. More...
|
| |
| static bool | isSearchingChildren () |
| | Sets and queries if nodekit children are searched during SoSearchAction traversal. More...
|
| |
| static void | setSearchingChildren (bool newVal) |
| | Sets and queries if nodekit children are searched during SoSearchAction traversal. More...
|
| |
| static void | initClass () |
| |
| static SoNode * | typeCheck (const SbName &partName, const SoType &partType, SoNode *node) |
| |
| static SoType | getClassTypeId () |
| | Returns type identifier for the SoNode class. More...
|
| |
| static SoNode * | getByName (const SbName &name) |
| | Returns the last node given the specified name. More...
|
| |
| 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. More...
|
| |
| static void | initClass () |
| | Initializes base node class. More...
|
| |
| static void | initClasses () |
| | Initialize ALL Inventor node classes. More...
|
| |
| static SbNodeIdType | getNextNodeId () |
| | Returns the next available unique id. More...
|
| |
| static int | getActionMethodIndex (SoType t) |
| | Returns the index of this node in the action/method table, given its type. More...
|
| |
| static SoType | getClassTypeId () |
| | Returns the type of this class. More...
|
| |
| static void | initClass () |
| | Setup type information. More...
|
| |
| 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. More...
|
| |
| static void | addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) |
| | Adds an instance to the dictionary. More...
|
| |
| static SoFieldContainer * | checkCopy (const SoFieldContainer *orig) |
| | If a copy of the given instance is in the dictionary, this returns it. More...
|
| |
| static SoFieldContainer * | findCopy (const SoFieldContainer *orig, bool copyConnections) |
| | If a copy of the given instance is not in the dictionary, this returns NULL. More...
|
| |
| static void | copyDone () |
| | Cleans up the dictionary when done. More...
|
| |
| static SoType | getClassTypeId () |
| | Returns type identifier for this class. More...
|
| |
| static void | initClass () |
| | Setup type information. More...
|
| |
| static void | incrementCurrentWriteCounter () |
| | Increments the current write counter at the start of a write operation. More...
|
| |
| static void | decrementCurrentWriteCounter () |
| | Decrements the current write counter after a write operation, in some rare cases. More...
|
| |
| static void | addName (SoBase *, const char *) |
| | Internal methods used to maintain the global name dictionary. More...
|
| |
| static void | removeName (SoBase *, const char *) |
| |
| static SoBase * | getNamedBase (const SbName &, SoType) |
| | Helper routines used to get stuff out of nameDict. More...
|
| |
| static int | getNamedBases (const SbName &, SoBaseList &, SoType) |
| |
| static bool | read (SoInput *in, SoBase *&base, SoType expectedType) |
| | Reads one instance of some subclass of SoBase. More...
|
| |
| static void | setInstancePrefix (const SbString &c) |
| | This defaults to "+" and is used when naming nodes that are DEF's and USE'd. More...
|
| |
| static bool | traceRefs |
| | Turns on/off reference count tracing (for debugging) More...
|
| |
| enum | BaseFlags { IS_ENGINE = 1
, IS_GROUP = 2
} |
| | This set of enums is used when reading and writing the base. More...
|
| |
| | SO_KIT_CATALOG_ENTRY_HEADER (callbackList) |
| | Define fields for the new parts of the kit... More...
|
| |
| virtual SoNode * | addToCopyDict () const |
| | Redefines this to add this node and all part nodes to the dictionary. More...
|
| |
| SoGroup * | getContainerNode (const SbName &listName, bool makeIfNeeded=TRUE) |
| | Returns the containerNode within the SoNodeKitListPart given by listName. More...
|
| |
| void | createNodekitPartsList () |
| | called during construction to create parts list More...
|
| |
| virtual void | createDefaultParts () |
| | called during construction to create any parts that are created by default (such as the cube in the SoCubeKit) More...
|
| |
| const SoNodekitParts * | getNodekitPartsList () const |
| | Return the node's partsList. More...
|
| |
| void | catalogError () |
| | Prints an Error when there's trouble building a catalog. More...
|
| |
| void | countMyFields (SoOutput *out) |
| | This is called during addWriteReference() to write the fields. More...
|
| |
| virtual | ~SoBaseKit () |
| |
| | SoNode () |
| | Constructor, destructor. More...
|
| |
| virtual | ~SoNode () |
| |
| | SoFieldContainer () |
| |
| | ~SoFieldContainer () |
| |
| | SoBase () |
| | Constructor is protected - this is an abstract class. More...
|
| |
| virtual | ~SoBase () |
| | Virtual destructor so that subclasses are deleted properly. More...
|
| |
| virtual void | destroy () |
| | Actually deletes an instance. More...
|
| |
| bool | hasMultipleWriteRefs () const |
| | Returns TRUE if the instance has multiple write references. More...
|
| |
| bool | writeHeader (SoOutput *out, bool isGroup, bool isEngine) const |
| | Writes a header (name, open brace) or footer (close brace) to file defined by SoOutput. More...
|
| |
| 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) More...
|
| |
| static const SoNodekitCatalog ** | getClassNodekitCatalogPtr () |
| | ...end of contents of SO_KIT_HEADER More...
|
| |
| static const SoFieldData ** | getFieldDataPtr () |
| | This is used by the field-inheritence mechanism, hidden in the SoSubNode macros. More...
|
| |
| static uint32_t | getCurrentWriteCounter () |
| | Returns current write counter. More...
|
| |
| SoChildList * | children |
| |
| SoNodekitParts * | nodekitPartsList |
| | parts list. More...
|
| |
| bool | connectionsSetUp |
| |
| SbNodeIdType | uniqueId |
| | Unique id for this node. More...
|
| |
| bool | isBuiltIn |
| | Is the subclass a built-in Inventor subclass or an extender subclass? This is used to determine whether to read/write field type information. More...
|
| |
| static SbNodeIdType | nextUniqueId |
| | Next available unique id. More...
|
| |
| static int | nextActionMethodIndex |
| | Next index into the action method table. More...
|
| |
This is the base class for all classes of interaction nodekits. Currently, the only subclass is SoDragger, which reacts to click-drag-release events from the mouse.
This node has four fields corresponding to those of an SoSeparator: They are renderCaching , boundingBoxCaching , renderCulling , and pickCulling . They behave the same here as they do for an SoSeparator
The setPartAsPath() method provides support for creating "stand-in" objects for parts in the interaction kit. The "stand-in", or "surrogate" part, is a path to an object that lies somewhere else in the scene graph.
- See Also
- SoBaseKit, SoInteraction, SoNodeKitDetail, SoNodeKitPath, SoNodekitCatalog, SoDragger, SoCenterballDragger, SoDirectionalLightDragger, SoDragPointDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger, SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, SoTranslate1Dragger, SoTranslate2Dragger
Definition at line 96 of file SoInteractionKit.h.
| virtual bool SoInteractionKit::setPartAsPath |
( |
const SbName & |
partName, |
|
|
SoPath * |
surrogatePath |
|
) |
| |
|
virtual |
The object at the end of the path serves as a stand-in when a pick occurs, and can thus initiate interaction.
Instead of the usual setPart(), which replaces partName with a new node, this will remove the node being used for partName from the scene and remember the surrogatePath you give it. Later, any pick on surrogatePath will be regarded as a pick on partName.
For example, set the XRotator part of an SoTrackballDragger to be the path to an object in the scene. The rest of the trackball will look the same, but the XRotator stripe will disappear. However, click the mouse on the object at the end of surrogatePath and the ball will start to drag in rotation around its X axis.
Note that this is different from setting the part to be the node at the end of the path. When you set the part as a node, a second instance will be drawn in the local space of the interaction kit. When you set it as a path, the object itself is used, not a copy.
The partName may be any part name that follows the nodekit syntax for parts, such as childList[0].shape or rotator.rotatorActive. (See the getPart() method in the SoBaseKit reference page for a complete description.)
Public Types inherited from SoNode