SoSimplifyAction(3)

💖 SoSimplifyAction(3) 💖

okay so bestie, sit down, hydrate, because today we're reading the manual page for SoSimplifyAction, and honestly? she's giving foundation. she's the base class energy, the blueprint of blueprints. no cap. let's get into it 🫶

---

✨ NAME ✨

SoSimplifyAction — the base class for the simplify action classes. that's the whole thing. she's the mom, the template, the "everything else inherits from me" queen. 👑

---

🦋 SYNOPSIS 🦋

Inherits SoAction.

Inherited by SoGlobalSimplifyAction, SoReorganizeAction, and SoShapeSimplifyAction. (yes, three whole children. a whole little family. iconic. 🌸)

👑 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=FALSE)

💫 Public Member Functions inherited from SoAction

virtual ~SoAction (void)
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. that's it. that's the whole description. she said "I am the blueprint" and left. minimal. mysterious. main character energy fr fr.

---

🎀 Constructor & Destructor Documentation 🎀

SoSimplifyAction::SoSimplifyAction (void )

A constructor. (short, sweet, does exactly what it says on the tin 🍓)

SoSimplifyAction::~SoSimplifyAction (void ) [virtual]

The destructor. she's cleaning up after herself, as she should. 💖

---

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

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
}

so like, for application programmers who wanna extend the library with new actions: this method needs to be overridden in all subclasses. no skipping, bestie. 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.

Implements SoAction.

Reimplemented in SoGlobalSimplifyAction, SoReorganizeAction, and SoShapeSimplifyAction.

---

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. (translation: not for you, bestie, it's giving "staff only" 🙈)

---

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 energy, same locked door. 🔒

---

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

Returns a list of the elements used by action instances of this class upon traversal operations.

Reimplemented from SoAction.

Reimplemented in SoGlobalSimplifyAction, SoReorganizeAction, and SoShapeSimplifyAction.

---

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

Applies the action to the scene graph rooted at root.

⚠️ note note note: you should not apply an action to a node with a zero reference count. The behavior in that case is undefined. so don't do it. don't be that girl. 💀

Reimplemented from SoAction.

Reimplemented in SoReorganizeAction.

---

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

Applies the action to the parts of the graph defined by path.

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. like, the path brings its whole entourage. it's a whole look. ✨

If the path ends in an SoGroup node, the action will also traverse the tail node's children.

Reimplemented from SoAction.

Reimplemented in SoReorganizeAction.

---

void SoSimplifyAction::apply (const SoPathList & pathlist, SbBool obeysrules = FALSE) [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):

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

four rules. non-negotiable. the pathlist is on her best behavior or it's not coming in. 👑

See also

SoAction::apply(SoPath * path)

Reimplemented from SoAction.

Reimplemented in SoReorganizeAction.

---

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.

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 it, don't forget to actually call the traversal — that's the whole point, bestie. 😭

Reimplemented from SoAction.

Reimplemented in SoGlobalSimplifyAction, SoReorganizeAction, and SoShapeSimplifyAction.

---

🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code. (not a human wrote this one, it's a robot's whole handwriting 💜)

---

and that's the page, bestie!! this was SoSimplifyAction(3), from Coin, Version 3.1.3 — go forth and simplify, you absolute icon. mwah. 💅✨🎀🦋🌈💖