SoSimplifyAction(3)

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

💖 SoSimplifyAction — the Coin manual, but make it make sense 💖

okay bestie, we're in the Coin section of the manual (3), and today's main character is SoSimplifyAction. she's the base class energy that all the simplify action classes inherit from. no cap.

✨ NAME ✨

SoSimplifyAction — the base class for the simplify action classes. she's giving foundation, she's giving blueprint, and honestly? the other simplify actions could never without her. 💅

✨ SYNOPSIS ✨

#include <Inventor/actions/SoSimplifyAction.h>

Inherits SoAction.

Inherited by SoGlobalSimplifyAction, SoReorganizeAction, and SoShapeSimplifyAction.

🌸 Public Member Functions 🌸

  • virtual SoType getTypeId(void) const — the type ID getter, virtual edition
  • SoSimplifyAction(void) — constructor
  • virtual ~SoSimplifyAction(void) — destructor
  • virtual void apply(SoNode *root) — apply to a node
  • virtual void apply(SoPath *path) — apply to a path
  • virtual void apply(const SoPathList &pathlist, SbBool obeysrules=FALSE) — apply to a whole path list

🦋 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. periodt. that's the whole vibe — she's the mom, the others are the daughters. 👑

🛠️ Constructor & Destructor Documentation 🛠️

SoSimplifyAction::SoSimplifyAction(void)

A constructor. literally just vibing into existence. ✨

SoSimplifyAction::~SoSimplifyAction(void) [virtual]

The destructor. she said bye bestie, clean up after yourself. 💅

🧚 Member Function Documentation 🧚

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

Returns the type identification of an object derived from a class inheriting SoAction. This is used for runtime type checking and "downward" casting. iykyk — it's the ✨who-am-I-really✨ check.

Implements SoAction.

Reimplemented in SoGlobalSimplifyAction, SoReorganizeAction, and SoShapeSimplifyAction.

SoType SoSimplifyAction::getClassTypeId(void) [static]

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

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. aka: not for you, bestie, it's giving backstage pass 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 as above — internal business, don't touch. 💀

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

Returns list of enabled elements.

Reimplemented from SoAction.

Reimplemented in SoGlobalSimplifyAction, SoReorganizeAction, and SoShapeSimplifyAction.

SoEnabledElementsList * SoSimplifyAction::getClassEnabledElements(void) [static], [protected]

Returns list of enabled elements for this class. The enabledElements and methods variables are protected in the original OIV API. This is not such a good idea, since exposed static class member variables is a major grievance with regard to Win32 DLLs. This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

so basically: the original OIV API had these as protected statics and that was messy for Win32 DLLs. Coin said "not me doing that" and made this extension instead. it's Coin-only, no cap.

SoActionMethodList * SoSimplifyAction::getClassActionMethods(void) [static], [protected]

Returns list of action methods for this class. The enabledElements and methods variables are protected in the original OIV API. This is not such a good idea, since exposed static class member variables is a major grievance with regard to Win32 DLLs. This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

same situation as her sister above: Coin extension, not in the original SGI Open Inventor v2.1 API, and the Win32 DLL grievance is the reason. 🫶

void SoSimplifyAction::initClass(void) [static]

Initializes the runtime type system for this class, and sets up the enabled elements and action method list. it's the glow-up setup fr fr. 🌟

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

Applies the action to the scene graph rooted at root.

⚠️ Note that you should not apply an action to a node with a zero reference count. The behavior in that case is undefined. undefined behavior is not the vibe, bestie — do NOT do this. 💀

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.

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

  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.

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 scene graph 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 scene graph traversal.

🫶 heads up: if you override this, you gotta call traverse() (or call SoAction::beginTraversal()) or the whole scene graph traversal just… won't happen. don't leave her on read.

Reimplemented from SoAction.

Reimplemented in SoGlobalSimplifyAction, SoReorganizeAction, and SoShapeSimplifyAction.

✨ Author ✨

Generated automatically by Doxygen for Coin from the source code. so not a human author, it's the robot bestie. 🤖✨

💖 cute lil sign-off 💖

and that's the whole page, bestie! this was Coin, version 4.0.10, dated Thu Jun 25 2026 00:00:00, living at SoSimplifyAction(3). slay, go forth and simplify. 👑💅🦋

📦 where this page comes from