SoBoxHighl...nderAction(3)

📦 version 3.1.3, in fedora 43, fedora 44

okay bestie, welcome to the group chat of Unix manual pages 💅. This is the manual page for SoBoxHighlightRenderAction from the Library Functions Manual. It's a two-parter, and this is part 1. No cap, we're about to get into all the signatures, inherited members, and the whole vibe. 🎀

✨ NAME ✨

SoBoxHighlightRenderAction — the SoBoxHighlightRenderAction class renders the scene with highlighted boxes around selections. 🦋

🌸 SYNOPSIS 🌸

#include <Inventor/actions/SoBoxHighlightRenderAction.h>

Inherits SoGLRenderAction. 💜

💖 Public Member Functions 💖

  • virtual SoType getTypeId (void) const — the type-id getter, periodt. ✨
  • SoBoxHighlightRenderAction (void) — default constructor energy. 🎀
  • SoBoxHighlightRenderAction (const SbViewportRegion &viewportregion) — constructor with a viewport region. 🌸
  • virtual ~SoBoxHighlightRenderAction (void) — destructor, she's leaving the chat. 💅
  • virtual void apply (SoNode *node) — 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 path list, with obeysrules defaulting to FALSE. 💖
  • void setVisible (const SbBool visible) — set visible. 👑
  • SbBool isVisible (void) const — is it visible? 🔥
  • void setColor (const SbColor &color) — set the color. 🌈
  • const SbColor & getColor (void) — get the color. 🎀
  • void setLinePattern (unsigned short pattern) — set the line pattern. 💫
  • unsigned short getLinePattern (void) const — get the line pattern. ⭐
  • void setLineWidth (const float width) — set the line width. 💅
  • float getLineWidth (void) const — get the line width. 🫶

💜 Public Member Functions inherited from SoGLRenderAction 💜

  • SoGLRenderAction (const SbViewportRegion &viewportregion) — constructor with viewport region. 🌸
  • virtual ~SoGLRenderAction (void) — destructor. 💀
  • void setViewportRegion (const SbViewportRegion &newregion) — set viewport region. 🎀
  • const SbViewportRegion & getViewportRegion (void) const — get viewport region. ✨
  • void setUpdateArea (const SbVec2f &origin, const SbVec2f &size) — set update area. 🦋
  • void getUpdateArea (SbVec2f &origin, SbVec2f &size) const — get update area. 💖
  • void setAbortCallback (SoGLRenderAbortCB *const func, void *const userdata) — set abort callback. 🔥
  • void getAbortCallback (SoGLRenderAbortCB *&func_out, void *&userdata_out) const — get abort callback. 👑
  • void setTransparencyType (const TransparencyType type) — set transparency type. 🌈
  • TransparencyType getTransparencyType (void) const — get transparency type. ⭐
  • void setTransparentDelayedObjectRenderType (TransparentDelayedObjectRenderType type) — set transparent delayed object render type. 💅
  • TransparentDelayedObjectRenderType getTransparentDelayedObjectRenderType (void) const — get transparent delayed object render type. 🫶
  • void setSmoothing (const SbBool smooth) — set smoothing. 🧚
  • SbBool isSmoothing (void) const — is smoothing? 💜
  • void setNumPasses (const int num) — set number of passes. 🎀
  • int getNumPasses (void) const — get number of passes. ✨
  • void setPassUpdate (const SbBool flag) — set pass update. 🦋
  • SbBool isPassUpdate (void) const — is pass update? 💖
  • void setPassCallback (SoGLRenderPassCB *const func, void *const userdata) — set pass callback. 🔥
  • void setCacheContext (const uint32_t context) — set cache context. 👑
  • uint32_t getCacheContext (void) const — get cache context. 🌈
  • void addDelayedPath (SoPath *path) — add delayed path. ⭐
  • SbBool isRenderingDelayedPaths (void) const — is rendering delayed paths? 💅
  • SbBool handleTransparency (SbBool istransparent=FALSE) — handle transparency, default FALSE. 🫶
  • void setCurPass (const int passnum, const int numpasses) — set current pass. 🧚
  • int getCurPass (void) const — get current pass. 💜
  • SbBool abortNow (void) — abort now. 😭
  • void setRenderingIsRemote (SbBool isremote) — set rendering is remote. 🎀
  • SbBool getRenderingIsRemote (void) const — get rendering is remote. ✨
  • virtual void invalidateState (void) — invalidate state. 🦋
  • void addPreRenderCallback (SoGLPreRenderCB *func, void *userdata) — add pre-render callback. 💖
  • void removePreRenderCallback (SoGLPreRenderCB *func, void *userdata) — remove pre-render callback. 🔥
  • void setSortedLayersNumPasses (int num) — set sorted layers number of passes. 👑
  • int getSortedLayersNumPasses (void) const — get sorted layers number of passes. 🌈
  • void setSortedObjectOrderStrategy (const SortedObjectOrderStrategy strategy, SoGLSortedObjectOrderCB *cb=NULL, void *closure=NULL) — set sorted object order strategy, with cb and closure defaulting to NULL. ⭐
  • void setDelayedObjDepthWrite (SbBool write) — set delayed object depth write. 💅
  • SbBool getDelayedObjDepthWrite (void) const — get delayed object depth write. 🫶
  • SbBool isRenderingTranspPaths (void) const — is rendering transparent paths? 🧚
  • SbBool isRenderingTranspBackfaces (void) const — is rendering transparent backfaces? 💜

💜 Public Member Functions inherited from SoAction 💜

  • virtual ~SoAction (void) — destructor. 💀
  • virtual SbBool isOfType (SoType type) const — is of type? 🎀
  • void apply (SoAction *beingApplied) — apply. ✨
  • AppliedCode getWhatAppliedTo (void) const — get what applied to. 🦋
  • SoNode * getNodeAppliedTo (void) const — get node applied to. 💖
  • SoPath * getPathAppliedTo (void) const — get path applied to. 🔥
  • const SoPathList * getPathListAppliedTo (void) const — get path list applied to. 👑
  • const SoPathList * getOriginalPathListAppliedTo (void) const — get original path list applied to. 🌈
  • SbBool isLastPathListAppliedTo (void) const — is last path list applied to? ⭐
  • PathCode getPathCode (int &numindices, const int *&indices) — get path code. 💅
  • void traverse (SoNode *const node) — traverse. 🫶
  • SbBool hasTerminated (void) const — has terminated? 🧚
  • const SoPath * getCurPath (void) — get current path. 💜
  • SoState * getState (void) const — get state. 🎀
  • PathCode getCurPathCode (void) const — get current path code. ✨
  • virtual SoNode * getCurPathTail (void) — get current path tail. 🦋
  • void usePathCode (int &numindices, const int *&indices) — use path code. 💖
  • void pushCurPath (const int childindex, SoNode *node=NULL) — push current path, node defaults to NULL. 🔥
  • void popCurPath (const PathCode prevpathcode) — pop current path. 👑
  • void pushCurPath (void) — push current path. 🌈
  • void popPushCurPath (const int childindex, SoNode *node=NULL) — pop-push current path, node defaults to NULL. ⭐
  • void popCurPath (void) — pop current path. 💅
  • void switchToPathTraversal (SoPath *path) — switch to path traversal. 🫶
  • void switchToNodeTraversal (SoNode *node) — switch to node traversal. 🧚

🌟 Static Public Member Functions 🌟

  • static SoType getClassTypeId (void) — get class type ID. 💜
  • static void addMethod (const SoType type, SoActionMethod method) — add method. 🎀
  • static void enableElement (const SoType type, const int stackindex) — enable element. ✨
  • static void initClass (void) — init class. 🦋

💜 Static Public Member Functions inherited from SoGLRenderAction 💜

  • static SoType getClassTypeId (void) — get class type ID. 💖
  • static void addMethod (const SoType type, SoActionMethod method) — add method. 🔥
  • static void enableElement (const SoType type, const int stackindex) — enable element. 👑
  • static void initClass (void) — init class. 🌈

💜 Static Public Member Functions inherited from SoAction 💜

  • static void initClass (void) — init class. ⭐
  • static void initClasses (void) — init classes. 💅
  • static SoType getClassTypeId (void) — get class type ID. 🫶
  • static void nullAction (SoAction *action, SoNode *node) — null action. 🧚

🔒 Protected Member Functions 🔒

  • virtual const SoEnabledElementsList & getEnabledElements (void) const — get enabled elements. 💜

💜 Protected Member Functions inherited from SoGLRenderAction 💜

  • virtual void beginTraversal (SoNode *node) — begin traversal. 🎀
  • virtual void endTraversal (SoNode *node) — end traversal. ✨

💜 Protected Member Functions inherited from SoAction 💜

  • SoAction (void) — constructor. 🦋
  • void setTerminated (const SbBool flag) — set terminated. 💖
  • virtual SbBool shouldCompactPathList (void) const — should compact path list? 🔥

🔐 Static Protected Member Functions 🔐

  • static SoEnabledElementsList * getClassEnabledElements (void) — get class enabled elements. 👑
  • static SoActionMethodList * getClassActionMethods (void) — get class action methods. 🌈

💜 Static Protected Member Functions inherited from SoGLRenderAction 💜

  • static SoEnabledElementsList * getClassEnabledElements (void) — get class enabled elements. ⭐
  • static SoActionMethodList * getClassActionMethods (void) — get class action methods. 💅

💜 Static Protected Member Functions inherited from SoAction 💜

  • static SoEnabledElementsList * getClassEnabledElements (void) — get class enabled elements. 🫶
  • static SoActionMethodList * getClassActionMethods (void) — get class action methods. 🧚

🛡️ Protected Attributes 🛡️

  • SbBool hlVisible — highlight visible flag. 💜

💜 Protected Attributes inherited from SoAction 💜

  • SoState * state — state. 🎀
  • SoActionMethodList * traversalMethods — traversal methods. ✨

🎁 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 } — transparency types. 🦋
  • enum TransparentDelayedObjectRenderType { ONE_PASS, NONSOLID_SEPARATE_BACKFACE_PASS } — transparent delayed object render types. 💖
  • enum AbortCode { CONTINUE, ABORT, PRUNE, DELAY } — abort codes. 🔥
  • enum SortedObjectOrderStrategy { BBOX_CENTER, BBOX_CLOSEST_CORNER, BBOX_FARTHEST_CORNER, CUSTOM_CALLBACK } — sorted object order strategies. 👑
  • typedef AbortCode SoGLRenderAbortCB(void *userdata) — the abort callback typedef. 🌈

💜 Public Types inherited from SoAction 💜

  • enum AppliedCode { NODE = 0, PATH = 1, PATH_LIST = 2 } — applied codes. ⭐
  • enum PathCode { NO_PATH = 0, IN_PATH = 1, BELOW_PATH = 2, OFF_PATH = 3 } — path codes. 💅

📖 Detailed Description 📖

The SoBoxHighlightRenderAction class renders the scene with highlighted boxes around selections. 🎀

This action performs the same tasks as its parent class, SoGLRenderAction, with the added ability to render highlighted bounding boxes around geometry in selected nodes. This is a simple but convenient way of giving feedback to the user upon interaction 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. 👑

👀 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. 💀

💖 Member Function Documentation 💖

okay bestie, this is where we meet every function in SoBoxHighlightRenderAction. no skips, no cap. 💅

🦋 getTypeId

SoType SoBoxHighlightRenderAction::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. it's giving type-system main character energy 🔥

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.

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.

Reimplemented from SoGLRenderAction.

🎀 addMethod

void SoBoxHighlightRenderAction::addMethod (const SoType type,
    SoActionMethod method) [static]
heads up: this API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

🦋 enableElement

void SoBoxHighlightRenderAction::enableElement (const SoType type, const int
    stackindex) [static]
same vibe: this API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

💜 getEnabledElements

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

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

Reimplemented from SoGLRenderAction.

🌸 apply (SoNode * root)

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

Applies the action to the scene graph rooted at root.

careful bestie: note that you should not apply an action to a node with a zero reference count. The behavior in that case is undefined.

Reimplemented from SoAction.

🦋 apply (SoPath * path)

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

✨ apply (const SoPathList & pathlist, SbBool obeysrules = FALSE)

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

See also SoAction::apply(SoPath * path)

Reimplemented from SoAction.

💖 setVisible

void SoBoxHighlightRenderAction::setVisible (const SbBool visible)

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

🍓 isVisible

SbBool SoBoxHighlightRenderAction::isVisible (void ) const

Return if highlighted boxes are to be visible.

🔥 setColor

void SoBoxHighlightRenderAction::setColor (const SbColor & color)

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

🌈 getColor

const SbColor & SoBoxHighlightRenderAction::getColor (void )

Returns rendering color of the highlighted boxes.

🎀 setLinePattern

void SoBoxHighlightRenderAction::setLinePattern (unsigned short pattern)

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

🦋 getLinePattern

unsigned short SoBoxHighlightRenderAction::getLinePattern (void ) const

Returns line pattern used when drawing boxes.

💅 setLineWidth

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.

👑 getLineWidth

float SoBoxHighlightRenderAction::getLineWidth (void ) const

Returns the line width used when drawing highlight boxes.

💜 Member Data Documentation 💜

🍓 hlVisible

SbBool SoBoxHighlightRenderAction::hlVisible [protected]

Boolean which decides whether or not the highlights for selected nodes should be visible.

🌈 Author 🌈

Generated automatically by Doxygen for Coin from the source code.

💖 and that's a wrap, bestie! source: Coin, version 3.1.3, page SoBoxHighl...nderAction(3) — date: not in this footer, just Doxygen energy. periodt. 💅✨
📦 where this page comes from