|
| 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 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.
|
| |
|
| | 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.
|
| |
SoFieldContainer is the abstract base class for engines and nodes. It contains methods for finding out what fields an object has, controlling notification, and for dealing with all of the fields of an object at once.
The fields of an engine are its inputs. Note that even though an engine's output corresponds to a specific type of field, an engine output is not a field.
- See Also
- SoSField, SoMField, SoNode, SoDB
Definition at line 92 of file SoFieldContainer.h.
| bool SoFieldContainer::isNotifyEnabled |
( |
| ) |
const |
|
inline |
Notification is needed to make engines and sensors function, is used to keep SoPaths up to date when the scene graph's topology changes, and is also used to invalidate rendering or bounding box caches.
Notification is normally enabled, but can be disabled on a node by node (or engine by engine) basis. If you are making extensive changes to a large part of the scene graph then disabling notification can increase performance, at the expense of increased responsibility for making sure that any interested engines, sensors or paths are kept up to date.
For example, if you will be making a lot of changes to a small part of your scene graph and you know that there are no engines or sensors attached to nodes in that part of the scene graph, you might disable notification on the nodes you are changing, modify them, re-enable notification, and then touch() one of the nodes to cause a redraw.
However, you should profile your application and make sure that notification is taking a significant amount of time before going to the trouble of manually controlling notification.
Definition at line 190 of file SoFieldContainer.h.
Public Member Functions inherited from SoBase