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

#include <Inventor/nodes/SoNode.h>

Inheritance diagram for SoNode:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.

virtual void	setOverride (const SbBool state)
	Turns the override flag on or off.

virtual SbBool	isOverride () const
	Returns the state of the override flag.

virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.

virtual SbBool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.

virtual void	touch ()
	Marks an instance as modified, simulating a change to it.

Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.

SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.

SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.

void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.

SoNONUNICODE SbBool	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 Open Inventor file format.

SbBool	set (const SbString &fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.

virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.

virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.

virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.

virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.

SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.

SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).

SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.

virtual void	setUserData (void *data)
	Sets application data.

void *	getUserData (void) const
	Gets user application data.

Public Member Functions inherited from SoBase
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
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 the type identifier for this class.

static SoNode *	getByName (const SbName &name)
	A node's name can be set using SoBase::setName().

static int	getByName (const SbName &name, SoNodeList &list)
	A node's name can be set using SoBase::setName().

Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.

Static Public Member Functions inherited from SoBase
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	SoTraversalPassImpl

class	SoLdmValuationAction

class	SoPath

class	SoLightPath

class	SoAction

class	StringConcatCallback

class	SoChildList

class	SoCacheElement

class	inventor::impl::SoCachedGroupImpl

class	inventor::node::SoConstNode

class	SoCallbackAction

Detailed Description

Abstract base class for all database nodes.

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

FILE FORMAT/DEFAULT

ACTION BEHAVIOR

SoSearchAction

SoWriteAction
Writes the contents of the node to the current SoOutput.

Member Function Documentation

◆ affectsState()

virtual SbBool SoNode::affectsState ( ) const

virtual

Returns TRUE if a node has an effect on the state during traversal.

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 SoInteractionKit, SoNodeKitListPart, SoSceneKit, SoSeparatorKit, SoArray, SoComputeShaderScheduler, SoInteractiveSwitch, SoMultipleCopy, SoMultiSwitch, SoShape, SoViewingCube, PoBase, MoMeshBaseRepresentation, and SoOrthoSlice.

◆ copy()

virtual SoNode * SoNode::copy ( SbBool copyConnections = FALSE ) const

virtual

Creates and returns an exact copy of the node.

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. To be copyable, a custom node must define a default contructor. Note that OIV require that every custom node must define a default contructor.

Please also note that instance data other than Inventor fields and public children will not be copied by this method. If extra data needs to be copied as well, this method will have to be manually overridden.

Reimplemented in SoClipPlaneManip, and PoBase.

◆ getByName() [1/2]

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

static

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

This method allows nodes to be looked up by name. It returns the last node given the specified name.

◆ getByName() [2/2]

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

static

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

This method allows nodes to be looked up by net name. It returns the number of nodes with the given net name, and adds to list those nodes.

◆ getClassTypeId()

static SoType SoNode::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getTypeId()

virtual SoType SoNode::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Implements SoTypedObject.

◆ isOverride()

SbBool SoNode::isOverride ( ) const

inlinevirtual

Returns the state of the override flag.

Reimplemented in SoBaseColor, SoColorIndex, SoComplexity, SoDepthBuffer, SoDrawStyle, SoEnvironment, SoFont, SoFullSceneAntialiasing, SoLightModel, SoMaterial, SoMaterialBinding, SoPackedColor, SoPattern, SoPhysicalMaterial, SoPickStyle, SoPolygonOffset, SoShapeHints, SoTextProperty, SoTexture, and SoVertexProperty.

Definition at line 501 of file SoNode.h.

◆ setOverride()

void SoNode::setOverride ( const SbBool state )

inlinevirtual

Turns the override flag on or off.

The following property nodes are affected by the override flag: SoBaseColor, SoColorIndex, SoComplexity, SoDepthBuffer, SoDrawStyle, SoEnvironment, SoFont, SoFullSceneAntialiasing, SoLightModel, SoMaterial, SoPhysicalMaterial, SoMaterialBinding, SoPackedColor, SoPattern, SoPickStyle, SoPolygonOffset, SoShapeHints, SoVertexProperty, SoTextProperty.

Every node has an override flag associated with it. The override flag is a powerful mechanism typically used (sparingly) near the top of a scene graph. When this flag is set, any nodes of the same type encountered later in the graph are ignored even if they also have their own override flag set. For example, you might insert a line-style SoDrawStyle node at the top of a graph to ensure that the whole scene is drawn as wireframe objects, regardless of drawing styles specified lower in the scene graph. Use the setOverride() method to set and reset the override flag. The isOverride() method returns the state of the override flag.

Normally, the override flag is not used within a scene graph for modeling. Use it in applications where you need to specify a temporary change to the whole graph.

Note: The override flag is not written to a file.

Setting the override flag on a node whose field values are not inherited (for example on a sphere with a radius of 7) has no effect on other nodes in the graph of that type.

Reimplemented in SoBaseColor, SoColorIndex, SoComplexity, SoDepthBuffer, SoDrawStyle, SoEnvironment, SoFont, SoFullSceneAntialiasing, SoLightModel, SoMaterial, SoMaterialBinding, SoPackedColor, SoPattern, SoPhysicalMaterial, SoPickStyle, SoPolygonOffset, SoShapeHints, SoTextProperty, SoTexture, and SoVertexProperty.

Definition at line 493 of file SoNode.h.

◆ touch()

virtual void SoNode::touch ( )

virtual

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 from SoBase.

Friends And Related Symbol Documentation

◆ inventor::impl::SoCachedGroupImpl

friend class inventor::impl::SoCachedGroupImpl

friend

Definition at line 475 of file SoNode.h.

◆ inventor::node::SoConstNode

friend class inventor::node::SoConstNode

friend

Definition at line 476 of file SoNode.h.

◆ SoAction

friend class SoAction

friend

Definition at line 471 of file SoNode.h.

◆ SoCacheElement

friend class SoCacheElement

friend

Definition at line 474 of file SoNode.h.

◆ SoCallbackAction

friend class SoCallbackAction

friend

Definition at line 477 of file SoNode.h.

◆ SoChildList

friend class SoChildList

friend

Definition at line 473 of file SoNode.h.

◆ SoLdmValuationAction

friend class SoLdmValuationAction

friend

Definition at line 468 of file SoNode.h.

◆ SoLightPath

friend class SoLightPath

friend

Definition at line 470 of file SoNode.h.

◆ SoPath

friend class SoPath

friend

Definition at line 469 of file SoNode.h.

◆ SoTraversalPassImpl

friend class SoTraversalPassImpl

friend

Definition at line 467 of file SoNode.h.

◆ StringConcatCallback

friend class StringConcatCallback

friend

Definition at line 472 of file SoNode.h.

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

Inventor/nodes/SoNode.h

Open Inventor Release 2024.2.0

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

FILE FORMAT/DEFAULT

ACTION BEHAVIOR

SEE ALSO

Member Function Documentation

◆ affectsState()

◆ copy()

◆ getByName() [1/2]

◆ getByName() [2/2]

◆ getClassTypeId()

◆ getTypeId()

◆ isOverride()

◆ setOverride()

◆ touch()

Friends And Related Symbol Documentation

◆ inventor::impl::SoCachedGroupImpl

◆ inventor::node::SoConstNode

◆ SoAction

◆ SoCacheElement

◆ SoCallbackAction

◆ SoChildList

◆ SoLdmValuationAction

◆ SoLightPath

◆ SoPath

◆ SoTraversalPassImpl

◆ StringConcatCallback