|
| 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 bool | affectsState () const |
| | Returns TRUE if a node has an effect on the state during traversal. 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...
|
| |
|
| 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...
|
| |
|
| | 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...
|
| |
| virtual void | copyContents (const SoFieldContainer *fromFC, bool copyConnections) |
| | Copies the contents of the given nodekit into this instance. More...
|
| |
| SoGroup * | getContainerNode (const SbName &listName, bool makeIfNeeded=TRUE) |
| | Returns the containerNode within the SoNodeKitListPart given by listName. More...
|
| |
| 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. 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) |
| |
| 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...
|
| |
| virtual bool | setUpConnections (bool onOff, bool doItAlways=FALSE) |
| | detach/attach any sensors, callbacks, and/or field connections. More...
|
| |
| virtual bool | readInstance (SoInput *in, unsigned short flags) |
| | Reads in from file. Takes care of setting parts and stuff. More...
|
| |
| virtual void | setDefaultOnNonWritingFields () |
| | This is called during countMyFields() method. 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...
|
| |
This is the base class from which all nodekit nodes are derived. Nodekits provide a convenient mechanism for creating groups of scene graph nodes with some larger meaning. When you create a shape node such as an indexed face set, for example, you almost always precede it with a coordinate node. You may also want to add a transform node or specify properties with material, drawing style, material binding, etc. Instead of creating each of these nodes individually and then arranging them into a subgraph, you can use a nodekit of the appropriate type (in this case, SoShapeKit).
Each class of nodekit has a nodekit catalog (SoNodekitCatalog) that describes the nodes in the subgraph, referred to as parts. The catalog has an entry for each part, with information such as the partName, partType, and nullByDefault (if FALSE the constructor creates it). The catalog also describes the arrangement of parts in the subgraph. (Other information is described below; a complete description is in the SoNodekitCatalog reference page.)
If we regard the scene graph arrangement as a branching tree, then the top node (root) of the arrangement is always the nodekit itself. The leaf nodes are those at the bottom (containing no children). Some leaves of the tree are defined in the catalog to be public parts, while other leaves are private. All non-leaf parts are considered internal to the nodekit structure and are marked private. Public parts are accessible; they may be requested, changed, or set by the programmer with member functions such as getPart(). Private parts are not accessible, so methods such as getPart() will have no effect on them. For example, if you call getPart() to retrieve a private part, NULL will be returned even when the part exists.
Every nodekit reference page has a Parts section describing the function of each public part it adds to those inherited from its parent class. Also, a Catalog Parts section has tables of often-needed information from the catalog (part type, etc.). These tables include all public parts, both new and inherited. Only the public parts of a nodekit are described in the reference pages. Nodekits take care of the rest for you; they automatically arrange the subgraph, creating and deleting the private parts when necessary. (The SoNodekitCatalog reference page has methods for finding out the part names and arrangement of all parts, both public and private.)
The nodekit catalog is a template shared by all instances of a class. They use the shared catalog as a guide when creating parts (i.e., constructing actual nodes), but each instance stores its own parts separately. Moreover, nodekits are not SoGroup nodes, and parts are added as hidden children; you can only access parts with the methods of SoBaseKit and its derived classes.
Any public part may be retrieved with getPart(), installed with setPart(), or removed by giving a NULL argument to setPart(). Paths from the nodekit down to a part can be created by createPathToPart().
By default, parts are not created until the user requests or sets them. This keeps the subgraph uncluttered and efficient for traversal. Additionally, removing a part (setting it to NULL) has the extra effect of removing any internal parts that are no longer needed.
Since nodekits hide their children, any SoPath containing nodekits will end at the topmost nodekit. However, since nodekits may be nested within other nodekits, you may wish to cast an (SoPath *) into an (SoNodeKitPath *). The methods of SoNodeKitPath allow you to view all nodekits that lie on the path (see the reference page for SoNodeKitPath).
Public parts in the nodekit catalog fall into three categories:
[1] regular nodes
[2] nodekits, or nested nodekits (which may nest recursively). Any node which is public in a nested nodekit is accessible to the higher level nodekit(s) that contains it. The description of getPart() below shows how to refer to nested parts by name (e.g., "appearance.material"). This works for any nodekit method that takes a part name for an argument.
[3] lists, or list parts. These parts group together children (list elements) of a particular type or types. As with nested nodekits, you can refer to individual elements using notation described in getPart() (e.g., "childList[0]", or if the list elements are in turn nodekits, "childList[2].transform").
When the catalog denotes that a part is a list, the part itself is always a node of type SoNodeKitListPart. The catalog specifies a set of permissible listItemTypes and a listContainerType for that part. It gives this information to the SoNodeKitListPart when it creates it. From then on, the list part will enforce type checking. So even if you retrieve the SoNodeKitListPart with getPart(), you will not be able to add illegal children. (See the SoNodeKitListPart reference page for more information). As an example, the callbackList part of SoBaseKit has an SoSeparator container and allows only SoCallback and SoEventCallback nodes in the list. Children may be added, retrieved, and removed from an SoNodeKitListPart node using methods that parallel those of SoGroup. However, type-checking is strictly enforced.
Note that, although all public parts are leaves in the nodekit catalog, you are free to add children to them (assuming that they are groups, nodekits, or list parts). A part's status as a leaf in the catalog just means that the nodekit will not manage the part's children. For example, SoWrapperKit has a part called contents with a part type of SoSeparator. You can put whatever you want underneath the separator, as long as contents itself is an SoSeparator.
Thus, a nodekit only controls a section of the scene graph. Above and below that section, anything goes.
However, when nodekits are nested, they effectively create a larger ‘known’ section of the scene graph. For example, the appearance part of the SoSeparatorKit is a leaf node in the SoSeparatorKit catalog. But appearance is in turn an SoAppearanceKit, containing parts such as material and drawStyle. The two nodekits combine to make an even larger template, which the SoSeparatorKit can examine by looking at the catalogs for both classes. So an SoSeparatorKit can successfully return a part named "material"; first it finds (or creates) the appearance part, then it gets the material by calling getPart() on the appearance.
When the catalog defines the listItemTypes of a list part to be nodekits, the name-able space expands further. For example, SoSeparatorKit has a part childList which permits only SoSeparatorKits, so each list element can be further searched. Hence the name "childList[0].childList[1].childList[2].material" is perfectly legal.
- Action Behavior
- SoGLRenderAction, SoCallbackAction, SoGetBoundingBoxAction, SoHandleEventAction
Behaves like an SoGroup. Traverses each child in order.
- SoRayPickAction
Traverses each child in order. Then, for any pick containing the kit on its path, makes an SoNodeKitDetail as follows: Sets the "detailNodeKit" (retrievable with SoNodeKitDetail::getNodeKit()) to be a pointer to itself. Sets the "detailPart" (retrievable with SoNodeKitDetail::getPart()) to be a pointer to the kit's leaf-most part that lies on the pickPath. Sets the "detailPartName" (retrievable with SoNodeKitDetail::getPartName()) to be the partName of that part, as found in the catalog. Does not descend into nested nodekits. Each nodekit along the path is the "detailPart" in its parent's detail. However, if the pick path goes through a list part, a pointer to the child is used for the "detailPart", and "detailPartName" is of the form "listName[i]".
- SoGetMatrixAction
Behaves like an SoGroup. Does nothing unless the kit is in the middle of the path chain the action is being applied to. If so, the children up to and including the next node in the chain are traversed.
- SoSearchAction
First, searches itself like an SoNode. Then, checks the value of isSearchingChildren(). If TRUE, traverses the children in order. If FALSE, returns.
- SoWriteAction
Begins by writing out regular fields, then writes out the parts. A nodekit does not write out its parts the way an SoGroup writes out its children. Instead, it writes each part as an SoSFNode field. First the partName is written, then the node being used for that part. To keep the files terse, nodekits write out as few parts as possible. However, nodekits always write a part if another instance or a path is writing it. If this is not the case, parts are left out according to the following rules: [1] NULL parts only write if the catalog states they are created by default. [2] Empty SoGroup and SoSeparator nodes do not write. [3] Non-leaf parts only write if they have non-default field values. [4] List parts only write if they have children or if the container node has non-default field values. [5] Nested nodekit parts only write if they need to write one or more parts, or if they have non-default field values.
- Parts
- callbackList
This is the only part that the base class SoBaseKit creates. It is a public part that is inherited by all nodekits. It provides an easy way to add callbacks for a nodekit to use during action traversal (e.g. SoHandleEventAction). It is a list part and may contain numerous SoCallback and/or SoEventCallback nodes.
- See Also
- SoAppearanceKit, SoCameraKit, SoLightKit, SoNodeKit, SoNodeKitDetail, SoNodeKitListPart, SoNodeKitPath, SoNodekitCatalog, SoSceneKit, SoSeparatorKit, SoShapeKit, SoWrapperKit
Definition at line 262 of file SoBaseKit.h.
Public Member Functions inherited from SoNode