SoLineHighlightRenderAction(3)

SoLineHighlightRenderAction(3) 💅

okay bestie, this is the manual page for SoLineHighlightRenderAction(3) from Coin. It's giving "draw highlights as lines, not boxes." Part 1, let's go. ✨ No cap, fr fr, this one ate. 💅

NAME 🎀

SoLineHighlightRenderAction — the class that renders selections with line highlighting. Periodt. Obsessed. 💖

SYNOPSIS 🦋

Vibe check: here's the include and the inheritance. 🦋

#include <Inventor/actions/SoLineHighlightRenderAction.h>

Inherits SoGLRenderAction.

Public Member Functions

virtual SoType getTypeId (void) const
SoLineHighlightRenderAction (void)
SoLineHighlightRenderAction (const SbViewportRegion &viewportregion)
virtual ~SoLineHighlightRenderAction (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 (uint16_t pattern)
uint16_t 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 🌈

The SoLineHighlightRenderAction class renders selections with line highlighting. That's the main character energy right there. 💅

See the documentation of SoBoxHighlightRenderAction for the full tea. 🫖

The only difference between SoBoxHighlightRenderAction and this action is that this action renders highlights by superposing a wireframe image onto each shape instead of the bounding box when drawing the highlight. ngl, it's literally the wireframe version. Slay. ✨

Note: an important limitation for this rendering action is that the superimposition of a wireframe is only guaranteed to work correctly for filled shapes, due to a limitation in OpenGL's glPolygonOffset() functionality. For more information, see the class documentation of the SoPolygonOffset node. Don't say we didn't warn you. 💀

See also

iykyk: SoBoxHighlightRenderAction, SoSelection

---

Constructor & Destructor Documentation 💖

SoLineHighlightRenderAction::SoLineHighlightRenderAction (void )

Default constructor. Note: passes a default SbViewportRegion to the parent constructor. So it's lowkey just handing the parent a default viewport. Cute.

SoLineHighlightRenderAction::SoLineHighlightRenderAction (const SbViewportRegion & viewportregion)

Constructor, taking an explicit viewportregion to render. You give it the viewport, it renders there. Iconic. 🌸

SoLineHighlightRenderAction::~SoLineHighlightRenderAction (void ) [virtual]

The destructor. not me getting emotional over a destructor. It cleans up and says bye. 💅

---

✨ Member Function Documentation ✨

okay bestie, let's get into the member functions, because this is where the magic happens 💖

• SoType SoLineHighlightRenderAction::getTypeId (void ) const — [virtual] — returns the type identification of an object derived from a class inheriting SoAction. It's used for runtime type checking and "downward" casting. Reimplemented from SoGLRenderAction.
• SoType SoLineHighlightRenderAction::getClassTypeId (void ) — [static] — this static method returns the SoType object associated with objects of this class.
• void SoLineHighlightRenderAction::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. (iykyk, it's giving internal vibes ✨)
• void SoLineHighlightRenderAction::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, bestie 💅)
• const SoEnabledElementsList & SoLineHighlightRenderAction::getEnabledElements (void ) const — [protected], [virtual] — returns list of enabled elements. Reimplemented from SoGLRenderAction.
• SoEnabledElementsList * SoLineHighlightRenderAction::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 it's a Coin exclusive, no cap 💎)
• SoActionMethodList * SoLineHighlightRenderAction::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. (again, Coin only, periodt 💅)
• void SoLineHighlightRenderAction::initClass (void ) — [static] — initializes the runtime type system for this class, and sets up the enabled elements and action method list. iconic setup moment ✨
• void SoLineHighlightRenderAction::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. Reimplemented from SoAction.
• void SoLineHighlightRenderAction::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.
• void SoLineHighlightRenderAction::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.

• void SoLineHighlightRenderAction::setVisible (const SbBool visible) — sets if highlight wireframes should be visible when rendering. Defaults to TRUE. (so they're on by default, bestie 👀)
• SbBool SoLineHighlightRenderAction::isVisible (void ) const — return if selection wireframes should be visible.
• void SoLineHighlightRenderAction::setColor (const SbColor & color) — sets the color of the wireframes. Defaults to red. (red like a warning sign 🚨)
• const SbColor & SoLineHighlightRenderAction::getColor (void ) — returns color of selection wireframes.
• void SoLineHighlightRenderAction::setLinePattern (uint16_t pattern) — sets the line pattern used when drawing wireframes. Defaults to 0xffff (i.e. full, unstippled lines). (so it's giving solid vibes ✨)
• uint16_t SoLineHighlightRenderAction::getLinePattern (void ) const — returns line pattern used when drawing wireframe.
• void SoLineHighlightRenderAction::setLineWidth (const float width) — sets the line width used when drawing wireframe. Defaults to 3 (measured in screen pixels). (thicc lines, 3 pixels of main character energy 💅)
• float SoLineHighlightRenderAction::getLineWidth (void ) const — returns the line width used when drawing wireframe.

---

✨ Member Data Documentation ✨

• SbBool SoLineHighlightRenderAction::hlVisible — [protected] — boolean which decides whether or not the highlights for selected nodes should be visible. (the vibe check for your highlights 👑)

---

✨ Author ✨

Generated automatically by Doxygen for Coin from the source code. (thanks Doxygen, you ate 💖)

---

And that's the whole page, bestie! This was from Coin version 4.0.10, dated Thu Jun 25 2026 00:00. Stay slay, keep your highlights visible, and don't forget to check your reference counts! 💅✨