Open Inventor Release 2023.2.2
 
Loading...
Searching...
No Matches
SoBase Class Referenceabstract

Base class for all nodes, paths, and engines. More...

#include <Inventor/misc/SoBase.h>

+ Inheritance diagram for SoBase:

Public Member Functions

virtual void touch ()
 Marks an instance as modified, simulating a change to it.
 
virtual SbName getName () const
 Returns the name of an instance.
 
virtual void setName (const SbName &name)
 Sets the name of an instance.
 
void setSynchronizable (const bool b)
 Sets this to be a ScaleViz synchronizable object.
 
bool isSynchronizable () const
 Gets the ScaleViz synchronizable state of this object.
 
- Public Member Functions inherited from SoRefCounter
void ref () const
 Adds a reference to an instance.
 
void unref () const
 Removes a reference from an instance.
 
void unrefNoDelete () const
 unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
 
int getRefCount () const
 Returns current reference count.
 
void lock () const
 lock this instance.
 
void unlock () const
 unlock this instance.
 
- Public Member Functions inherited from SoTypedObject
virtual SoType getTypeId () const =0
 Returns the type identifier for a specific instance.
 
SbBool isOfType (const SoType &type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type.
 
template<typename TypedObjectClass >
SbBool isOfType () const
 Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.
 

Static Public Member Functions

static SoType getClassTypeId ()
 Returns type identifier for this class.
 
- Static Public Member Functions inherited from SoTypedObject
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 

Friends

class SoVRMLDB
 

Detailed Description

Base class for all nodes, paths, and engines.

Abstract base class for Open Inventor node, path, and engine classes. This class handles reference counting, notification, and naming.

Instances should be referenced when they will be used outside of the routine in which they were initialized. (A typical example of this is maintaining a reference to the root of a graph.)

SEE ALSO

SoFieldContainer, SoNode, SoPath, SoEngine, SoDB

Definition at line 111 of file SoBase.h.

Member Function Documentation

◆ getClassTypeId()

static SoType SoBase::getClassTypeId ( )
static

Returns type identifier for this class.

◆ getName()

virtual SbName SoBase::getName ( ) const
virtual

Returns the name of an instance.

If the instance has not been named, an empty string is returned. Objects that are named can be looked up using the getByName() methods of SoNode, SoEngine, or SoPath.

◆ isSynchronizable()

bool SoBase::isSynchronizable ( ) const
inline

Gets the ScaleViz synchronizable state of this object.

Definition at line 425 of file SoBase.h.

◆ setName()

virtual void SoBase::setName ( const SbName name)
virtual

Sets the name of an instance.

Object names are preserved when objects are written to or read from files. Object names must not begin with a digit, and must not contain spaces or control characters, periods, single or double quote characters, backslashes, curly braces, square brackets or the plus character. The SbName::isBaseNameChar() and SbName::isBaseNameStartChar() methods can be used to validate names input by users. This method will replace any bad characters in the name with underscore characters, and will print out an error message if the application is using the Open Inventor debugging library.

The same name may be assigned to more than one instance.

Avoid using names that begin with "OIV_". Such names may be used internally.

Nodes may be queried by name using the SoNode::getByName methods. Node names may also be used with SoSearchAction.

◆ setSynchronizable()

void SoBase::setSynchronizable ( const bool  b)
inline

Sets this to be a ScaleViz synchronizable object.

By default all objects are synchronizable.

Definition at line 419 of file SoBase.h.

◆ touch()

virtual void SoBase::touch ( )
inlinevirtual

Marks an instance as modified, simulating a change to it.

This will notify auditors (parent nodes, connected engines, and so on) of a change to this object and cause attached sensors to be triggered.

Reimplemented in SoNode.

Definition at line 119 of file SoBase.h.

Friends And Related Symbol Documentation

◆ SoVRMLDB

friend class SoVRMLDB
friend

Definition at line 387 of file SoBase.h.


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