SoAudioRenderAction(3)

✨ NAME ✨

SoAudioRenderAction — the class that renders the aural parts of the scene graph. yes bestie, we're doing SOUND. 🎧🔊

---

🎀 SYNOPSIS 🎀

#include <Inventor/actions/SoAudioRenderAction.h>

Inherits SoAction.

💅 Public Member Functions

• virtual SoType getTypeId (void) const

💜 Public Member Functions inherited from SoAction

• virtual ~SoAction ()
• virtual SbBool isOfType (SoType type) const
• virtual void apply (SoNode *root)
• virtual void apply (SoPath *path)
• virtual void apply (const SoPathList &pathlist, SbBool obeysrules=0)
• void apply (SoAction *beingApplied)
• virtual void invalidateState (void)
• AppliedCode getWhatAppliedTo (void) const
• SoNode * getNodeAppliedTo (void) const
• SoPath * getPathAppliedTo (void) const
• const SoPathList * getPathListAppliedTo (void) const
• const SoPathList * getOriginalPathListAppliedTo (void) const
• SbBool isLastPathListAppliedTo (void) const
• PathCode getPathCode (int &numindices, const int *&indices)
• void traverse (SoNode *const node)
• SbBool hasTerminated (void) const
• const SoPath * getCurPath (void)
• SoState * getState (void) const
• PathCode getCurPathCode (void) const
• virtual SoNode * getCurPathTail (void)
• void usePathCode (int &numindices, const int *&indices)
• void pushCurPath (const int childindex, SoNode *node=NULL)
• void popCurPath (const PathCode prevpathcode)
• void pushCurPath (void)
• void popPushCurPath (const int childindex, SoNode *node=NULL)
• void popCurPath (void)
• void switchToPathTraversal (SoPath *path)
• void switchToNodeTraversal (SoNode *node)

🌸 Static Public Member Functions

• static SoType getClassTypeId (void)
• static void addMethod (const SoType type, SoActionMethod method)
• static void enableElement (const SoType type, const int stackindex)
• static void initClass ()
• static void callDoAction (SoAction *action, SoNode *node)
• static void callAudioRender (SoAction *action, SoNode *node)

🦋 Static Public Member Functions inherited from SoAction

• static void initClass (void)
• static void initClasses (void)
• static SoType getClassTypeId (void)
• static void nullAction (SoAction *action, SoNode *node)

🧚 Protected Member Functions

• virtual const SoEnabledElementsList & getEnabledElements (void) const
• virtual void beginTraversal (SoNode *node)

🍓 Protected Member Functions inherited from SoAction

• SoAction (void)
• virtual void endTraversal (SoNode *node)
• void setTerminated (const SbBool flag)
• virtual SbBool shouldCompactPathList (void) const

⭐ Static Protected Member Functions

• static SoEnabledElementsList * getClassEnabledElements (void)
• static SoActionMethodList * getClassActionMethods (void)

🌈 Static Protected Member Functions inherited from SoAction

• static SoEnabledElementsList * getClassEnabledElements (void)
• static SoActionMethodList * getClassActionMethods (void)

👑 Additional Inherited Members

Public Types inherited from SoAction

• enum AppliedCode { NODE = 0, PATH = 1, PATH_LIST = 2 }
• enum PathCode { NO_PATH = 0, IN_PATH = 1, BELOW_PATH = 2, OFF_PATH = 3 }

Protected Attributes inherited from SoAction

• SoState * state
• SoActionMethodList * traversalMethods

---

💖 Detailed Description 💖

SoAudioRenderAction is the class that renders the aural parts of the scene graph. it's the ears of the operation, fr fr. 👂

so when you apply this method at a root node for a scene graph, a path, or a pathlist, it will render all the sound-related nodes hanging out inside that instance, straight to the current SoAudioDevice. no cap. 🎶

---

🔥 Member Function Documentation 🔥

💜 SoType SoAudioRenderAction::getTypeId (void ) const [virtual]

Returns the type identification of an action derived from a class inheriting SoAction. it's used for run-time type checking and "downward" casting, iykyk. 🪪

Usage example:

void bar(SoAction * action)
{
  if (action->getTypeId() == SoGLRenderAction::getClassTypeId()) {
    // safe downward cast, know the type
    SoGLRenderAction * glrender = (SoGLRenderAction *)action;
  }
  return; // ignore if not renderaction
}

For application programmers wanting to extend the library with new actions: 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 Inventor/nodes/SoSubAction.h: SO_ACTION_SOURCE, SO_ACTION_INIT_CLASS and SO_ACTION_CONSTRUCTOR. 📝

For more information on writing Coin extensions, see the SoAction class documentation.

Returns the actual type id of an object derived from a class inheriting SoAction. Needs to be overridden in all subclasses. like, mandatory bestie, not optional. 💅

Implements SoAction.

🎀 void SoAudioRenderAction::addMethod (const SoType type, SoActionMethod method) [static]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. 🙈 (it's giving "staff only", you probably don't need it.)

References SoAction::SoAction().

Referenced by SoNodeKitListPart::initClass().

🌸 void SoAudioRenderAction::enableElement (const SoType type, const int stackindex) [static]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. 💀 same energy as above, it's an internal thing.

🦋 const SoEnabledElementsList & SoAudioRenderAction::getEnabledElements (void ) const [protected], [virtual]

Returns a list of the elements used by action instances of this class upon traversal operations. it's the receipts of what this action touches. 🧾✨

Reimplemented from SoAction.

🧚 void SoAudioRenderAction::beginTraversal (SoNode * node) [protected], [virtual]

This virtual method is called from SoAction::apply(), and is the entry point for the actual scenegraph traversal. main character entrance, honestly. 🚪✨

It can be overridden to initialize the action at traversal start, for specific initializations in the action subclasses inheriting SoAction.

Default method just calls traverse(), which any overridden implementation of the method must do too (or call SoAction::beginTraversal()) to trigger the scenegraph traversal. do NOT forget this part or nothing will traverse, periodt.

Reimplemented from SoAction.

References SoAction::traverse().

---

🌈 Author 🌈

Generated automatically by Doxygen for Coin from the source code. 🤖 (yes, the docs wrote themselves, iconic behaviour)

---

okay and that's the whole page, bestie — this was SoAudioRenderAction(3) from Coin, Version 2.5.0, dated with love and delivered straight to your terminal. go render some aural scene graph parts, you absolute icon 🫶💖🎧