SoAnnotation(3)

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

💖 SoAnnotation(3) — Coin 💖

Okay bestie, welcome to SoAnnotation(3) from Coin. This node is giving “draw my children on top of everything else” and honestly? Iconic. Let’s get into it. 🫶

🎀 NAME 🎀

SoAnnotation — the node that draws all its child geometry on top of other geometry. Periodt. 💅

🌈 SYNOPSIS 🌈

#include <Inventor/nodes/SoAnnotation.h>

Inherits SoSeparator. Slay. 👑

🌟 Public Member Functions 🌟

  • virtual SoType getTypeId (void) const — 💅
  • SoAnnotation (void) — ✨
  • virtual void GLRender (SoGLRenderAction *action) — 🔥
  • virtual void GLRenderBelowPath (SoGLRenderAction *action) — 🌸
  • virtual void GLRenderInPath (SoGLRenderAction *action) — 🦋
  • virtual void GLRenderOffPath (SoGLRenderAction *action) — 💜

✨ Public Member Functions inherited from SoSeparator ✨

  • SoSeparator (void) — 💖
  • SoSeparator (const int nchildren) — 🎀
  • virtual void doAction (SoAction *action) — 🌟
  • virtual void callback (SoCallbackAction *action) — 💅
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — 📦
  • virtual void getMatrix (SoGetMatrixAction *action) — 🧮
  • virtual void handleEvent (SoHandleEventAction *action) — 🎟️
  • virtual void rayPick (SoRayPickAction *action) — 🔦
  • virtual void search (SoSearchAction *action) — 🔍
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — 🔢
  • virtual void audioRender (SoAudioRenderAction *action) — 🔊
  • virtual void notify (SoNotList *nl) — 📣
  • virtual SbBool affectsState (void) const — 🧠

🦋 Public Member Functions inherited from SoGroup 🦋

  • SoGroup (void) — 💖
  • SoGroup (int nchildren) — 🎀
  • virtual void addChild (SoNode *node) — 🌱
  • virtual void insertChild (SoNode *child, int newchildindex) — 🧩
  • virtual SoNode * getChild (int index) const — 👶
  • virtual int findChild (const SoNode *node) const — 🔎
  • virtual int getNumChildren (void) const — 🔢
  • virtual void removeChild (int childindex) — 🗑️
  • virtual void removeChild (SoNode *child) — 🗑️
  • virtual void removeAllChildren (void) — 💥
  • virtual void replaceChild (int index, SoNode *newchild) — 🔄
  • virtual void replaceChild (SoNode *oldchild, SoNode *newchild) — 🔄
  • virtual void pick (SoPickAction *action) — 🎯
  • virtual void write (SoWriteAction *action) — ✍️
  • virtual SoChildList * getChildren (void) const — 📜
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE) — 🧾

🌸 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 void grabEventsSetup (void) — ✋
  • virtual void grabEventsCleanup (void) — 🧹
  • virtual void startNotify (void) — 🔔
  • SbUniqueId getNodeId (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) — ✅
  • 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 SoSeparator ✨

  • 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 void setNumRenderCaches (const int howmany) — 🗂️
  • static int getNumRenderCaches (void) — 🗂️

🦋 Static Public Member Functions inherited from SoGroup 🦋

  • 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 ~SoAnnotation () — 💀

🔒 Protected Member Functions inherited from SoSeparator 🔒

  • virtual ~SoSeparator () — 💀
  • virtual SbBool cullTest (SoState *state) — 🚫
  • virtual SbBool cullTest (SoGLRenderAction *action, int &cullresults) — 🚫
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) — 📖

🔒 Protected Member Functions inherited from SoGroup 🔒

  • virtual ~SoGroup () — 💀
  • virtual SbBool readChildren (SoInput *in) — 📖
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections) — 📋
  • virtual SoNotRec createNotRec (void) — 📝
  • void setOperation (const SoNotRec::OperationType opType=SoNotRec::UNSPECIFIED, const SoNode *cc=NULL, const SoNode *pc=NULL, const int ci=-1) — ⚙️

🔒 Protected Member Functions inherited from SoNode 🔒

  • SoNode (void) — ✨
  • virtual ~SoNode () — 💀

🔒 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 Protected Member Functions inherited from SoSeparator 🛡️

  • static const SoFieldData ** getFieldDataPtr (void) — 📋

🛡️ Static Protected Member Functions inherited from SoGroup 🛡️

  • 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 SoSeparator 🌸

  • enum CacheEnabled { OFF, ON, AUTO } — 💅

✨ Public Types inherited from SoNode ✨

okay so SoNode handed down this whole enum of vibe-era flags, and every single one is lowkey a time capsule of a different 3D file format era 💫

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 }

🌸 Public Attributes inherited from SoSeparator 🌸

these four walked so every separator could run, bestie 🫶

  • SoSFEnum renderCaching
  • SoSFEnum boundingBoxCaching
  • SoSFEnum renderCulling
  • SoSFEnum pickCulling

🔒 Protected Types inherited from SoBase 🔒

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

🎀 Protected Attributes inherited from SoGroup 🎀

  • SoChildList * children

💅 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 📖

okay so here's the whole point of SoAnnotation, and it's iconic honestly:

The SoAnnotation node draws all its child geometry on top of other geometry.

fr fr. this group-type node does the thing where it uses delayed rendering plus z-buffer disabling so its children can transparently render their geometry on top of everything else in the scene. main character energy, no cap 👑

but — and this is the part you gotta hear, bestie — because the z-buffer has to be disabled, the children's geometry will not be rendered back-to-front sorted. it just goes in the order they show up in the scene graph. so like, the order you wrote them in is the order. that's the whole vibe. 🌈

🗂️ FILE FORMAT/DEFAULTS: 🗂️

Annotation {
    renderCaching AUTO
    boundingBoxCaching AUTO
    renderCulling AUTO
    pickCulling AUTO
}

🔨 Constructor & Destructor Documentation 🔨

SoAnnotation::SoAnnotation (void )

Constructor. it makes the thing. slay ✨

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

Destructor. it un-makes the thing. it's protected, so don't come for it unless you're family 💀

🧚 Member Function Documentation 🧚

SoType SoAnnotation::getClassTypeId (void ) [static]

This static method returns the SoType object associated with objects of this class.

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

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting.

Reimplemented from SoSeparator.

const SoFieldData ** SoAnnotation::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.

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

const SoFieldData * SoAnnotation::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.

Reimplemented from SoSeparator.

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

Action method for the SoGLRenderAction.

This is called during rendering traversals. Nodes influencing the rendering state in any way or want to throw geometry primitives at OpenGL override this method.

Reimplemented from SoSeparator.

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

SGI Open Inventor v2.1 obsoleted support for SoGLRenderAction::addMethod(). Instead, GLRender() might be called directly, and to optimize traversal, the SoSeparator node calls GLRenderBelowPath whenever the path code is BELOW_PATH or NO_PATH (path code is guaranteed not to change). To be compatible with SGI's Inventor (and thereby also TGS') we have chosen to follow their implementation in this respect.

SoSeparator::GLRenderBelowPath() does not traverse its children using SoChildList::traverse(), but calls GLRenderBelowPath() directly for all its children.

Reimplemented from SoSeparator.

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

Implements the SoAction::IN_PATH traversal method for the rendering action.

Reimplemented from SoSeparator.

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

Implements the SoAction::OFF_PATH traversal method for the rendering action.

Reimplemented from SoSeparator.

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code.

okay bestie that's the whole page, we ate and left zero crumbs 💅 this one came from the Coin docs, version 4.0.10, stamped Thu Jun 25 2026 00:00:00, and it lives at SoAnnotation(3). go forth and annotate, you gorgeous genius 🎀✨🦋

📦 where this page comes from