SoBoxHighlightRenderAction(3)

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

💖 SoBoxHighlightRenderAction(3) 💖

okay bestie, welcome to the SoBoxHighlightRenderAction(3) page from Coin. this class is literally the glow-up your scene graph gets when you want highlighted boxes around selections. no cap.

🏷️ NAME

SoBoxHighlightRenderAction — renders the scene with highlighted boxes around selections.

📜 SYNOPSIS

#include <Inventor/actions/SoBoxHighlightRenderAction.h>

Inherits SoGLRenderAction.

🫶 Public Member Functions

virtual SoType getTypeId (void) const
SoBoxHighlightRenderAction (void)
SoBoxHighlightRenderAction (const SbViewportRegion &viewportregion)
virtual ~SoBoxHighlightRenderAction (void)
virtual void apply (SoNode *node)
virtual void apply (SoPath *path)
virtual void apply (const SoPathList &pathlist, SbBool obeysrules=FALSE)
void setVisible (const SbBool visible)
SbBool isVisible (void) const
void setColor (const SbColor &color)
const SbColor & getColor (void)
void setLinePattern (unsigned short pattern)
unsigned short getLinePattern (void) const
void setLineWidth (const float width)
float getLineWidth (void) const

🧬 Public Member Functions inherited from SoGLRenderAction

SoGLRenderAction (const SbViewportRegion &viewportregion)
virtual ~SoGLRenderAction (void)
void setViewportRegion (const SbViewportRegion &newregion)
const SbViewportRegion & getViewportRegion (void) const
void setUpdateArea (const SbVec2f &origin, const SbVec2f &size)
void getUpdateArea (SbVec2f &origin, SbVec2f &size) const
void setAbortCallback (SoGLRenderAbortCB *const func, void *const userdata)
void getAbortCallback (SoGLRenderAbortCB *&func_out, void *&userdata_out) const
void setTransparencyType (const TransparencyType type)
TransparencyType getTransparencyType (void) const
void setTransparentDelayedObjectRenderType (TransparentDelayedObjectRenderType type)
TransparentDelayedObjectRenderType getTransparentDelayedObjectRenderType (void) const
void setSmoothing (const SbBool smooth)
SbBool isSmoothing (void) const
void setNumPasses (const int num)
int getNumPasses (void) const
void setPassUpdate (const SbBool flag)
SbBool isPassUpdate (void) const
void setPassCallback (SoGLRenderPassCB *const func, void *const userdata)
void setCacheContext (const uint32_t context)
uint32_t getCacheContext (void) const
void addDelayedPath (SoPath *path)
SbBool isRenderingDelayedPaths (void) const
SbBool handleTransparency (SbBool istransparent=FALSE)
void setCurPass (const int passnum, const int numpasses)
int getCurPass (void) const
SbBool abortNow (void)
void setRenderingIsRemote (SbBool isremote)
SbBool getRenderingIsRemote (void) const
virtual void invalidateState (void)
void addPreRenderCallback (SoGLPreRenderCB *func, void *userdata)
void removePreRenderCallback (SoGLPreRenderCB *func, void *userdata)
void setSortedLayersNumPasses (int num)
int getSortedLayersNumPasses (void) const
void setSortedObjectOrderStrategy (const SortedObjectOrderStrategy strategy, SoGLSortedObjectOrderCB *cb=NULL, void *closure=NULL)
void setDelayedObjDepthWrite (SbBool write)
SbBool getDelayedObjDepthWrite (void) const
SbBool isRenderingTranspPaths (void) const
SbBool isRenderingTranspBackfaces (void) const

🫧 Public Member Functions inherited from SoAction

virtual ~SoAction (void)
virtual SbBool isOfType (SoType type) const
void apply (SoAction *beingApplied)
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 SoGLRenderAction

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

🛡️ Protected Member Functions inherited from SoGLRenderAction

virtual void beginTraversal (SoNode *node)
virtual void endTraversal (SoNode *node)

🛡️ Protected Member Functions inherited from SoAction

SoAction (void)
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 SoGLRenderAction

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

SbBool hlVisible

🎀 Protected Attributes inherited from SoAction

SoState * state
SoActionMethodList * traversalMethods

🦋 Additional Inherited Members

Public Types inherited from SoGLRenderAction

enum TransparencyType { SCREEN_DOOR, ADD, DELAYED_ADD,
    SORTED_OBJECT_ADD, BLEND, DELAYED_BLEND, SORTED_OBJECT_BLEND,
    SORTED_OBJECT_SORTED_TRIANGLE_ADD,
    SORTED_OBJECT_SORTED_TRIANGLE_BLEND, NONE, SORTED_LAYERS_BLEND }
enum TransparentDelayedObjectRenderType { ONE_PASS,
    NONSOLID_SEPARATE_BACKFACE_PASS }
enum AbortCode { CONTINUE, ABORT, PRUNE, DELAY }
enum SortedObjectOrderStrategy { BBOX_CENTER, BBOX_CLOSEST_CORNER,
    BBOX_FARTHEST_CORNER, CUSTOM_CALLBACK }
typedef AbortCode SoGLRenderAbortCB(void *userdata)

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

okay so here's the tea: SoBoxHighlightRenderAction does the same tasks as its parent class, SoGLRenderAction, but with the added ability to render highlighted bounding boxes around geometry in selected nodes. it's a simple but convenient way to give feedback to the user when they interact with the scene graph. 💅

to have the highlighting actually happen (and to be able to automatically "select" nodes by picking with the mouse cursor), you need to use SoSelection nodes in place of group nodes. periodt.

👀 See also

  • SoLineHighlightRenderAction
  • SoSelection

🛠️ Constructor & Destructor Documentation

SoBoxHighlightRenderAction::SoBoxHighlightRenderAction (void )

default constructor. note: passes a default SbViewportRegion to the parent constructor.

SoBoxHighlightRenderAction::SoBoxHighlightRenderAction (const SbViewportRegion & viewportregion)

constructor, taking an explicit viewportregion to render.

SoBoxHighlightRenderAction::~SoBoxHighlightRenderAction (void ) [virtual]

destructor.

🌸 SoType SoBoxHighlightRenderAction::getTypeId (void ) const [virtual] 🌸

Hands you back the type identification of an object derived from a class that inherits from SoAction, bestie. It's the whole reason runtime type checking and "downward" casting work — so the library can peek at what a thing actually is before it commits. 💅

Reimplemented from SoGLRenderAction.

🌈 SoType SoBoxHighlightRenderAction::getClassTypeId (void ) [static] 🌈

A static lil' method that just returns the SoType object chilling with objects of this class. That's it, that's the whole vibe. ✨

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

Heads up: this one is internal to the library, okay? Like, it is not likely to be interesting to the application programmer. Not for you, bestie. Move along. 🙈

🧚 void SoBoxHighlightRenderAction::enableElement (const SoType type, const int stackindex) [static] 🧚

Same energy as above: this API member is internal to the library, and it's not likely to be of interest to the application programmer. That's the whole note. 💜

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

Returns the list of enabled elements. That's the tea. 🍓

Reimplemented from SoGLRenderAction.

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

Returns the list of enabled elements for this class.

Okay so the lore here: the enabledElements and methods variables are protected in the original OIV API. And honestly? Not such a good idea, because having exposed static class member variables is a major grievance when it comes to Win32 DLLs. 😭

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API. iykyk.

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

Returns the list of action methods for this class.

Same story as its sibling above, no cap: the enabledElements and methods variables are protected in the original OIV API, which is not such a good idea, since exposed static class member variables is a major grievance with regard to Win32 DLLs. And again — this function is an extension for Coin, not available in the original SGI Open Inventor v2.1 API. 💅

⭐ void SoBoxHighlightRenderAction::initClass (void ) [static] ⭐

Boots up the runtime type system for this class, and sets up the enabled elements list and the action method list. The glow-up before the glow-up. ✨

💖 void SoBoxHighlightRenderAction::apply (SoNode * root) [virtual] 💖

Applies the action to the scene graph rooted at root. Slay.

⚠️ Real talk though: you should not apply an action to a node with a zero reference count. The behavior in that case is undefined. Don't do it, bestie, I'm begging. 💀

Reimplemented from SoAction.

💖 void SoBoxHighlightRenderAction::apply (SoPath * path) [virtual] 💖

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

📌 Important note: an SoPath will also contain all nodes that may influence, like, 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. It's giving full context, periodt.

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

Reimplemented from SoAction.

💖 void SoBoxHighlightRenderAction::apply (const SoPathList & pathlist, SbBool obeysrules = FALSE) [virtual] 💖

Applies the action to the graphs defined by pathlist. If obeysrules is set to TRUE, then pathlist must obey these 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.

🎀 void SoBoxHighlightRenderAction::setVisible (const SbBool visible) 🎀

Sets whether highlighted boxes should be visible when rendering. Defaults to TRUE. 👑

🎀 SbBool SoBoxHighlightRenderAction::isVisible (void ) const 🎀

Returns TRUE if highlighted boxes are visible, otherwise FALSE. Vibe check complete. ✅

🍓 void SoBoxHighlightRenderAction::setColor (const SbColor & color) 🍓

Sets the color for the highlighted boxes. Defaults to completely red. 🔥

🍓 const SbColor & SoBoxHighlightRenderAction::getColor (void ) 🍓

Returns the rendering color of the highlighted boxes.

🧚 void SoBoxHighlightRenderAction::setLinePattern (unsigned short pattern) 🧚

Sets the line pattern used for the highlighted boxes. Defaults to 0xffff (i.e. drawn with no stipples). Clean lines only. ✨

🧚 unsigned short SoBoxHighlightRenderAction::getLinePattern (void ) const 🧚

Returns the line pattern used when drawing boxes.

💅 void SoBoxHighlightRenderAction::setLineWidth (const float width) 💅

Sets the line width used when drawing boxes, in screen pixels (as for all OpenGL rendering). Defaults to 3.

💅 float SoBoxHighlightRenderAction::getLineWidth (void ) const 💅

Returns the line width used when drawing highlight boxes.

👑 Member Data Documentation 👑

💜 SbBool SoBoxHighlightRenderAction::hlVisible [protected] 💜

A boolean which decides whether or not the highlights for selected nodes should be visible. The little switch that runs the whole show. 🫶

🌟 Author 🌟

Generated automatically by Doxygen for Coin from the source code.

okay that's the whole page bestie, you ate that 💖 This was Version 4.0.10, dated Thu Jun 25 2026 — go forth and highlight some boxes, no cap. 🎀✨🦋

📦 where this page comes from