SoAnnotation(3)

📦 version 2.5.0, in fedora 43, fedora 44

💅 SoAnnotation — the manual page, but make it cute

okay bestie, this is SoAnnotation(3) from the Library Functions Manual, and it's a two-parter so don't go anywhere 🎀✨

👑 NAME 👑

SoAnnotation — the node that draws all its child geometry right on top of other geometry. like, it simply refuses to be behind anybody. main character energy, fr fr. 💅

🦋 SYNOPSIS 🦋

#include <Inventor/nodes/SoAnnotation.h>

It Inherits SoSeparator — so at heart it's a separator girlie, just with a little extra something ✨

🌸 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

⭐ 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=0) const
  • virtual void grabEventsSetup (void)
  • virtual void grabEventsCleanup (void)
  • virtual void startNotify (void)
  • uint32_t 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=0)
  • 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 *in)
  • void get (SbString &fielddata, SoOutput *out)
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval)
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)
  • SbBool getIsBuiltIn (void) 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
  • 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)

💖 Static Public Member Functions inherited from SoSeparator 💖

  • static SoType getClassTypeId (void)
  • static void initClass (void)
  • 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)

💖 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)
  • 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 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 *in, SoBase *&base, SoType expectedtype)
  • static void setInstancePrefix (const SbString &c)
  • static void setTraceRefs (SbBool trace)
  • static SbBool getTraceRefs (void)
  • static SbBool connectRoute (SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
  • static SbBool readRoute (SoInput *in)

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

🌸 Protected Member Functions inherited from SoNode 🌸

  • SoNode (void)
  • virtual ~SoNode ()

🌸 Protected Member Functions inherited from SoFieldContainer 🌸

  • SoFieldContainer (void)
  • ~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 🌟

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

🌟 Public Attributes inherited from SoSeparator 🌟

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

  • uint32_t uniqueId

🌟 Protected Attributes inherited from SoFieldContainer 🌟

  • SbBool isBuiltIn

🌟 Static Protected Attributes inherited from SoNode 🌟

  • static uint32_t nextUniqueId = 0
  • static int nextActionMethodIndex = 0

🔥 Detailed Description 🔥

okay so the whole thing: SoAnnotation draws all its child geometry on top of other geometry. periodt.

This group-type node uses delayed rendering in combination with Z-buffer disabling to let its children transparently render their geometry on top of the other geometry in the scene. it's giving "I'm the overlay, you're the background" 💅

⚠️ bestie, listen: since the Z-buffer needs to be disabled, the childrens' geometry will not be rendered back-to-front sorted. instead it's rendered in the order they are present in the scenegraph. so order actually matters here, no cap. 😭

FILE FORMAT/DEFAULTS:

Annotation {
    renderCaching AUTO
    boundingBoxCaching AUTO
    renderCulling AUTO
    pickCulling AUTO
}

Constructor & Destructor Documentation 🧚

SoAnnotation::SoAnnotation (void ) ✨

Okay bestie, this is the constructor. It's literally the birth of the object — new instance, who dis? 💅

  • References: SoAnnotation().
  • Referenced by: getFieldData(), and SoAnnotation().

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

Destructor. The cleanup era. It's giving goodbye, but make it protected and virtual. No cap. 🫶

Member Function Documentation 🔥

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

This returns the type identification of an object derived from a class inheriting SoBase. It's used for run-time type checking and "downward" casting. Periodt. 🎀

Usage example:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
  else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
    SoGroup * group = (SoGroup *)node;  // safe downward cast, knows the type
  }
}

For application programmers who want to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

  • Reimplemented from: SoSeparator.

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. So if there's nothing there, you get NULL, okay? 🙈

  • Reimplemented from: SoSeparator.
  • References: SoAnnotation().

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

Action method for the SoGLRenderAction.

This gets called during rendering traversals. If a node influences the rendering state in any way, or if it wants to throw geometry primitives at OpenGL, it overrides this method. Slay.

  • Reimplemented from: SoSeparator.
  • References: SoAction::getCurPathCode(), GLRenderBelowPath(), and GLRenderInPath().

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. Iykyk.

SoSeparator::GLRenderBelowPath() do not traverse its children using SoChildList::traverse(), but calls GLRenderBelowPath() directly for all its children. That's the whole vibe.

  • Reimplemented from: SoSeparator.
  • References: SoGLRenderAction::addDelayedPath(), SoPath::copy(), SoAction::getCurPath(), SoAction::getState(), SoSeparator::GLRenderBelowPath(), and SoGLRenderAction::isRenderingDelayedPaths().
  • Referenced by: GLRender().

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

Implements the SoAction::IN_PATH traversal method for the rendering action. Yes bestie, IN_PATH. 💅

  • Reimplemented from: SoSeparator.
  • References: SoGLRenderAction::addDelayedPath(), SoPath::copy(), SoAction::getCurPath(), SoAction::getState(), SoSeparator::GLRenderInPath(), and SoGLRenderAction::isRenderingDelayedPaths().
  • Referenced by: GLRender().

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

Implements the SoAction::OFF_PATH traversal method for the rendering action. It's giving OFF_PATH era. 🌈

  • Reimplemented from: SoSeparator.

Author 👑

Generated automatically by Doxygen for Coin from the source code. So you know it's official. 👑

That's the whole page, bestie. This manual page is from Coin — Version 2.5.0 — and it's SoAnnotation(3). Stay iconic. 💖✨

📦 where this page comes from