SoSimplifyAction(3)

💖 NAME 💖

okay so bestie, meet SoSimplifyAction — she is the base class for the simplify action classes. that's the whole job description, she's the blueprint the other simplify actions are built on 💅✨

---

🦋 SYNOPSIS 🦋

Inherits SoAction.

Inherited by SoReorganizeAction.

👑 Public Member Functions

• virtual SoType getTypeId (void) const
• SoSimplifyAction (void)
• virtual ~SoSimplifyAction (void)
• virtual void apply (SoNode *root)
• virtual void apply (SoPath *path)
• virtual void apply (const SoPathList &pathlist, SbBool obeysrules=0)

🌸 Public Member Functions inherited from SoAction

• virtual ~SoAction ()
• virtual SbBool isOfType (SoType type) const
• 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 (void)

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

The SoSimplifyAction class is the base class for the simplify action classes. she's the blueprint, the blueprint-iest 💖

Since

Coin 2.5 — yeah she's been around, an icon from the jump 🎀

---

🎀 Constructor & Destructor Documentation 🎀

SoSimplifyAction::SoSimplifyAction (void )

A constructor. that's her, that's the girl 💅

Referenced by SoReorganizeAction::addMethod(), and addMethod().

SoSimplifyAction::~SoSimplifyAction (void ) [virtual]

The destructor. she says bye gorgeously, no mess left behind 🦋

---

🔥 Member Function Documentation 🔥

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

Returns the type identification of an action derived from a class inheriting SoAction. This is used for run-time type checking and "downward" casting. run-time type checking bestie, the vibe check for C++ classes ✨

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. yes you literally have to override it in every subclass, no skipping, that's the rule 📋

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.

Implements SoAction.

Reimplemented in SoReorganizeAction.

void SoSimplifyAction::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. ngl she's giving "you're not supposed to be here" energy, but she's listed anyway so here you go 🫶

References SoAction::SoAction(), and SoSimplifyAction().

void SoSimplifyAction::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 deal, internal, move along bestie 💫

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

Returns a list of the elements used by action instances of this class upon traversal operations. the whole roster of elements she brings to the traversal party 🎉

Reimplemented from SoAction.

Reimplemented in SoReorganizeAction.

void SoSimplifyAction::apply (SoNode * root) [virtual]

Applies the action to the scene graph rooted at root. go do the thing at that root node 🌳

Note that you should not apply an action to a node with a zero reference count. The behavior in that case is undefined. fr fr, do not do it, that's undefined behavior and we do not play with undefined behavior 💀

Reimplemented from SoAction.

Reimplemented in SoReorganizeAction.

References SoAction::apply().

void SoSimplifyAction::apply (SoPath * path) [virtual]

Applies the action to the parts of the graph defined by path. just the slice of graph that path points at, not the whole buffet 💅

Note that an SoPath will also contain all nodes that may influence e.g. geometry nodes in the path. So for instance applying an SoGLRenderAction on an SoPath will render that path as expected in the view, where geometry will get its materials, textures, and other appearance settings correctly. so the path pulls in all the influencer nodes too, and everything renders with the right fit ✨

If the path ends in an SoGroup node, the action will also traverse the tail node's children. yes she goes deeper if there's a group at the end 👑

Reimplemented from SoAction.

Reimplemented in SoReorganizeAction.

References SoAction::apply().

void SoSimplifyAction::apply (const SoPathList & pathlist, SbBool obeysrules = 0) [virtual]

Applies action to the graphs defined by pathlist. If obeysrules is set to TRUE, pathlist must obey the following four conditions (which is the case for path lists returned from search actions for non-group nodes and path lists returned from picking actions):

1. All paths must start at the same head node.
2. All paths must be sorted in traversal order.
3. The paths must be unique.
4. No path can continue through the end point of another path.

that's four conditions, all four, she is not flexible about this 🎯

See also

SoAction::apply(SoPath * path)

Reimplemented from SoAction.

Reimplemented in SoReorganizeAction.

References SoAction::apply().

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

This virtual method is called from SoAction::apply(), and is the entry point for the actual scenegraph traversal. the doors open, the traversal begins 🚪✨

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. so if you override her, you still gotta call traverse() or SoAction::beginTraversal(), otherwise the traversal literally does not happen, and that's the tea ☕

Reimplemented from SoAction.

Reimplemented in SoReorganizeAction.

References SoAction::beginTraversal().

---

⭐ Author ⭐

Generated automatically by Doxygen for Coin from the source code. not a human, just Doxygen doing its little automatic thing 🤖💖

---

and that's the whole page bestie!! this one is from Coin, Version 2.5.0, and it goes by SoSimplifyAction(3) — she's an oldie but a goodie, mwah 💋✨