Open Inventor Reference
SoNode Class Reference

Abstract base class for all database nodes. More...

#include <Inventor/nodes/SoNode.h>

Inheritance diagram for SoNode:
SoFieldContainer SoBase SoBaseColor SoBaseKit SoCallback SoCamera SoClipPlane SoComplexity SoCoordinate3 SoCoordinate4 SoDrawStyle SoEnvironment SoEventCallback SoFile SoFont SoGroup SoInfo SoLabel SoLight SoLightModel SoMaterial SoMaterialBinding SoNodeKitListPart SoNormal SoNormalBinding SoPackedColor SoPickStyle SoPolygonOffset SoProfile SoProfileCoordinate2 SoProfileCoordinate3 SoShape SoShapeHints SoTexture2 SoTexture2Transform SoTextureCoordinate2 SoTextureCoordinateBinding SoTextureCoordinateFunction SoTransformation SoVertexProperty SoWWWInline

Public Types

enum  Stage { FIRST_INSTANCE , PROTO_INSTANCE , OTHER_INSTANCE }
 

Public Member Functions

void setOverride (bool state)
 Turns override flag on or off. More...
 
bool isOverride () const
 Returns the state of the override flag. More...
 
SoNodecopy (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 doAction (SoAction *action)
 This method performs the "typical" operation of a node for any action. 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 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. 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 SoChildListgetChildren () const
 Returns pointer to children, or NULL if none. More...
 
virtual void writeInstance (SoOutput *out)
 Writes instance to SoOutput. (Used for either stage of writing.) More...
 
virtual SoNodeaddToCopyDict () const
 Recursively adds this node and all nodes under it to the copy dictionary. More...
 
virtual void copyContents (const SoFieldContainer *fromFC, bool copyConnections)
 Copies the contents of the given node into this instance. More...
 
virtual SoFieldContainercopyThroughConnection () const
 Copies an instance that is encountered through a field connection. More...
 
- Public Member Functions inherited from SoFieldContainer
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 SoFieldgetField (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...
 
virtual void addWriteReference (SoOutput *out, bool isFromField=FALSE)
 Adds a reference to the instance when writing. More...
 
bool getIsBuiltIn () const
 Returns whether or not instance is considered 'built-in' to the library. More...
 
virtual const SoFieldDatagetFieldData () const
 Returns an SoFieldData structure for the node. More...
 
void addManagedSensor (SoSensor *sensor)
 Adds a sensor which is managed by the field container. More...
 
- Public Member Functions inherited from SoBase
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 SoAuditorListgetAuditors ()
 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 Public Member Functions

static SoType getClassTypeId ()
 Returns type identifier for the SoNode class. More...
 
static SoNodegetByName (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 Public Member Functions inherited from SoFieldContainer
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 SoFieldContainercheckCopy (const SoFieldContainer *orig)
 If a copy of the given instance is in the dictionary, this returns it. More...
 
static SoFieldContainerfindCopy (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 Public Member Functions inherited from SoBase
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 SoBasegetNamedBase (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...
 

Protected Member Functions

 SoNode ()
 Constructor, destructor. More...
 
virtual ~SoNode ()
 
- Protected Member Functions inherited from SoFieldContainer
 SoFieldContainer ()
 
 ~SoFieldContainer ()
 
virtual bool readInstance (SoInput *in, unsigned short flags)
 Reads stuff into instance. Returns FALSE on error. More...
 
- Protected Member Functions inherited from SoBase
 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 Protected Member Functions

static const SoFieldData ** getFieldDataPtr ()
 This is used by the field-inheritence mechanism, hidden in the SoSubNode macros. More...
 
- Static Protected Member Functions inherited from SoBase
static uint32_t getCurrentWriteCounter ()
 Returns current write counter. More...
 

Protected Attributes

SbNodeIdType uniqueId
 Unique id for this node. More...
 
- Protected Attributes inherited from SoFieldContainer
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 Protected Attributes

static SbNodeIdType nextUniqueId
 Next available unique id. More...
 
static int nextActionMethodIndex
 Next index into the action method table. More...
 

Additional Inherited Members

- Static Public Attributes inherited from SoBase
static bool traceRefs
 Turns on/off reference count tracing (for debugging) More...
 
- Protected Types inherited from SoBase
enum  BaseFlags { IS_ENGINE = 1 , IS_GROUP = 2 }
 This set of enums is used when reading and writing the base. More...
 

Detailed Description

This is the abstract base class from which all scene graph node classes are derived.

Action Behavior
SoSearchAction
If the node pointer, type, or name matches the search criteria, returns a path to the node.
SoWriteAction
Writes the contents of the node to the current SoOutput.
See Also
SoPath, SoAction, SoNodeKit

Definition at line 103 of file SoNode.h.

Member Enumeration Documentation

◆ Stage

Enumerator
FIRST_INSTANCE 

First real instance being constructed.

PROTO_INSTANCE 

Prototype instance being constructed.

OTHER_INSTANCE 

Subsequent instance being constructed.

Definition at line 174 of file SoNode.h.

Constructor & Destructor Documentation

◆ SoNode()

SoNode::SoNode ( )
protected

◆ ~SoNode()

virtual SoNode::~SoNode ( )
protectedvirtual

Member Function Documentation

◆ addToCopyDict()

virtual SoNode* SoNode::addToCopyDict ( ) const
virtual

Returns the copy of this node.

Reimplemented in SoUnknownNode, and SoBaseKit.

◆ affectsState()

virtual bool SoNode::affectsState ( ) const
virtual

The default method returns TRUE. Node classes (such as SoSeparator) that isolate their effects from the rest of the graph override this method to return FALSE.

Reimplemented in SoSwitch, SoShape, SoSeparator, SoMultipleCopy, SoArray, SoSeparatorKit, SoSceneKit, SoNodeKitListPart, and SoInteractionKit.

◆ callback()

◆ copy()

SoNode* SoNode::copy ( bool  copyConnections = FALSE) const

If the node is a group, it copies the children as well. If copyConnections is TRUE (it is FALSE by default), any connections to (but not from) fields of the node are copied, as well. Note that multiple references to a node under the node to be copied will result in multiple references to the copy of that node.

◆ copyContents()

virtual void SoNode::copyContents ( const SoFieldContainer fromFC,
bool  copyConnections 
)
virtual

◆ copyThroughConnection()

virtual SoFieldContainer* SoNode::copyThroughConnection ( ) const
virtual

Reimplemented from SoFieldContainer.

◆ doAction()

◆ getActionMethodIndex()

static int SoNode::getActionMethodIndex ( SoType  t)
inlinestatic

Definition at line 206 of file SoNode.h.

References SoType::getData().

◆ getBoundingBox()

◆ getByName() [1/2]

static SoNode* SoNode::getByName ( const SbName name)
static

A node's name can be set using SoBase::setName(). Returns the number of nodes with the given name, and adds to list pointers to those nodes.

◆ getByName() [2/2]

static int SoNode::getByName ( const SbName name,
SoNodeList list 
)
static

A node's name can be set using SoBase::setName().

◆ getChildren()

◆ getClassTypeId()

static SoType SoNode::getClassTypeId ( )
inlinestatic

Definition at line 114 of file SoNode.h.

◆ getFieldDataPtr()

static const SoFieldData** SoNode::getFieldDataPtr ( )
inlinestaticprotected

Definition at line 224 of file SoNode.h.

◆ getMatrix()

◆ getNextNodeId()

static SbNodeIdType SoNode::getNextNodeId ( )
inlinestatic

Definition at line 196 of file SoNode.h.

◆ getNodeId()

SbNodeIdType SoNode::getNodeId ( ) const
inline

Definition at line 193 of file SoNode.h.

◆ GLRender()

◆ GLRenderBelowPath()

virtual void SoNode::GLRenderBelowPath ( SoGLRenderAction action)
virtual

The SoNode methods just call GLRender.

Reimplemented in SoSeparator, SoLOD, SoLocateHighlight, and SoAnnotation.

◆ GLRenderInPath()

virtual void SoNode::GLRenderInPath ( SoGLRenderAction action)
virtual

Reimplemented in SoSeparator, SoLOD, SoLocateHighlight, and SoAnnotation.

◆ GLRenderOffPath()

virtual void SoNode::GLRenderOffPath ( SoGLRenderAction action)
virtual

Reimplemented in SoSeparator, and SoLOD.

◆ grabEventsCleanup()

virtual void SoNode::grabEventsCleanup ( )
virtual

Reimplemented in SoDragger.

◆ grabEventsSetup()

virtual void SoNode::grabEventsSetup ( )
virtual

The default methods do nothing.

Reimplemented in SoDragger.

◆ handleEvent()

◆ initClass()

static void SoNode::initClass ( )
static

◆ initClasses()

static void SoNode::initClasses ( )
static

◆ isOverride()

bool SoNode::isOverride ( ) const
inline

Definition at line 111 of file SoNode.h.

◆ notify()

virtual void SoNode::notify ( SoNotList list)
virtual

Reimplemented from SoFieldContainer.

Reimplemented in SoVertexShape, SoSeparator, SoIndexedShape, and SoBlinker.

◆ pick()

◆ rayPick()

◆ search()

◆ setOverride()

void SoNode::setOverride ( bool  state)

◆ startNotify()

virtual void SoNode::startNotify ( )
virtual

Reimplemented from SoBase.

◆ write()

virtual void SoNode::write ( SoWriteAction action)
virtual

◆ writeInstance()

virtual void SoNode::writeInstance ( SoOutput out)
virtual

Reimplemented from SoFieldContainer.

Member Data Documentation

◆ nextActionMethodIndex

int SoNode::nextActionMethodIndex
staticprotected

Definition at line 237 of file SoNode.h.

◆ nextUniqueId

SbNodeIdType SoNode::nextUniqueId
staticprotected

Definition at line 234 of file SoNode.h.

◆ uniqueId

SbNodeIdType SoNode::uniqueId
protected

Definition at line 231 of file SoNode.h.


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