Open Inventor Release 2024.1.0
 
Loading...
Searching...
No Matches
SoSFNode Class Reference

Field containing a a node. More...

#include <Inventor/fields/SoSFNode.h>

+ Inheritance diagram for SoSFNode:

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
const SoSFNodeoperator= (const SoSFNode &f)
 Copy from another field of same type.
 
 SoSFNode ()
 Default constructor.
 
virtual ~SoSFNode ()
 Destructor.
 
SoNodegetValue () const
 Returns this field's value.
 
void setValue (SoNode *newValue)
 Sets this field to newValue.
 
SoNodeoperator= (SoNode *newValue)
 Sets this field to newValue.
 
int operator== (const SoSFNode &f) const
 Returns TRUE if otherField is of the same type and has the same value as this field.
 
int operator!= (const SoSFNode &f) const
 Returns FALSE if otherField is of the same type and has the same value as this field.
 
virtual size_t getValueSize () const
 Get size of the value.
 
SoNodegetValue (SbBool getEffectiveNode=FALSE)
 Gets the value of this field.
 
- Public Member Functions inherited from SoField
void setIgnored (SbBool ig)
 Sets the ignore flag for this field.
 
SbBool isIgnored () const
 Gets the ignore flag for this field.
 
SbBool isDefault () const
 Gets the state of default flag of the field.
 
void enableConnection (SbBool flag)
 Field connections may be enabled and disabled.
 
SbBool isConnectionEnabled () const
 Returns FALSE if connections to this field are disabled.
 
SbBool connectFrom (SoEngineOutput *engineOutput)
 Connects this field from an engine output.
 
SbBool connectFrom (SoField *field)
 Connects this field to another field.
 
SbBool connectFrom (SoVRMLInterpOutput *interpOutput)
 Connects this field from an interpOutput.
 
SbBool appendConnection (SoEngineOutput *engineOutput)
 Appends this field to the list of connections from another engineOutput.
 
SbBool appendConnection (SoField *field)
 Appends this field to the list of connections from another field.
 
SbBool appendConnection (SoVRMLInterpOutput *interpOutput)
 Appends this field to the list of connections from another interpOutput.
 
void disconnect (SoEngineOutput *engineOutput)
 Disconnect the field from the requested engineOutput.
 
void disconnect (SoField *field)
 Disconnect the field from the requested field.
 
void disconnect (SoVRMLInterpOutput *interpOutput)
 Disconnect the field from the requested interpOutput.
 
int getNumConnections () const
 Returns the number of connections to this field.
 
int getConnections (SoFieldList &list)
 Returns a list of the connections to this field.
 
void disconnect ()
 Disconnect the field from whatever it was connected to.
 
SbBool isConnected () const
 Returns TRUE if the field is connected to anything.
 
SbBool isConnectedFromVRMLInterp () const
 Returns TRUE if the field is connected to a VRML interpOutput.
 
SbBool isConnectedFromEngine () const
 Returns TRUE if the field is connected to an engine's output.
 
SbBool isConnectedFromField () const
 Returns TRUE if the field is connected to another field.
 
SbBool getConnectedEngine (SoEngineOutput *&engineOutput) const
 Returns TRUE if this field is being written into by an engine, and returns the engine output it is connected to in engineOutput.
 
SbBool getConnectedField (SoField *&writingField) const
 Returns TRUE if this field is being written into by another field, and returns the field it is connected to in writingField.
 
SbBool getConnectedVRMLInterp (SoVRMLInterpOutput *&interpOutput) const
 Returns the VRMLInterpolator output field is connected to.
 
int getForwardConnections (SoFieldList &list) const
 Adds references to all of the fields that this field is writing into (either fields in nodes, global fields or engine inputs) to the given field list, and returns the number of forward connections.
 
SoFieldContainergetContainer () const
 Returns the object that contains this field.
 
SoNONUNICODE SbBool set (const char *valueString)
 Sets the field to the given value, which is an ASCII string in the Open Inventor file format.
 
SbBool set (const SbString &valueString)
 Sets the field to the given value, which is an ASCII string in the Open Inventor file format.
 
void get (SbString &valueString)
 Returns the value of the field in the Open Inventor file format, even if the field has its default value.
 
virtual void touch ()
 Simulates a change to the field, causing attached sensors to fire, connected fields and engines to be marked as needing evaluation, and so forth.
 
int operator== (const SoField &f) const
 Return TRUE if this field is of the same type and has the same value as f.
 
int operator!= (const SoField &f) const
 Return FALSE if this field is of the same type and has the same value as f.
 
- 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 Public Member Functions inherited from SoSField
static SoType getClassTypeId ()
 Return the type identifier for this field class.
 
- Static Public Member Functions inherited from SoField
static SoType getClassTypeId ()
 Return the type identifier for this field class.
 
- Static Public Member Functions inherited from SoTypedObject
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 

Detailed Description

Field containing a a node.

This field maintains a an SoNode instance , correctly maintaining its reference counts .

SoSFNodes are written to file as the node they are containing. For example:

   mySoSFNodeField Cube {}

is an SoSFNode field named 'mySoSFNodeField', referring to an SoCube node. If the node is used elsewhere, the regular DEF/USE instancing mechanism applies:

   anotherSoSFNodeField USE topSeparator

is an SoSFNode field that refers to a node named 'topSeparator' that was DEF'ed earlier in the scene.

SEE ALSO

SoField, SoSField, SoMFNode, SoNode

Definition at line 97 of file SoSFNode.h.

Constructor & Destructor Documentation

◆ SoSFNode()

SoSFNode::SoSFNode ( )

Default constructor.

◆ ~SoSFNode()

virtual SoSFNode::~SoSFNode ( )
virtual

Destructor.

Member Function Documentation

◆ getClassTypeId()

static SoType SoSFNode::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SoSFNode::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Implements SoTypedObject.

◆ getValue() [1/2]

SoNode * SoSFNode::getValue ( ) const
inline

Returns this field's value.

Definition at line 100 of file SoSFNode.h.

◆ getValue() [2/2]

SoNode * SoSFNode::getValue ( SbBool  getEffectiveNode = FALSE)

Gets the value of this field.

The getEffectiveNode parameter is only used when the node in the field is a Proto. In this case, if the parameter is true then for convenience it returns the first child of the proto (the node the proto is pretending to be).

◆ getValueSize()

virtual size_t SoSFNode::getValueSize ( ) const
inlinevirtual

Get size of the value.

Reimplemented from SoField.

Definition at line 100 of file SoSFNode.h.

◆ operator!=()

int SoSFNode::operator!= ( const SoSFNode f) const
inline

Returns FALSE if otherField is of the same type and has the same value as this field.

Definition at line 100 of file SoSFNode.h.

◆ operator=() [1/2]

const SoSFNode & SoSFNode::operator= ( const SoSFNode f)

Copy from another field of same type.

◆ operator=() [2/2]

SoNode * SoSFNode::operator= ( SoNode newValue)
inline

Sets this field to newValue.

Definition at line 100 of file SoSFNode.h.

◆ operator==()

int SoSFNode::operator== ( const SoSFNode f) const

Returns TRUE if otherField is of the same type and has the same value as this field.

◆ setValue()

void SoSFNode::setValue ( SoNode newValue)

Sets this field to newValue.


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