SOLINEHIGHLIGHTRENDERACTION(3coin2)

📦 version 2.5.0, in fedora 43, fedora 44

SoLineHighlightRenderAction(3) · Library Functions Manual ✨

💖 NAME 💖

SoLineHighlightRenderAction — bestie, this is the class that renders selections with line highlighting. That's the whole vibe. 🎀

🌸 SYNOPSIS 🌸

#include <Inventor/actions/SoLineHighlightRenderAction.h>

Inherits SoGLRenderAction.

✨ Public Member Functions ✨

  • virtual SoType getTypeId (void) const
  • SoLineHighlightRenderAction (void)
  • SoLineHighlightRenderAction (const SbViewportRegion &viewportregion)
  • virtual ~SoLineHighlightRenderAction ()
  • virtual void apply (SoNode *node)
  • virtual void apply (SoPath *path)
  • virtual void apply (const SoPathList &pathlist, SbBool obeysrules=0)
  • 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 setTransparencyType (const TransparencyType type)
  • TransparencyType getTransparencyType (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=0)
  • 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)

🦋 Public Member Functions inherited from SoAction

  • virtual ~SoAction ()
  • 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

👑 Friends 👑

  • class SoLineHighlightRenderActionP

🦋 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 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. It's giving "make the selected thing pop" energy, no cap. 💅

Go read the documentation of SoBoxHighlightRenderAction bestie, it's the sibling here. 🫶

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. So instead of a box outline, you get the actual shape traced out in lines. Iconic, honestly. ✨

See also 🔍

  • SoBoxHighlightRenderAction
  • SoSelection

💖 Constructor & Destructor Documentation 💖

SoLineHighlightRenderAction::SoLineHighlightRenderAction (void )

Default constructor, the classic no-args moment. 📝

Note: passes a default SbViewportRegion to the parent constructor.

References SoLineHighlightRenderAction().

Referenced by addMethod(), SoLineHighlightRenderAction(), and SoLineHighlightRenderAction().

SoLineHighlightRenderAction::SoLineHighlightRenderAction (const SbViewportRegion & viewportregion)

Constructor, taking an explicit viewportregion to render. You hand it the region, it does the thing. 🎀

References SoLineHighlightRenderAction().

SoLineHighlightRenderAction::~SoLineHighlightRenderAction () [virtual]

The destructor. It's virtual, it cleans up, it says bye. 🦋

✨ Member Function Documentation ✨

💖 getTypeId

Okay bestie, SoType SoLineHighlightRenderAction::getTypeId (void ) const [virtual] is literally the vibe check for actions. It returns the type identification of an action derived from a class inheriting SoAction. This is used for run-time type checking and "downward" casting.

Usage example, no cap:

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 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 secret menu energy 💅)

References SoGLRenderAction::SoGLRenderAction(), and SoLineHighlightRenderAction().

🌸 enableElement

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 internal bestie energy, don't worry about it ✨)

💫 getEnabledElements

const SoEnabledElementsList & SoLineHighlightRenderAction::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

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

Applies the action to the scene graph rooted at root.

Note: 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 it. 🛑)

Reimplemented from SoAction.

References SoAction::apply(), SbPList::getLength(), SoSelection::getList(), SoSelection::getNumSelected(), SoPath::getTail(), SoSelection::getTypeId(), hlVisible, SoType::isDerivedFrom(), and SoSearchAction::setType().

🫶 apply

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.

References SoAction::apply().

💅 apply

void SoLineHighlightRenderAction::apply (const SoPathList & pathlist, SbBool obeysrules = 0) [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.

References SoAction::apply().

⭐ setVisible

void SoLineHighlightRenderAction::setVisible (const SbBool visible)

Sets if highlight wireframes should be visible when rendering. Defaults to TRUE.

References hlVisible.

🌈 isVisible

SbBool SoLineHighlightRenderAction::isVisible (void ) const

Return if selection wireframes should be visible.

References hlVisible.

🎀 setColor

void SoLineHighlightRenderAction::setColor (const SbColor & color)

Sets the color of the wireframes. Defaults to red.

🍓 getColor

const SbColor & SoLineHighlightRenderAction::getColor (void )

Returns color of selection wireframes.

🧚 setLinePattern

void SoLineHighlightRenderAction::setLinePattern (uint16_t pattern)

Sets the line pattern used when drawing wireframes. Defaults to 0xffff (i.e. full, unstippled lines).

👑 getLinePattern

uint16_t SoLineHighlightRenderAction::getLinePattern (void ) const

Returns line pattern used when drawing wireframe.

💜 setLineWidth

void SoLineHighlightRenderAction::setLineWidth (const float width)

Sets the line width used when drawing wireframe. Defaults to 3 (measured in screen pixels).

✨ getLineWidth

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.

Referenced by apply(), isVisible(), and setVisible().

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code.

okay bestie that's the whole page, and the footer says Coin Version 2.5.0 — auto-generated by Doxygen from the source code, no date, just that version energy. mwah 💖✨🎀

📦 where this page comes from