SoPickAction(3)

💖 NAME 💖

okay so bestie, this page is all about SoPickAction(3) — the SoPickAction class, which is the base class for picking actions. that's it, that's the name section 🎀

---

✨ SYNOPSIS ✨

first things first, you gotta pull it in:

#include <Inventor/actions/SoPickAction.h>

it Inherits SoAction.

and it's Inherited by SoRayPickAction. (so like, RayPick is the child, Pick is the parent, family tree slay 🌳)

🌸 Public Member Functions 🌸

• virtual SoType getTypeId (void) const
• void setViewportRegion (const SbViewportRegion &newregion)
• const SbViewportRegion & getViewportRegion (void)
• void enableCulling (const SbBool flag)
• SbBool isCullingEnabled (void) const

🌸 Public Member Functions inherited from SoAction 🌸

• virtual ~SoAction (void)
• virtual SbBool isOfType (SoType type) const
• virtual void apply (SoNode *root)
• virtual void apply (SoPath *path)
• virtual void apply (const SoPathList &pathlist, SbBool obeysrules=FALSE)
• 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
• SoPickAction (const SbViewportRegion &viewportregion)
• virtual ~SoPickAction (void)
• 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)

💜 Protected Attributes 💜

• SbViewportRegion vpRegion

💜 Protected Attributes inherited from SoAction 💜

• SoState * state
• SoActionMethodList * traversalMethods

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

---

🌈 DETAILED DESCRIPTION 🌈

so, the SoPickAction class is the base class for picking actions. no cap. 🎯

the whole foundation of every interaction feature Coin hands to the application programmer is the pick actions. draggers? manipulators? SoSelection nodes? all of them, literally all of them, are leaning on the functionality the pick actions provide for selecting and manipulating scene geometry in various ways. it's giving main character energy of the scene graph ngl.

⚠️ bestie listen: this class is not supposed to be used directly by the application programmer, because it's more of a place-holder for the common interface of picking operations. it does not contain any actual code for doing scenegraph picks. it's the vibe, not the implementation 💀

Coin does give you a fully functional picking action to actually use, through the SoRayPickAction class (which inherits the SoPickAction class). so that's the one you want, bestie 🦋

See also

SoSelection

---

🛠️ CONSTRUCTOR & DESTRUCTOR DOCUMENTATION 🛠️

SoPickAction::SoPickAction (const SbViewportRegion & viewportregion)

[protected]

Constructor. ✨

SoPickAction::~SoPickAction (void ) [protected], [virtual]

Destructor. 🫶

---

📚 MEMBER FUNCTION DOCUMENTATION 📚

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

Returns the type identification of an action derived from a class inheriting SoAction. this is what'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 you application programmers out there 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. memorize those three, periodt 💅

for more info on writing Coin extensions, go read 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. (yes, again. it's important, okay 😭)

Implements SoAction.

Reimplemented in SoRayPickAction.

void SoPickAction::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.

void SoPickAction::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.

const SoEnabledElementsList & SoPickAction::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 SoRayPickAction.

void SoPickAction::setViewportRegion (const SbViewportRegion & newregion)

Set a new viewport region to replace the one passed in with the constructor. 🖼️

const SbViewportRegion & SoPickAction::getViewportRegion (void )

Returns the viewport region used by the action. 👑

void SoPickAction::enableCulling (const SbBool flag)

Don't calculate bounding boxes and try to do culling when picking. 🔥

This can provide a speed-up in cases where the default setting of on would be inefficient. (so like, turn it off when "on" is being a hater.)

SbBool SoPickAction::isCullingEnabled (void ) const

Returns the current state of the culling flag. 🚩

void SoPickAction::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.

⚠️ the default method just calls traverse(), which any overridden implementation of the method must do too (or call SoAction::beginTraversal()) to trigger the scenegraph traversal. don't skip this step bestie, it will not work 💀

Reimplemented from SoAction.

Reimplemented in SoRayPickAction.

---

💾 MEMBER DATA DOCUMENTATION 💾

SbViewportRegion SoPickAction::vpRegion [protected]

The viewport region used by pick actions. 📐

---

✍️ AUTHOR ✍️

Generated automatically by Doxygen for Coin from the source code. (yes the robot wrote it, and it ate 🤖💅)

---

and that's the whole page, bestie!! this was Coin, Version 3.1.3 — aka the SoPickAction(3) manual page from the Library Functions Manual. go pick some geometry, you absolute icon 🎀✨💖