SoNode(3)

📦 version 3.1.3, in fedora 43, fedora 44

🎀 SoNode(3) — Library Functions Manual 🎀

okay so bestie, sit DOWN because we're about to talk about the single most important class in the whole Coin/Inventor situation. This is SoNode(3), and honestly? she's the blueprint. the blueprint of blueprints. everything in your scene graph is a node, and this is the mom of all of them. 🌸

✨ NAME ✨

SoNode — the base class for nodes used in scene graphs. that's it. that's the whole job. she's the ancestor, the origin story, the main character from whom literally everyone else descends. 💅

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoNode.h>

Inherits SoFieldContainer. (yes, she has a parent too, the family tree is giving dynasty.)

Inherited by all of these icons, and I need you to understand the RANGE:

SoBaseColor, SoBaseKit, SoBumpMap, SoBumpMapCoordinate,
SoBumpMapTransform, SoCacheHint, SoCallback, SoCamera, SoClipPlane,
SoColorIndex, SoComplexity, SoCoordinate3, SoCoordinate4, SoDepthBuffer,
SoDrawStyle, SoEnvironment, SoEventCallback, SoFile, SoFont,
SoGeoCoordinate, SoGeoOrigin, SoGroup, SoInfo, SoLabel, SoLight,
SoLightModel, SoListener, SoMaterial, SoMaterialBinding, SoNodeEngine,
SoNodeKitListPart, SoNormal, SoNormalBinding, SoPackedColor,
SoPickStyle, SoPolygonOffset, SoProfile, SoProfileCoordinate2,
SoProfileCoordinate3, SoProfilerStats, SoProto, SoProtoInstance,
SoSceneTexture2, SoSceneTextureCubeMap, SoShaderObject,
SoShaderParameter, SoShaderProgram, SoShadowCulling, SoShadowStyle,
SoShape, SoShapeHints, , SoTexture2Transform, SoTexture3Transform,
SoTextureCombine, SoTextureCoordinate2, SoTextureCoordinate3,
SoTextureCoordinateBinding, SoTextureCoordinateCube,
SoTextureCoordinateCylinder, SoTextureCoordinateFunction,
SoTextureCoordinateSphere, SoTextureMatrixTransform,
SoTextureScalePolicy, SoTextureUnit, SoTransformation,
SoTransparencyType, SoVRMLAppearance, SoVRMLAudioClip, SoVRMLBackground,
SoVRMLColor, SoVRMLCoordinate, SoVRMLFog, SoVRMLFontStyle, SoVRMLInline,
SoVRMLLight, SoVRMLMaterial, SoVRMLNavigationInfo, SoVRMLNormal,
SoVRMLProximitySensor, SoVRMLScript, SoVRMLSensor, SoVRMLShape,
SoVRMLSound, SoVRMLTexture, SoVRMLTextureCoordinate,
SoVRMLTextureTransform, SoVRMLTouchSensor, SoVRMLViewpoint,
SoVRMLVisibilitySensor, SoVRMLWorldInfo, SoVertexAttribute,
SoVertexAttributeBinding, and SoVertexProperty.
yes that double comma up there in the list is in the original and we are NOT fixing it, we reproduce faithfully in this house 💖

🌟 Public Types 🌟

enum NodeType { INVENTOR = 0x0000, VRML1 = 0x0001, VRML2 = 0x0002,
    INVENTOR_1 = 0x0004, INVENTOR_2_0 = 0x0008, INVENTOR_2_1 = 0x0010,
    INVENTOR_2_5 = 0x0020, INVENTOR_2_6 = 0x0040, COIN_1_0 = 0x0080,
    COIN_2_0 = 0x0100, EXTENSION = 0x0200, COIN_2_2 = 0x0400, COIN_2_3 =
    0x0800, COIN_2_4 = 0x1000, INVENTOR_5_0 = 0x2000, COIN_2_5 = 0x4000,
    COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000 }

these are the bitflags for which flavour of scene-graph lore a node belongs to. iconic little flag collection ngl.

🌟 Public Member Functions 🌟

void setOverride (const SbBool state)
SbBool isOverride (void) const
void setNodeType (const NodeType type)
NodeType getNodeType (void) const
virtual SoNode * copy (SbBool copyconnections=FALSE) const
virtual SbBool affectsState (void) const
virtual void doAction (SoAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void GLRenderBelowPath (SoGLRenderAction *action)
virtual void GLRenderInPath (SoGLRenderAction *action)
virtual void GLRenderOffPath (SoGLRenderAction *action)
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 audioRender (SoAudioRenderAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual void grabEventsSetup (void)
virtual void grabEventsCleanup (void)
virtual void startNotify (void)
virtual void notify (SoNotList *l)
uint32_t getNodeId (void) const
virtual SoChildList * getChildren (void) const
virtual void writeInstance (SoOutput *out)
virtual SoNode * addToCopyDict (void) const
virtual void copyContents (const SoFieldContainer *from, SbBool
    copyconnections)
virtual SoFieldContainer * copyThroughConnection (void) const

🌟 Public Member Functions inherited from SoFieldContainer 🌟

void setToDefaults (void)
SbBool hasDefaultValues (void) const
SbBool fieldsAreEqual (const SoFieldContainer *container) const
void copyFieldValues (const SoFieldContainer *container, SbBool
    copyconnections=FALSE)
SbBool set (const char *const fielddata)
void get (SbString &fielddata)
virtual int getFields (SoFieldList &l) const
virtual int getAllFields (SoFieldList &l) const
virtual SoField * getField (const SbName &name) const
virtual SoField * getEventIn (const SbName &name) const
virtual SoField * getEventOut (const SbName &name) const
SbBool getFieldName (const SoField *const field, SbName &name) const
SbBool enableNotify (const SbBool flag)
SbBool isNotifyEnabled (void) const
SbBool set (const char *fielddata, SoInput *input)
void get (SbString &fielddata, SoOutput *out)
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
SbBool getIsBuiltIn (void) const
virtual const SoFieldData * getFieldData (void) const
virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged)
    const
void setUserData (void *userdata) const
void * getUserData (void) const

🌟 Public Member Functions inherited from SoBase 🌟

void ref (void) const
void unref (void) const
void unrefNoDelete (void) const
int32_t getRefCount (void) const
void touch (void)
virtual SoType getTypeId (void) const =0
SbBool isOfType (SoType type) const
virtual SbName getName (void) const
virtual void setName (const SbName &newname)
void addAuditor (void *const auditor, const SoNotRec::Type type)
void removeAuditor (void *const auditor, const SoNotRec::Type type)
const SoAuditorList & getAuditors (void) const
SbBool shouldWrite (void)
void assertAlive (void) const

🌟 Static Public Member Functions 🌟

static uint32_t getCompatibilityTypes (const SoType &nodetype)
static SoType getClassTypeId (void)
static SoNode * getByName (const SbName &name)
static int getByName (const SbName &name, SoNodeList &l)
static void initClass (void)
static void initClasses (void)
static uint32_t getNextNodeId (void)
static int getActionMethodIndex (const SoType type)
static void getBoundingBoxS (SoAction *action, SoNode *node)
static void GLRenderS (SoAction *action, SoNode *node)
static void callbackS (SoAction *action, SoNode *node)
static void getMatrixS (SoAction *action, SoNode *node)
static void handleEventS (SoAction *action, SoNode *node)
static void pickS (SoAction *action, SoNode *node)
static void rayPickS (SoAction *action, SoNode *node)
static void searchS (SoAction *action, SoNode *node)
static void writeS (SoAction *action, SoNode *node)
static void audioRenderS (SoAction *action, SoNode *node)
static void getPrimitiveCountS (SoAction *action, SoNode *node)

🌟 Static Public Member Functions inherited from SoFieldContainer 🌟

static void initClass (void)
static SoType getClassTypeId (void)
static void cleanupClass (void)
static void initCopyDict (void)
static void addCopy (const SoFieldContainer *orig, const
    SoFieldContainer *copy)
static SoFieldContainer * checkCopy (const SoFieldContainer *orig)
static SoFieldContainer * findCopy (const SoFieldContainer *orig, const
    SbBool copyconnections)
static void copyDone (void)

🌟 Static Public Member Functions inherited from SoBase 🌟

static void initClass (void)
static SoType getClassTypeId (void)
static void addName (SoBase *const base, const char *const name)
static void removeName (SoBase *const base, const char *const name)
static void incrementCurrentWriteCounter (void)
static void decrementCurrentWriteCounter (void)
static SoBase * getNamedBase (const SbName &name, SoType type)
static int getNamedBases (const SbName &name, SoBaseList &baselist,
    SoType type)
static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype)
static void setInstancePrefix (const SbString &c)
static void setTraceRefs (SbBool trace)
static SbBool getTraceRefs (void)
static SbBool connectRoute (SoInput *input, const SbName &fromnodename,
    const SbName &fromfieldname, const SbName &tonodename, const SbName
    &tofieldname)
static SbBool readRoute (SoInput *input)

🌟 Protected Member Functions 🌟

SoNode (void)
virtual ~SoNode ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)

🌟 Protected Member Functions inherited from SoFieldContainer 🌟

SoFieldContainer (void)
virtual ~SoFieldContainer ()

🌟 Protected Member Functions inherited from SoBase 🌟

SoBase (void)
virtual ~SoBase ()
virtual void destroy (void)
SbBool hasMultipleWriteRefs (void) const
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine)
    const
void writeFooter (SoOutput *out) const
virtual const char * getFileFormatName (void) const

🌟 Static Protected Member Functions 🌟

static const SoFieldData ** getFieldDataPtr (void)
static void setNextActionMethodIndex (int index)
static int getNextActionMethodIndex (void)
static void incNextActionMethodIndex (void)
static void setCompatibilityTypes (const SoType &nodetype, const
    uint32_t bitmask)

🌟 Static Protected Member Functions inherited from SoBase 🌟

static uint32_t getCurrentWriteCounter (void)
static void staticDataLock (void)
static void staticDataUnlock (void)

🌟 Protected Attributes 🌟

uint32_t uniqueId

🌟 Protected Attributes inherited from SoFieldContainer 🌟

SbBool isBuiltIn

🌟 Static Protected Attributes 🌟

static uint32_t nextUniqueId = 1
static int nextActionMethodIndex = 0

🌟 Additional Inherited Members 🌟

🌟 Protected Types inherited from SoBase 🌟

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

and bestie, we are SO not done — this is part 1 of 5 and there is so much more lore coming. stay tuned 💖🦋

✨ Detailed Description ✨

okay so bestie, welcome to the main character of this whole library: SoNode 💅 it's the base class for all the nodes you use in scene graphs. everything else is literally just vibing off of it.

Coin is a retained mode 3D visualization library (and yeah, it's built on top of the immediate mode OpenGL library, iykyk). "Retained mode" means that instead of yeeting draw commands for graphics primitives straight at the renderer, you build up data structures and the library renders them on demand. lowkey elegant, fr fr 🌸

The node classes are the main "primitive" for building those data structures. In Coin you build tree hierarchies out of different node types:

  • group nodes — for the tree structure layout of the other nodes
  • appearance nodes — for setting up materials, textures, etc
  • shape nodes — for the actual geometry
  • and nodes for lighting and camera positioning
⚠️ okay this is the part where newcomers always fumble, so listen up: you should not and can not use the C++ delete operator on nodes — the destructor is protected. not a suggestion, it's the rules 💀

Why? Because node instances use a common technique for memory resource handling called "referencecounting". Nodes are deleted (actually, they delete themselves, main character energy honestly) when their unref() method is called and the reference count hits zero. 🎀

One important side-effect of this: SoNode-derived classes should not be statically allocated — not in static module memory, and not on a function's stack-frames. Nope nope nope. SoNode-derived classes must always be allocated dynamically from the memory heap with the new operator, or else the whole scheme of self-destruction upon de-referencing to 0 would not work. 🙈

Usually application programmers won't manually ref() and unref() nodes a lot, because you pass the nodes directly to SoGroup::addChild() or So*Viewer::setSceneGraph() or something similar. These functions will ref() the nodes they are passed, and unref() them when they're finished with them. so convenient, honestly 🫶

Make sure you do ref() nodes that you keep pointers to, so they aren't accidentally deleted prematurely due to an unref() call from within the library itself. If you haven't manually called ref() on a top-level root node, it will then be deleted automatically. Here's how you do it:

SoSeparator * root = new SoSeparator; // root's refcount starts out at zero
root->addChild(foo_node); // foo_node refcount is increased by 1
root->addChild(bar_node); // bar_node refcount +1

// increase refcount before passing it to setScenegraph(), to avoid
// premature destruction
root->ref();

myviewer->setSceneGraph(root); // root's refcount +1, is now 2

// [misc visualization and processing]

// myviewer will let go of it's reference to the root node, thereby
// decreasing it's referencecount by 1
myviewer->setSceneGraph(NULL);

// root's refcount goes from +1 to 0, and it will self-destruct controllably
root->unref();
// avoid dangling pointer, in case "root" is attempted used again
// (not really necessary, but good for smoking out bugs early)
root = NULL;

For full information and tutorial-style introductions to all API issues, see the "Inventor Mentor: Programming Object-Oriented 3DGraphics with Open Inventor" (ISBN 0-201-62495-8). It has detailed explanations on all the basic principles involved. 📚

See specifically the section "References and Deletion" in Chapter 3 to learn about the reference counting techniques. that's the one, bestie 🎯

Often when using the Coin library, one is interested in making extensions to it. Of particular interest is setting up extension nodes, which are then traversed, rendered and otherwise used by the rest of the library as any internal node. ✨

The Coin header file Inventor/nodes/SoSubNode.h includes a set of convenience macros for quick and easy construction of extension nodes. Here's a complete snippet of code which shows how to set up a skeleton framework for an extension node class:

#include <Inventor/nodes/SoWWWInline.h>

class MyWWWInline : public SoWWWInline {
  SO_NODE_HEADER(MyWWWInline);

public:
  static void initClass(void);
  MyWWWInline(void);

protected:
  virtual ~MyWWWInline();
};

SO_NODE_SOURCE(MyWWWInline);

MyWWWInline::MyWWWInline(void)
{
  SO_NODE_CONSTRUCTOR(MyWWWInline);
}

MyWWWInline::~MyWWWInline()
{
}

void
MyWWWInline::initClass(void)
{
  SO_NODE_INIT_CLASS(MyWWWInline, SoWWWInline, "SoWWWInline");
}

int
main(int argc, char ** argv)
{
  SoDB::init();
  MyWWWInline::initClass();

  // [...]

  return 0;
}

You can then override for instance the GLRender() method to have your new class render OpenGL geometry different from it's superclass. slay 🔥

For extending the Coin library with your own classes, we strongly recommend that you make yourself acquainted with the excellent «The Inventor Toolmaker» book (ISBN 0-201-62493-1), which describes the tasks involved in detail. This book was written by the original SGI Inventor designers and explains many of the underlying design ideas, aswell as having lots of hands-on examples on how to extend the Coin toolkit in ways that are true to the fundamental design ideas. («The Inventor Toolmaker» is also available at SGI's online library, at no cost. See Download The Inventor Toolmaker.) Reading the sourcecode of the built-in classes in Coin should also provide very helpful. 💖

For information about dynamic loading of extension nodes, see the documentation of SoType::fromName(). 👑

🌈 Member Enumeration Documentation 🌈

enum SoNode::NodeType

Used to store node type. simple as that, bestie 💅

Enumerator

  • INVENTOR — Specifies Inventor node type.
  • VRML1 — Node is VRML V1.0 compatible.
  • VRML2 — Node is from the VRML V2.0 specification.
  • INVENTOR_1 — Node was part of SGI Inventor version 1.
  • INVENTOR_2_0 — Node was part of SGI Inventor version 2.0.
  • INVENTOR_2_1 — Node was introduced with SGI / TGS Inventor version 2.1.
  • INVENTOR_2_5 — Node was introduced with TGS Inventor version 2.5.
  • INVENTOR_2_6 — Node was introduced with TGS Inventor version 2.6.
  • COIN_1_0 — Node was part of Coin version 1.
  • COIN_2_0 — Node was introduced with Coin 2.0.
  • EXTENSION — Node is a client code extension.

🎀 Constructor & Destructor Documentation 🎀

SoNode::SoNode (void ) [protected]

Default constructor, initializes node instance. ✨

SoNode::~SoNode () [protected], [virtual]

Destructor. (remember: it's protected, so hands off with delete, bestie 🙈)

💜 Member Function Documentation 💜

void SoNode::setOverride (const SbBool state)

Set the override flag. 🚩

If this flag is TRUE, the field values of this node will override the field values of other nodes of the same type during scene graph traversal. it's giving "I'm the blueprint now" energy 💅

A common applicaton for "override nodes" is to place them at the top of the tree as a convenient way to force e.g. a common drawstyle on the complete tree.

⚠️ The override flag does not exist in the Inventor file format. In other words it is not persistent, and must be programmatically set. The rationale for this flag is for viewers to be able to control rendering style of the 3D models, so it would look stupid if some parts of certain models suddenly didn't adhere to the viewer mode. and we do NOT look stupid 🫶

SbBool SoNode::isOverride (void ) const

Return status of override flag.

See also

  • setOverride()

uint32_t SoNode::getCompatibilityTypes (const SoType & nodetype) [static]

Get the node compatibility mask for node type nodetype. The return value will be a bit mask of SoNode::NodeType flags, containing one or several flags. ✨

💡 This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since

  • Coin 2.0

void SoNode::setNodeType (const NodeType type)

Sets the node type for this node to type. Since some nodes should be handled differently in VRML1 vs. Inventor, this should be used to get correct behavior for those cases. The default node type is INVENTOR. 🦋

💡 This method is an extension versus the Open Inventor API.

See also

  • getNodeType()

SoNode::NodeType SoNode::getNodeType (void ) const

Returns the node type set for this node. 🌸

💡 This method is an extension versus the Open Inventor API.

See also

  • setNodeType()

SoNode * SoNode::copy (SbBool copyconnections = FALSE) const [virtual]

Make a duplicate of this node and return a pointer to the duplicate. ✨

If this node is a group node, children are also copied and we return a pointer to the root of a full copy of the subgraph rooted here. the whole tree comes with, periodt 🌳

If copyconnections is TRUE, we also copy the connections to fields within this node (and ditto for any children and children's children etc).

⚠️ Note that this function has been made virtual in Coin, which is not the case in the original Open Inventor API. We may change this method back into being non-virtual again for major Coin versions after this, as it was made virtual more or less by mistake. So please don't write application code that depends on SoNode::copy() being virtual. 💀

The reason this method should not be virtual is because this is not the function the application programmer should override in extension nodes if she needs some special behavior during a copy operation (like copying the value of internal data not exposed as fields).

For that purpose, override the copyContents() method. Your overridden copyContents() method should then both copy internal data aswell as calling the parent superclass' copyContents() method for automatically handling of fields and other common data. 👑

SbBool SoNode::affectsState (void ) const [virtual]

Returns TRUE if the node could have any effect on the state during traversal.

If it returns FALSE, no data in the traversal-state will change from the pre-traversal state to the post-traversal state. The SoSeparator node will for instance return FALSE, as it pushes and pops the state before and after traversal of its children. All SoShape nodes will also return FALSE, as just pushing out geometry data to the rendering engine won't affect the actual rendering state. okay so basically it's not touching anything, it's just passing through 🧚

The default method returns TRUE, on a "better safe than sorry" philosophy. very sensible, honestly 💖

Reimplemented in SoArray, SoMultipleCopy, SoNodeKitListPart, SoSceneKit, SoSeparator, SoShape, SoSwitch, SoVRMLLOD, SoVRMLParent, SoVRMLProximitySensor, SoVRMLShape, SoVRMLSwitch, and SoVRMLTouchSensor.

void SoNode::doAction (SoAction * action) [virtual]

This function performs the typical operation of a node for any action. 🎬

…and the reimplementer roll call from before just keeps going, bestie 💅 every single one of these beauties overrides it:

SoAntiSquish, SoArray, SoBaseColor, SoBaseKit, SoBumpMap, SoBumpMapCoordinate, SoBumpMapTransform, SoCacheHint, SoCallback, SoCamera, SoClipPlane, SoClipPlaneManip, SoComplexity, SoCoordinate3, SoCoordinate4, SoDirectionalLightManip, SoDrawStyle, SoFile, SoFont, SoFontStyle, SoGeoCoordinate, SoGeoLocation, SoGeoOrigin, SoGroup, SoLevelOfDetail, SoLightModel, SoLOD, SoMaterial, SoMaterialBinding, SoMatrixTransform, SoMultipleCopy, SoNodeKitListPart, SoNormal, SoNormalBinding, SoPackedColor, SoPathSwitch, SoPickStyle, SoPointLightManip, SoPolygonOffset, SoProfile, SoProfileCoordinate2, SoProfileCoordinate3, SoResetTransform, SoRotation, SoRotationXYZ, SoScale, SoSceneTexture2, SoSceneTextureCubeMap, SoSeparator, SoShapeHints, SoSpotLightManip, SoSurroundScale, SoSwitch, SoTexture2, SoTexture2Transform, SoTexture3, SoTexture3Transform, SoTextureCombine, SoTextureCoordinate2, SoTextureCoordinate3, SoTextureCoordinateBinding, SoTextureCoordinateCube, SoTextureCoordinateCylinder, SoTextureCoordinateDefault, SoTextureCoordinateEnvironment, SoTextureCoordinateNormalMap, SoTextureCoordinateObject, SoTextureCoordinatePlane, SoTextureCoordinateReflectionMap, SoTextureCoordinateSphere, SoTextureCubeMap, SoTextureMatrixTransform, SoTextureUnit, SoTransform, SoTransformManip, SoTransformSeparator, SoTranslation, SoTransparencyType, SoUnits, SoVertexAttribute, SoVertexAttributeBinding, SoVertexProperty, SoVRMLAppearance, SoVRMLBillboard, SoVRMLColor, SoVRMLCoordinate, SoVRMLFontStyle, SoVRMLGroup, SoVRMLImageTexture, SoVRMLInline, SoVRMLLOD, SoVRMLMaterial, SoVRMLNormal, SoVRMLParent, SoVRMLPixelTexture, SoVRMLProximitySensor, SoVRMLScript, SoVRMLShape, SoVRMLSwitch, SoVRMLTextureCoordinate, SoVRMLTextureTransform, SoVRMLTransform, SoVRMLVertexLine, SoVRMLVertexPoint, SoVRMLVertexShape, and SoWWWInline.

✨ GLRender ✨

void SoNode::GLRender (SoGLRenderAction * action) [virtual]

This is the action method for the SoGLRenderAction — aka the thing that fires while rendering traversals are happening. 🌈

Any node that messes with the rendering state in any way, or that just wants to yeet geometry primitives straight at OpenGL, overrides this bad boy.

Reimplemented in SoAnnotation, SoAntiSquish, SoArray, SoAsciiText, SoBaseColor, SoBaseKit, SoBumpMap, SoBumpMapCoordinate, SoBumpMapTransform, SoCacheHint, SoCallback, SoCamera, SoClipPlane, SoClipPlaneManip, SoColorIndex, SoComplexity, SoCone, SoCoordinate3, SoCoordinate4, SoCube, SoCylinder, SoDepthBuffer, SoDirectionalLight, SoDirectionalLightManip, SoDragger, SoDrawStyle, SoEnvironment, SoFaceSet, SoFile, SoFont, SoFontStyle, SoGeoCoordinate, SoGeoLocation, SoGeometryShader, SoGeoOrigin, SoGroup, SoImage, SoIndexedFaceSet, SoIndexedLineSet, SoIndexedMarkerSet, SoIndexedNurbsCurve, SoIndexedNurbsSurface, SoIndexedPointSet, SoIndexedTriangleStripSet, SoLevelOfDetail, SoLightModel, SoLineSet, SoLOD, SoMarkerSet, SoMaterial, SoMaterialBinding, SoMatrixTransform, SoMultipleCopy, SoNodeKitListPart, SoNormal, SoNormalBinding, SoNurbsCurve, SoNurbsSurface, SoPackedColor, SoPathSwitch, SoPointLight, SoPointLightManip, SoPointSet, SoPolygonOffset, SoProfile, SoProfileCoordinate2, SoProfileCoordinate3, SoProfilerStats, SoQuadMesh, SoResetTransform, SoRotation, SoRotationXYZ, SoScale, SoSceneTexture2, SoSceneTextureCubeMap, SoSeparator, SoShaderObject, SoShaderProgram, SoShadowCulling, SoShadowSpotLight, SoShadowStyle, SoShape, SoShapeHints, SoSphere, SoSpotLight, SoSpotLightManip, SoSurroundScale, SoSwitch, SoTabPlaneDragger, SoText2, SoText3, SoTexture2, SoTexture2Transform, SoTexture3, SoTexture3Transform, SoTextureCombine, SoTextureCoordinate2, SoTextureCoordinate3, SoTextureCoordinateBinding, SoTextureCoordinateCube, SoTextureCoordinateCylinder, SoTextureCoordinateDefault, SoTextureCoordinateEnvironment, SoTextureCoordinateNormalMap, SoTextureCoordinateObject, SoTextureCoordinatePlane, SoTextureCoordinateReflectionMap, SoTextureCoordinateSphere, SoTextureCubeMap, SoTextureMatrixTransform, SoTextureScalePolicy, SoTextureUnit, SoTransform, SoTransformManip, SoTransformSeparator, SoTranslation, SoTransparencyType, SoTriangleStripSet, SoUnits, SoVertexAttribute, SoVertexAttributeBinding, SoVertexProperty, SoVRMLAppearance, SoVRMLBackground, SoVRMLBillboard, SoVRMLBox, SoVRMLCollision, SoVRMLColor, SoVRMLCone, SoVRMLCoordinate, SoVRMLCylinder, SoVRMLDirectionalLight, SoVRMLElevationGrid, SoVRMLExtrusion, SoVRMLFog, SoVRMLFontStyle, SoVRMLGroup, SoVRMLImageTexture, SoVRMLIndexedFaceSet, SoVRMLIndexedLineSet, SoVRMLInline, SoVRMLLight, SoVRMLLOD, SoVRMLMaterial, SoVRMLMovieTexture, SoVRMLNavigationInfo, SoVRMLNormal, SoVRMLPixelTexture, SoVRMLPointLight, SoVRMLPointSet, SoVRMLProximitySensor, SoVRMLScript, SoVRMLShape, SoVRMLSphere, SoVRMLSpotLight, SoVRMLSwitch, SoVRMLText, SoVRMLTexture, SoVRMLTextureCoordinate, SoVRMLTextureTransform, SoVRMLVertexLine, SoVRMLVertexPoint, SoVRMLVertexShape, SoVRMLViewpoint, SoVRMLVisibilitySensor, and SoWWWInline.

🎀 GLRenderBelowPath 🎀

void SoNode::GLRenderBelowPath (SoGLRenderAction * action) [virtual]

This one implements the SoAction::BELOW_PATH traversal method for the rendering action, no cap. 🦋

Reimplemented in SoAnnotation, SoExtSelection, SoGeoSeparator, SoLocateHighlight, SoLOD, SoSeparator, SoShadowGroup, SoVRMLBillboard, SoVRMLGroup, SoVRMLLOD, and SoVRMLTransform.

🫶 GLRenderInPath 🫶

void SoNode::GLRenderInPath (SoGLRenderAction * action) [virtual]

And this queen implements the SoAction::IN_PATH traversal method for the rendering action. Iconic behaviour, fr fr. ✨

Reimplemented in SoAnnotation, SoGeoSeparator, SoLocateHighlight, SoLOD, SoSeparator, SoShadowGroup, SoVRMLBillboard, SoVRMLGroup, SoVRMLLOD, and SoVRMLTransform.

💜 GLRenderOffPath 💜

void SoNode::GLRenderOffPath (SoGLRenderAction * action) [virtual]

And the last of the rendering-path trio: this handles the SoAction::OFF_PATH traversal method for the rendering action. 🌸

Reimplemented in SoAnnotation, SoLOD, SoSeparator, SoVRMLBillboard, SoVRMLGroup, and SoVRMLLOD.

🌈 callback 🌈

void SoNode::callback (SoCallbackAction * action) [virtual]

Action method for SoCallbackAction. 💖

Basically it just updates the state to match how the node behaves for the render action — that way you, the application programmer, can use SoCallbackAction to pull information out of the scene graph. It's giving "state sync so you can snoop", and honestly? Obsessed.

Reimplemented in SoAntiSquish, SoArray, SoBaseColor, SoBaseKit, SoBumpMap, SoBumpMapCoordinate, SoBumpMapTransform, SoCacheHint, SoCallback, SoCamera, SoClipPlane, SoClipPlaneManip, SoComplexity, SoCoordinate3, SoCoordinate4, SoDirectionalLightManip, SoDragger, SoDrawStyle, SoEnvironment, SoFile, SoFont, SoFontStyle, SoGeoCoordinate, SoGeoLocation, SoGeoOrigin, SoGeoSeparator, SoGroup, SoLevelOfDetail, SoLight, SoLightModel, SoLOD, SoMaterial, SoMaterialBinding, SoMatrixTransform, SoMultipleCopy, SoNodeKitListPart, SoNormal, SoNormalBinding, SoPackedColor, SoPathSwitch, SoPickStyle, SoPointLightManip, SoPolygonOffset, SoProfile, SoProfileCoordinate2, SoProfileCoordinate3, SoProfilerStats, SoResetTransform, SoRotation, SoRotationXYZ, SoScale, SoSceneTexture2, SoSceneTextureCubeMap, SoSeparator, SoShape, SoShapeHints, SoSpotLightManip, SoSurroundScale, SoSwitch, SoTexture2, SoTexture2Transform, SoTexture3, SoTexture3Transform, SoTextureCombine, SoTextureCoordinate2, SoTextureCoordinate3, SoTextureCoordinateBinding, SoTextureCoordinateCube, SoTextureCoordinateCylinder, SoTextureCoordinateDefault, SoTextureCoordinateEnvironment, SoTextureCoordinateNormalMap, SoTextureCoordinateObject, SoTextureCoordinatePlane, SoTextureCoordinateReflectionMap, SoTextureCoordinateSphere, SoTextureCubeMap, SoTextureMatrixTransform, SoTextureUnit, SoTransform, SoTransformManip, SoTransformSeparator, SoTranslation, SoTransparencyType, SoUnits, SoVertexAttributeBinding, SoVertexProperty, SoVRMLAppearance, SoVRMLBillboard, SoVRMLColor, SoVRMLCoordinate, SoVRMLFontStyle, SoVRMLGroup, SoVRMLImageTexture, SoVRMLInline, SoVRMLLOD, SoVRMLMaterial, SoVRMLNormal, SoVRMLPixelTexture, SoVRMLProximitySensor, SoVRMLScript, SoVRMLShape, SoVRMLSwitch, SoVRMLTextureCoordinate, SoVRMLTextureTransform, SoVRMLTransform, SoVRMLVertexLine, SoVRMLVertexPoint, SoVRMLVertexShape, and SoWWWInline.

🧚 getBoundingBox 🧚

void SoNode::getBoundingBox (SoGetBoundingBoxAction * action) [virtual]

Action method for the SoGetBoundingBoxAction. 🎀

What it does: calculates the bounding box and center coordinates for the node, then modifies the action's values so they encompass the bounding box for this node, and nudges the scene's center point more toward this node's center point. Very main character of it.

Nodes that influence how geometry nodes calculate their bounding box also override this method, so they can change the relevant state variables. ✨

Reimplemented in SoAntiSquish, SoArray, SoBaseKit, SoBlinker, SoCacheHint, SoCallback, SoCamera, SoCenterballDragger, SoClipPlaneManip, SoComplexity, SoCoordinate3, SoCoordinate4, SoDirectionalLightManip, SoDragger, SoFile, SoFont, SoFontStyle, SoGeoCoordinate, SoGeoLocation, SoGeoOrigin, SoGeoSeparator, SoGroup, SoIndexedLineSet, SoIndexedNurbsCurve, SoIndexedPointSet, SoLevelOfDetail, SoLineSet, SoLOD, SoMatrixTransform, SoMultipleCopy, SoNodeKitListPart, SoNurbsCurve, SoPathSwitch, SoPointLightManip, SoPointSet, SoProfile, SoProfileCoordinate2, SoProfileCoordinate3, SoProfilerStats, SoResetTransform, SoRotation, SoRotationXYZ, SoScale, SoSeparator, SoShape, SoShapeHints, SoSpotLightManip, SoSurroundScale, SoSwitch, SoTransform, SoTransformManip, SoTransformSeparator, SoTranslation, SoUnits, SoVertexProperty, SoVRMLBillboard, SoVRMLCoordinate, SoVRMLFontStyle, SoVRMLGroup, SoVRMLIndexedLineSet, SoVRMLInline, SoVRMLLOD, SoVRMLPointSet, SoVRMLProximitySensor, SoVRMLScript, SoVRMLShape, SoVRMLSwitch, SoVRMLTransform, SoVRMLVertexLine, SoVRMLVertexPoint, SoVRMLVertexShape, and SoWWWInline.

💫 getMatrix 💫

void SoNode::getMatrix (SoGetMatrixAction * action) [virtual]

Action method for SoGetMatrixAction. 🦋

It updates the action by accumulating it with the transformation matrix of this node — if this node even has one, that is. (If it doesn't? Then there's nothing to accumulate. Simple as that.)

Reimplemented in SoAntiSquish, SoArray, SoBaseKit, SoBumpMapTransform, SoCallback, SoCenterballDragger, SoClipPlaneManip, SoDirectionalLightManip, SoDragger, SoFile, SoGeoLocation, SoGeoOrigin, SoGeoSeparator, SoGroup, SoMatrixTransform, SoMultipleCopy, SoNodeKitListPart, SoPathSwitch, SoPointLightManip, SoProfilerStats, SoResetTransform, SoRotation, SoRotationXYZ, SoScale, SoSeparator, SoSpotLightManip, SoSurroundScale, SoSwitch, SoTexture2Transform, SoTexture3Transform, SoTextureMatrixTransform, SoTransform, SoTransformManip, SoTransformSeparator, SoTranslation, SoUnits, SoVRMLBillboard, SoVRMLGroup, SoVRMLInline, SoVRMLSwitch, SoVRMLTextureTransform, SoVRMLTransform, and SoWWWInline.

🍓 handleEvent 🍓

void SoNode::handleEvent (SoHandleEventAction * action) [virtual]

Action method for SoHandleEventAction. 👑

Here's the vibe: it inspects the event data coming from action, and if it's something this node should actually react to, it processes it. Otherwise? Not its problem, bestie. 🙈

And heads up — nodes that influence the relevant state variables for how event handling goes down also override this method.

…and the reimplemented-in roll call just keeps going, bestie, it does not stop:

SoArray, SoBaseKit, SoCallback, SoCamera, SoClipPlaneManip, SoDirectionalLightManip, SoDragger, SoEventCallback, SoExtSelection, SoFile, SoGroup, SoLocateHighlight, SoMultipleCopy, SoNodeKitListPart, SoPathSwitch, SoPointLightManip, SoProfilerStats, SoSelection, SoSeparator, SoSpotLightManip, SoSwitch, SoTransformManip, SoVRMLAnchor, SoVRMLDragSensor, SoVRMLInline, SoVRMLScript, SoVRMLSwitch, SoVRMLTimeSensor, SoVRMLTouchSensor, SoWWWAnchor, and SoWWWInline.

Like. That's the whole friend group. 🫶

💅 void SoNode::pick (SoPickAction * action) [virtual]

Action method for SoPickAction — it's the handler that fires when a pick action comes through.

It does the common processing for SoPickAction action instances. The shared legwork, basically. ✨

Reimplemented in SoAntiSquish, SoArray, SoBumpMapCoordinate, SoBumpMapTransform, SoCacheHint, SoCallback, SoClipPlane, SoClipPlaneManip, SoComplexity, SoCoordinate3, SoCoordinate4, SoDirectionalLightManip, SoFile, SoFont, SoFontStyle, SoGeoCoordinate, SoGeoLocation, SoGeoOrigin, SoGroup, SoMaterialBinding, SoMatrixTransform, SoMultipleCopy, SoNodeKitListPart, SoNormal, SoNormalBinding, SoPathSwitch, SoPickStyle, SoPointLightManip, SoProfile, SoProfileCoordinate2, SoProfileCoordinate3, SoProfilerStats, SoResetTransform, SoRotation, SoRotationXYZ, SoScale, SoShapeHints, SoSpotLightManip, SoSurroundScale, SoSwitch, SoTexture2Transform, SoTexture3Transform, SoTextureCombine, SoTextureCoordinate2, SoTextureCoordinate3, SoTextureCoordinateBinding, SoTextureCoordinateCube, SoTextureCoordinateCylinder, SoTextureCoordinateDefault, SoTextureCoordinateEnvironment, SoTextureCoordinateNormalMap, SoTextureCoordinateObject, SoTextureCoordinatePlane, SoTextureCoordinateReflectionMap, SoTextureCoordinateSphere, SoTextureMatrixTransform, SoTextureUnit, SoTransform, SoTransformManip, SoTransformSeparator, SoTranslation, SoUnits, SoVertexAttributeBinding, SoVertexProperty, SoVRMLBillboard, SoVRMLCoordinate, SoVRMLFontStyle, SoVRMLInline, SoVRMLNormal, SoVRMLScript, SoVRMLSwitch, SoVRMLTextureCoordinate, SoVRMLTextureTransform, SoVRMLVertexLine, SoVRMLVertexPoint, SoVRMLVertexShape, and SoWWWInline.

That's a lot of overrides. They all said "not me being the default". 💀

👑 void SoNode::rayPick (SoRayPickAction * action) [virtual]

Action method for SoRayPickAction.

It checks the ray specification of the action and tests for intersection with the data of the node. So like, does the laser beam hit this thing or nah. 🌈

Nodes influencing relevant state variables for how picking is done also overrides this method. iykyk. ✨

Reimplemented in SoBaseKit, SoBumpMap, SoCamera, SoCone, SoCube, SoCylinder, SoDragger, SoGeoSeparator, SoImage, SoIndexedNurbsCurve, SoIndexedNurbsSurface, SoLevelOfDetail, SoLOD, SoNurbsCurve, SoNurbsSurface, SoProfilerStats, SoSceneTexture2, SoSceneTextureCubeMap, SoSeparator, SoShape, SoSphere, SoText2, SoTexture2, SoTextureCubeMap, SoVRMLBox, SoVRMLCone, SoVRMLCylinder, SoVRMLElevationGrid, SoVRMLGroup, SoVRMLImageTexture, SoVRMLLOD, SoVRMLPixelTexture, SoVRMLProximitySensor, SoVRMLShape, SoVRMLSphere, and SoVRMLTransform.

🔍 void SoNode::search (SoSearchAction * action) [virtual]

Action method for SoSearchAction — the "where u at" method.

It compares the search criteria from the action to see if this node is a match. And here's the tea: searching is done by matching up all criteria set up in the SoSearchAction — if any of the requested criteria is a miss, the search is not deemed successful for the node. All or nothing, periodt. 💅

See also

  • SoSearchAction

Reimplemented in SoArray, SoBaseKit, SoCallback, SoClipPlaneManip, SoDirectionalLightManip, SoDragger, SoFile, SoGroup, SoMultipleCopy, SoNodeKitListPart, SoPathSwitch, SoPointLightManip, SoProfilerStats, SoSeparator, SoShaderObject, SoShaderProgram, SoSpotLightManip, SoSwitch, SoTransformManip, SoVRMLAppearance, SoVRMLBillboard, SoVRMLGeometry, SoVRMLGroup, SoVRMLInline, SoVRMLLOD, SoVRMLParent, SoVRMLShape, SoVRMLSwitch, and SoWWWInline.

✍️ void SoNode::write (SoWriteAction * action) [virtual]

Action method for SoWriteAction.

It writes out a node object, and any connected nodes, engines etc, if necessary. So it's the "put it in the file, bestie" method. 🎀

Reimplemented in SoBaseKit, SoBlinker, SoCallback, SoDragger, SoGroup, SoPendulum, SoProfilerStats, SoProto, SoProtoInstance, SoSceneTexture2, SoShuttle, SoSwitch, SoVertexAttribute, SoVertexShape, SoVRMLGroup, SoVRMLLOD, SoVRMLParent, SoVRMLScript, SoVRMLShape, SoVRMLSwitch, and SoVRMLTimeSensor.

🔊 void SoNode::audioRender (SoAudioRenderAction * action) [virtual]

Action method for SoAudioRenderAction.

Does common processing for SoAudioRenderAction action instances. Same energy as pick() — shared legwork, no drama. 🦋

Reimplemented in SoArray, SoCamera, SoFile, SoGroup, SoLevelOfDetail, SoListener, SoLOD, SoMultipleCopy, SoPathSwitch, SoProfilerStats, SoSeparator, SoSwitch, SoTransformSeparator, SoVRMLGroup, SoVRMLLOD, SoVRMLSound, SoVRMLSwitch, SoVRMLTransform, and SoWWWInline.

🔢 void SoNode::getPrimitiveCount (SoGetPrimitiveCountAction * action) [virtual]

Action method for the SoGetPrimitiveCountAction.

It calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action. Counting the little guys. 🔥

Nodes influencing how geometry nodes calculates their primitive count also overrides this method to change the relevant state variables.

Reimplemented in SoArray, SoAsciiText, SoBaseKit, SoCallback, SoCamera, SoComplexity, SoCone, SoCoordinate3, SoCoordinate4, SoCube, SoCylinder, SoDragger, SoFaceSet, SoFile, SoFont, SoFontStyle, SoGeoCoordinate, SoGeoLocation, SoGeoOrigin, SoGeoSeparator, SoGroup, SoImage, SoIndexedFaceSet, SoIndexedLineSet, SoIndexedNurbsCurve, SoIndexedNurbsSurface, SoIndexedPointSet, SoIndexedTriangleStripSet, SoLineSet, SoLOD, SoMarkerSet, SoMaterialBinding, SoMatrixTransform, SoMultipleCopy, SoNodeKitListPart, SoNormal, SoNormalBinding, SoNurbsCurve, SoNurbsSurface, SoPathSwitch, SoPointSet, SoProfile, SoProfileCoordinate2, SoProfileCoordinate3, SoProfilerStats, SoQuadMesh, SoResetTransform, SoRotation, SoRotationXYZ, SoScale, SoSeparator, SoShape, SoSphere, SoSwitch, SoText2, SoText3, SoTransform, SoTransformSeparator, SoTranslation, SoTriangleStripSet, SoUnits, SoVertexAttributeBinding, SoVertexProperty, SoVRMLBox, SoVRMLCone, SoVRMLCylinder, SoVRMLElevationGrid, SoVRMLExtrusion, SoVRMLFontStyle, SoVRMLGroup, SoVRMLIndexedFaceSet, SoVRMLIndexedLineSet, SoVRMLInline, SoVRMLLOD, SoVRMLNormal, SoVRMLParent, SoVRMLShape, SoVRMLSphere, SoVRMLText, SoVRMLTextureCoordinate, SoVRMLTransform, SoVRMLVertexPoint, and SoWWWInline.

🫳 void SoNode::grabEventsSetup (void ) [virtual]

Called from SoHandleEventAction::setGrabber() to notify a node when it becomes the node where all events are sent. You're the main character now, bestie — every event comes to you. 👑

Reimplemented in SoDragger.

🙈 void SoNode::grabEventsCleanup (void ) [virtual]

Called from SoHandleEventAction to notify a node when it looses status as the node where events are sent. The main character arc has ended, no more event mail for you. 😭

Reimplemented in SoDragger.

✨ void SoNode::startNotify (void ) [virtual]

This is the method which starts the notification sequence after changes.

At the end of a notification sequence, all "immediate" sensors (i.e. sensors set up with a zero priority) are triggered.

Reimplemented from SoBase.

📣 void SoNode::notify (SoNotList * l) [virtual]

Notifies all auditors for this instance when changes are made. It's the "hey everyone, something changed" group chat message. 💬

Reimplemented from SoFieldContainer.

Reimplemented in SoAsciiText, SoBlinker, SoBumpMap, SoImage, SoIndexedLineSet, SoIndexedMarkerSet, SoIndexedPointSet, SoLevelOfDetail, SoLOD, SoMaterial, SoNodeEngine, SoPackedColor, SoProfilerStats, SoSceneTexture2, SoSceneTextureCubeMap, SoSeparator, SoShadowGroup, SoShape, SoSwitch, SoText3, SoTexture2, SoTexture3, SoTextureCubeMap, SoVertexAttribute, SoVertexProperty, SoVertexShape, SoVRMLAppearance, SoVRMLBillboard, SoVRMLCollision, SoVRMLElevationGrid, SoVRMLExtrusion, SoVRMLGeometry, SoVRMLGroup, SoVRMLIndexedLine, SoVRMLIndexedLineSet, SoVRMLIndexedShape, SoVRMLLOD, SoVRMLParent, SoVRMLPixelTexture, SoVRMLProximitySensor, SoVRMLScript, SoVRMLShape, SoVRMLSwitch, SoVRMLText, SoVRMLTimeSensor, SoVRMLTouchSensor, SoVRMLTransform, SoVRMLVertexLine, SoVRMLVertexPoint, and SoVRMLVertexShape.

🆔 uint32_t SoNode::getNodeId (void ) const

This returns the node's current unique identification number. It is unlikely that application programmers will ever need use this method fom client application code, unless working with extensions to the core library (and probably not even then). So like… don't worry about it, fr fr. 🙈

The id number is only valid for as long as the node is kept unchanged — upon any kind of change the internal id will be updated (in the notify() method), and the old id number forgotten.

The technique described above plays an important role in the way internal scenegraph caches are set up and invalidated. Lowkey iconic design tbh. 💅

See also

  • SoNode::getNextNodeId()

👶 SoChildList * SoNode::getChildren (void ) const [virtual]

Returns list of children for this node. Here are ur kids. 🫶

Reimplemented in SoBaseKit, SoClipPlaneManip, SoDirectionalLightManip, SoFile, SoGroup, SoNodeKitListPart, SoPointLightManip, SoSpotLightManip, SoTransformManip, SoVRMLAppearance, SoVRMLGeometry, SoVRMLInline, SoVRMLLOD, SoVRMLParent, SoVRMLShape, SoVRMLSwitch, SoVRMLText, and SoWWWInline.

🖨️ void SoNode::writeInstance (SoOutput * out) [virtual]

Writes all the fields contained in this instance to the output stream within out.

This method is solely called from the write methods of fields.

Either from SoField if the write is done because of a field-to-field connection, or from one of the fields which may actually write SoFieldContainer instances, i.e. SoSFNode, SoMFNode, SoSFEngine, SoMFEngine, SoSFPath and SoMFPath.

This method, in addition to the ordinary write() method of SoNode, needs to be present since the fields don't have a write action instance in their writeValue() method, and writeInstance() will create a new SoWriteAction and call continueToApply() on it.

Reimplemented from SoFieldContainer.

Reimplemented in SoNodeEngine.

📚 SoNode * SoNode::addToCopyDict (void ) const [virtual]

Add a copy of this node and (recursively) all children to the copy dictionary of SoFieldContainer if this has not already been done. Recursive besties. 🌀

Used internally during copy operations.

Reimplemented in SoBaseKit.

🫂 void SoNode::copyContents (const SoFieldContainer * from, SbBool copyconnections) [virtual]

Makes a deep copy of all data of from into this instance, except external scenegraph references if copyconnections is FALSE.

This is the protected method that should be overridden by extension node / engine / dragger / whatever subclasses which needs to account for internal data that are not handled automatically. Custom subclasses, this one's for you. 🎀

For copying nodes from application code, you should not invoke this function directly, but rather call the SoNode::copy() function:

SoNode * mynewnode = templatenode->copy();

The same also goes for engines.

okay so before you even think about overriding copyContents() in your extension class, hear me out bestie — you HAVE to make it call upwards to its parent superclass in the inheritance hierarchy. Not optional. Because copyContents() in for instance SoNode and SoFieldContainer does important work and skipping it is giving chaos. It should go something like this:

void
MyCoinExtensionNode::copyContents(const SoFieldContainer * from,
                                  SbBool copyconnections)
{
  // let parent superclasses do their thing (copy fields, copy
  // instance name, etc etc)
  SoNode::copyContents(from, copyconnections);

  // [..then copy internal data..]
}

Reimplemented from SoFieldContainer.

Reimplemented in SoBaseKit, SoCallback, SoClipPlaneManip, SoDirectionalLightManip, SoFile, SoGroup, SoInteractionKit, SoNodeKitListPart, SoPointLightManip, SoRotateCylindricalDragger, SoRotateSphericalDragger, SoSpotLightManip, SoTransformManip, SoVertexAttribute, SoVRMLAppearance, SoVRMLGeometry, SoVRMLLOD, SoVRMLParent, SoVRMLScript, SoVRMLShape, SoVRMLSwitch, and SoWWWInline. 💖

SoFieldContainer * SoNode::copyThroughConnection (void) const [virtual]

Returns a copy of this instance, periodt.

Heads up: the default implementation literally just returns this pointer. SoNode and SoEngine override this method to return the pointer to the actual copy instead.

Reimplemented from SoFieldContainer.

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

Returns the last node that was registered under name. That's the one you get. 🎀

  • See also: SoBase::setName()

int SoNode::getByName (const SbName & name, SoNodeList & l) [static]

Finds all nodes with name and appends them to the l nodelist. Returns the number of nodes with the specified name. So like, how many besties answered the group chat. 💅

  • See also: SoBase::setName()

void SoNode::initClasses (void) [static]

Initialize all the node classes of Coin. The whole roster, getting ready. ✨

uint32_t SoNode::getNextNodeId (void) [static]

Return the next unique identification number to be assigned upon node construction or change. It is unlikely that application programmers will ever need to use this method from client application code — unless you're working with extensions to the core library (and honestly, probably not even then, iykyk). 🙈

  • See also: SoNode::getNodeId

int SoNode::getActionMethodIndex (const SoType type) [static]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. (Translation: not your business, bestie. 💀)

void SoNode::getBoundingBoxS (SoAction * action, SoNode * node) [static]

This is a static "helper" method registered with the action, and used for calling the SoNode::getBoundingBox() virtual method which does the real work. The helper is just the messenger. 🦋

void SoNode::GLRenderS (SoAction * action, SoNode * node) [static]

This is a static "helper" method registered with the action, and used for calling the SoNode::GLRender() virtual method which does the real work.

void SoNode::callbackS (SoAction * action, SoNode * node) [static]

This is a static "helper" method registered with the action, and used for calling the SoNode::callback() virtual method which does the real work.

void SoNode::getMatrixS (SoAction * action, SoNode * node) [static]

This is a static "helper" method registered with the action, and used for calling the SoNode::getMatrix() virtual method which does the real work.

void SoNode::handleEventS (SoAction * action, SoNode * node) [static]

This is a static "helper" method registered with the action, and used for calling the SoNode::handleEvent() virtual method which does the real work.

void SoNode::pickS (SoAction * action, SoNode * node) [static]

This is a static "helper" method registered with the action, and used for calling the SoNode::pick() virtual method which does the real work.

void SoNode::rayPickS (SoAction * action, SoNode * node) [static]

This is a static "helper" method registered with the action, and used for calling the SoNode::rayPick() virtual method which does the real work.

void SoNode::searchS (SoAction * action, SoNode * node) [static]

This is a static "helper" method registered with the action, and used for calling the SoNode::search() virtual method which does the real work.

void SoNode::writeS (SoAction * action, SoNode * node) [static]

This is a static "helper" method registered with the action, and used for calling the SoNode::write() virtual method which does the real work.

void SoNode::audioRenderS (SoAction * action, SoNode * node) [static]

This is a static "helper" method registered with the action, and used for calling the SoNode::audioRender() virtual method which does the real work.

void SoNode::getPrimitiveCountS (SoAction * action, SoNode * node) [static]

This is a static "helper" method registered with the action, and used for calling the SoNode::getPrimitiveCount() virtual method which does the real work.

SbBool SoNode::readInstance (SoInput * in, unsigned short flags) [protected], [virtual]

This method is mainly intended for internal use during file import operations. 🤫

It reads a definition of an instance from the input stream in. The input stream state points to the start of a serialized / persistant representation of an instance of this class type.

TRUE or FALSE is returned, depending on if the instantiation and configuration of the new object of this class type went ok or not. The import process should be robust and handle corrupted input streams by returning FALSE. Be robust, babe.

flags is used internally during binary import when reading user extension nodes, group nodes or engines.

Reimplemented from SoFieldContainer.

Reimplemented in SoBaseKit, SoBumpMap, SoFile, SoGroup, SoImage, SoInteractionKit, SoNodeEngine, SoNodeKitListPart, SoNormalBinding, SoProto, SoProtoInstance, SoSeparator, SoShaderObject, SoTexture2, SoTexture3, SoTextureCoordinateBinding, SoTextureCubeMap, SoVertexAttribute, SoVRMLImageTexture, SoVRMLLOD, SoVRMLParent, SoVRMLPixelTexture, SoVRMLSwitch, and SoWWWInline.

const SoFieldData ** SoNode::getFieldDataPtr (void) [static], [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

void SoNode::setNextActionMethodIndex (int index) [static], [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Only in TGS Inventor on Win32 — to avoid needing to export the nextActionMethodIndex member, see SoNode.h for more info.

int SoNode::getNextActionMethodIndex (void) [static], [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Only in TGS Inventor on Win32 — to avoid needing to export the nextActionMethodIndex member, see SoNode.h for more info.

void SoNode::incNextActionMethodIndex (void) [static], [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Only in TGS Inventor on Win32 — to avoid needing to export the nextActionMethodIndex member, see SoNode.h for more info.

void SoNode::setCompatibilityTypes (const SoType & nodetype, const uint32_t bitmask) [static], [protected]

Set the node compatibility mask for node type nodetype. The mask specifies for which file formats the node is supported. 🗂️

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

  • See also: getCompatibilityMode()
  • Since: Coin 2.0

✨ Member Data Documentation ✨

uint32_t SoNode::uniqueId [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

uint32_t SoNode::nextUniqueId = 1 [static], [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

int SoNode::nextActionMethodIndex = 0 [static], [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

✨ Author ✨

Generated automatically by Doxygen for Coin from the source code. (Not a human, not a bestie, just a doc generator doing its little thing. 🤖💖)

and that's the whole page, bestie — you made it to the end! 🎉 this was SoNode(3) from Coin, Version 3.1.3, so if you're citing it or matching versions, that's the one. go forth and slay your scene graph, mwah 💅👑

📦 where this page comes from