SoCallback(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

💖 SoCallback(3) — Coin 💖

okay bestie, welcome to SoCallback(3) from Coin. this is literally the node type that lets you set callback hooks in the scene graph, and it's giving main character energy. no cap. let's get into it. 💅

✨ NAME ✨

SoCallback — the SoCallback class is a node type which provides a means of setting callback hooks in the scene graph. 🦋

🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoCallback.h>

Inherits SoNode.

💖 Public Member Functions 💖

  • virtual SoType getTypeId (void) const
  • SoCallback (void)
  • void setCallback (SoCallbackCB *function, void *userdata=NULL)
  • virtual void doAction (SoAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • virtual void getMatrix (SoGetMatrixAction *action)
  • virtual void handleEvent (SoHandleEventAction *action)
  • virtual void pick (SoPickAction *action)
  • virtual void search (SoSearchAction *action)
  • virtual void write (SoWriteAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)

💜 Public Member Functions inherited from SoNode 💜

  • 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 GLRenderBelowPath (SoGLRenderAction *action)
  • virtual void GLRenderInPath (SoGLRenderAction *action)
  • virtual void GLRenderOffPath (SoGLRenderAction *action)
  • virtual void rayPick (SoRayPickAction *action)
  • virtual void audioRender (SoAudioRenderAction *action)
  • virtual void grabEventsSetup (void)
  • virtual void grabEventsCleanup (void)
  • virtual void startNotify (void)
  • virtual void notify (SoNotList *l)
  • SbUniqueId getNodeId (void) const
  • virtual SoChildList * getChildren (void) const
  • virtual void writeInstance (SoOutput *out)
  • virtual SoNode * addToCopyDict (void) const
  • 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 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)
  • SbBool isOfType (SoType type) const — Returns TRUE if the type of this object is either of the same type or inherited from type.
  • 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 SoType getClassTypeId (void)
  • static void initClass (void) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

🌟 Static Public Member Functions inherited from SoNode 🌟

  • 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) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static void initClasses (void)
  • static SbUniqueId 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) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static SoType getClassTypeId (void) — This static method returns the SoType object associated with objects of this class.
  • 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) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static SoType getClassTypeId (void) — This static method returns the SoType object associated with objects of this class.
  • 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 💅

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoCallback ()
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)

🎀 Protected Member Functions inherited from SoNode 🎀

  • 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
  • virtual SoNotRec createNotRec (void)

🌸 Static Protected Member Functions 🌸

  • static const SoFieldData ** getFieldDataPtr (void)

💜 Static Protected Member Functions inherited from SoNode 💜

  • 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)

✨ Additional Inherited Members ✨

🌈 Public Types inherited from SoNode

  • 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, COIN_4_0 = 0x20000 }

🦋 Protected Types inherited from SoBase

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

🌟 Protected Attributes inherited from SoNode

  • SbUniqueId uniqueId

🍓 Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

🧚 Static Protected Attributes inherited from SoNode

  • static SbUniqueId nextUniqueId = 1
  • static int nextActionMethodIndex = 0

💖 Detailed Description 💖

The SoCallback class is a node type which provides a means of setting callback hooks in the scene graph. 👑

By inserting SoCallback nodes in a scene graph, the application programmer can set up functions to be executed at certain points in the traversal. ✨

The callback function will be executed during traversal of any action, so check the type of the action argument of the callback function if you only want to run your code at specific actions. 💅

FILE FORMAT/DEFAULTS:

Callback {
}

🎀 Constructor & Destructor Documentation 🎀

💖 SoCallback::SoCallback (void ) 💖

Constructor.

💀 SoCallback::~SoCallback () [protected], [virtual] 💀

Destructor.

✨ Member Function Documentation ✨

Okay bestie, this is the part where we go method by method through SoCallback. Every single one, no skips, no cap. Let's get into it. 💅

SoType SoCallback::getClassTypeId (void ) [static]

This static method literally just returns the SoType object associated with objects of this class. That's it. That's the whole vibe. ✨

SoType SoCallback::getTypeId (void ) const [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is what the runtime uses for type checking and for "downward" casting — you know, when you're like "okay but what are you actually?" 😭

Implements SoBase.

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

Okay so this API member is considered internal to the library — it's not likely to be of interest to the application programmer. So if you're just out here writing app code, you can lowkey ignore it. 🙈

Returns the SoFieldData class which holds information about fields in this node.

const SoFieldData * SoCallback::getFieldData (void ) const [protected], [virtual]

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL. That's the whole thing. 🎀

Reimplemented from SoFieldContainer.

void SoCallback::setCallback (SoCallbackCB * function, void * userdata = NULL)

Set up the function to call at traversal of this node. userdata will be passed back as the first argument of the callback function. Setting function to NULL removes the previously set callback function. Simple as that. 💖

If you want a callback only for a specific action, you must — in your callback function — remember to check which action invoked the callback, for instance like this:

void mycallback(void * userdata, SoAction * action)
{
  if (action->isOfType(SoGLRenderAction::getClassTypeId())) {
    // do stuff specific for GL rendering here.
  }
}
Please note that SoCallback nodes under a Separator might be included in a cache. Cached nodes are not traversed, and you'll not receive any callbacks. 😱

If you want to make sure that your callback is called every time the scene graph is rendered, you must invalidate the render cache in your callback:

void mycallback(void * userdata, SoAction * action)
{
  if (action->isOfType(SoGLRenderAction::getClassTypeId())) {
    SoCacheElement::invalidate(action->getState());
  }
}

If you want to invalidate all caches (for instance also the bounding box cache), you can do this in your callback:

void mycallback(void * userdata, SoAction * action)
{
  SoState * state = action->getState();
  if (state->isElementEnabled(SoCacheElement::getClassStackIndex())) {
    SoCacheElement::invalidate(state);
  }
}

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

This function performs the typical operation of a node for any action. It's giving "default behavior, but make it universal." 🌈

Reimplemented from SoNode.

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

Action method for SoCallbackAction. Simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph. Basically it's like "hey, here's what this node looks like for this action." 🦋

Reimplemented from SoNode.

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

Action method for the SoGLRenderAction. This is called during rendering traversals. Nodes influencing the rendering state in any way — or that want to throw geometry primitives at OpenGL — override this method. So if you're doing GL things, this is your moment. 🔥

Reimplemented from SoNode.

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

Action method for the SoGetBoundingBoxAction. Calculates bounding box and center coordinates for node and modifies the values of the action to encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node. It's literally adjusting the action's vibe to include this node's box. 📦✨

Nodes influencing how geometry nodes calculate their bounding box also override this method to change the relevant state variables.

Reimplemented from SoNode.

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

Action method for SoGetMatrixAction. Updates action by accumulating with the transformation matrix of this node (if any). If there's a matrix, it gets multiplied in. Periodt. 💅

Reimplemented from SoNode.

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

Action method for SoHandleEventAction. Inspects the event data from action, and processes it if it is something which this node should react to. So like, if the event is for you, you handle it. If not, you don't. 😌

Nodes influencing relevant state variables for how event handling is done also override this method.

Reimplemented from SoNode.

void SoCallback::pick (SoPickAction * action) [virtual]

Action method for SoPickAction. Does common processing for SoPickAction action instances. Just the usual pick-me-up. 🎀

Reimplemented from SoNode.

void SoCallback::search (SoSearchAction * action) [virtual]

Action method for SoSearchAction. Compares the search criteria from the action to see if this node is a match. 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. So it's all-or-nothing, bestie. No partial credit. 😤

See also SoSearchAction.

Reimplemented from SoNode.

void SoCallback::write (SoWriteAction * action) [virtual]

Action method for SoWriteAction. Writes out a node object, and any connected nodes, engines etc, if necessary. It's the "put it in writing" of scene graph traversal. 📝

Reimplemented from SoNode.

void SoCallback::getPrimitiveCount (SoGetPrimitiveCountAction * action) [virtual]

Action method for the SoGetPrimitiveCountAction. Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action. Math but make it geometry. 🔢

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

Reimplemented from SoNode.

void SoCallback::copyContents (const SoFieldContainer * from, SbBool copyconnections) [protected], [virtual]

Makes a deep copy of all data of from into this instance, except external scene graph references if copyconnections is FALSE. So like, it copies everything except the external links when you say no to connections. 🫶

This is the method that should be overridden by extension node / engine / dragger / whatever subclasses which need to account for internal data that are not handled automatically.

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.

Make sure that when you override the copyContents() method in your extension class that you also make it call upwards to its parent superclass in the inheritance hierarchy, as copyContents() in for instance SoNode and SoFieldContainer does important work. 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.)
  SoNode::copyContents(from, copyconnections);

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

Reimplemented from SoNode.

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. No human author, just robot magic. 🤖✨

That's the whole page, bestie. This manual page was generated automatically by Doxygen for Coin from the source code — Version 4.0.10, dated Thu Jun 25 2026 00:00:00. SoCallback(3) out. Stay iconic. 💖🌈🦋

📦 where this page comes from