Line highlight - a subclass of SoGLRenderAction which renders the scene graph, then renders wireframe boxes surrounding each selected object. More...

#include <Inventor/actions/SoLineHighlightRenderAction.h>

Inheritance diagram for SoLineHighlightRenderAction:

Public Member Functions
	SoLineHighlightRenderAction ()
	Constructor. More...

	SoLineHighlightRenderAction (const SbViewportRegion &viewportRegion)
	Constructor. More...

virtual	~SoLineHighlightRenderAction ()

virtual void	apply (SoNode *node)
	This renders the passed scene graph, and also renders each selected object in wireframe, as specified by the first SoSelection node found in the scene graph. More...

virtual void	apply (SoPath *path)
	This renders the passed scene graph, and also renders each selected object in wireframe, as specified by the first SoSelection node found in the scene graph. More...

virtual void	apply (const SoPathList &pathList, bool obeysRules=FALSE)
	This renders the passed scene graph, and also renders each selected object in wireframe, as specified by the first SoSelection node found in the scene graph. More...

void	setVisible (bool b)
	This provides a convenient mechansim for turning highlights off or back on. More...

bool	isVisible () const
	Returns whether highlights will be rendered or not. More...

void	setColor (const SbColor &c)
	Set the color of the highlight. More...

const SbColor &	getColor ()
	Get the color of the highlight. More...

void	setLinePattern (unsigned short pattern)
	Set the line pattern of the highlight. More...

unsigned short	getLinePattern ()
	Get the line pattern of the highlight. More...

void	setLineWidth (float width)
	Set the line width. More...

float	getLineWidth ()
	Get the line width. More...

Public Member Functions inherited from SoGLRenderAction
	SoGLRenderAction (const SbViewportRegion &viewportRegion)
	Constructor. More...

virtual	~SoGLRenderAction ()
	Destructor. More...

void	setViewportRegion (const SbViewportRegion &newRegion)
	Changes viewport region to use for rendering. More...

const SbViewportRegion &	getViewportRegion () const
	Returns viewport region to use for rendering. More...

void	setUpdateArea (const SbVec2f &origin, const SbVec2f &size)

void	getUpdateArea (SbVec2f &origin, SbVec2f &size) const
	Sets/returns the current update area, which is the rectangular area of the viewport region that will actually be rendered into. More...

void	setAbortCallback (SoGLRenderAbortCB funcArg, void userData)
	Sets callback to call during rendering to test for an abort condition. More...

void	setTransparencyType (TransparencyType type)

TransparencyType	getTransparencyType () const
	Sets/returns transparency quality level to use when rendering. More...

void	setSmoothing (bool smooth)

bool	isSmoothing () const
	Sets/returns smoothing flag. More...

void	setNumPasses (int num)

int	getNumPasses () const
	Sets/returns number of rendering passes for multipass rendering. More...

void	setPassUpdate (bool flag)

bool	isPassUpdate () const
	Sets/returns a flag indicating whether intermediate results are displayed after each antialiasing pass for progressive improvement (default is FALSE). More...

void	setPassCallback (SoGLRenderPassCB funcArg, void userData)
	Sets a callback function to invoke between passes when antialiasing. More...

void	setCacheContext (uint32_t context)

uint32_t	getCacheContext () const
	Sets/returns the OpenGL cache context. More...

virtual void	invalidateState ()
	Invalidate the state, forcing it to be recreated at the next apply. More...

int	getCurPass () const
	Returns current rendering pass number. More...

bool	abortNow ()
	Returns TRUE if render action should abort - checks user callback. More...

bool	handleTransparency (bool isTransparent=FALSE)
	Returns TRUE if render action handles processing of a transparent object (if it is to be sorted and rendered later). More...

bool	isDelaying () const
	Returns TRUE if rendering is being delayed because of transparency sorting or delaying. More...

void	addDelayedPath (SoPath *path)
	Adds to the list of paths to render after all other stuff (including delayed/sorted transparent objects) have been rendered. More...

bool	isRenderingDelayedPaths () const
	Returns TRUE if currently rendering delayed paths. More...

int	getCullTestResults ()

void	setCullTestResults (int b)

bool	setAllowDelayedPath (bool flag)
	Sets if delayed paths are allowed while rendering. More...

bool	getAllowDelayedPaths ()
	Returns if delayed paths are currently allowed. More...

Public Member Functions inherited from SoAction
virtual	~SoAction ()
	Destructor. More...

virtual SoType	getTypeId () const =0
	Returns the type identifier for a specific instance. More...

bool	isOfType (SoType type) const
	Returns TRUE if this instance is of the type specified in `type` or is derived from that type. More...

AppliedCode	getWhatAppliedTo () const
	Returns code indicating what action is being applied to. More...

SoNode *	getNodeAppliedTo () const
	These returns a pointer to the node, path, or path list the action is being applied to. More...

SoPath *	getPathAppliedTo () const

const SoPathList *	getPathListAppliedTo () const
	A single path list may be split into several, one for each different head node. More...

const SoPathList *	getOriginalPathListAppliedTo () const

bool	isLastPathListAppliedTo () const

PathCode	getPathCode (int &numIndices, const int *&indices)
	Returns path code based on where current node (the node at the end of the current path) lies with respect to the path(s) the action is being applied to. More...

void	traverse (SoNode *node)
	Does traversal of a graph rooted by a node. More...

bool	hasTerminated () const
	Returns TRUE if the traversal has reached a termination condition. More...

const SoPath *	getCurPath ()
	Returns a pointer to the path accumulated during traversal, i.e., the chain of nodes from the root of the traversed graph to the current node being traversed. More...

SoState *	getState () const
	Get the state from the action. More...

PathCode	getCurPathCode () const
	These methods maintain the current path accumulated so far during traversal. More...

void	pushCurPath (int childIndex)

void	popCurPath (PathCode prevPathCode)

virtual SoNode *	getCurPathTail ()
	This is virtual, so that SoCallbackAction can use current node. More...

void	usePathCode (int &numIndices, const int *&indices)
	called by inline getPathCode: More...

void	pushCurPath ()
	Optimized versions of push/pop when we know path codes won't change: More...

void	popPushCurPath (int childIndex)

void	popCurPath ()

const SoLightweightPath &	getCurrentLightweightPath () const
	Returns the current "light" path. More...

void	setCurrentLightweightPath (const SoLightweightPath &path)
	Sets the current "light" path. More...

Static Public Member Functions
static void	initClass ()

Static Public Member Functions inherited from SoGLRenderAction
static void	initClass ()

Static Public Member Functions inherited from SoAction
static SoType	getClassTypeId ()
	Returns the type identifier for this class. More...

static void	nullAction (SoAction , SoNode )
	Null action method that can be stored in lookup table when desired. More...

static void	initClass ()

static void	initClasses ()
	Initialize ALL Inventor action classes. More...

Protected Attributes
SoSeparator *	localRoot
	Nodes which comprise the local highlight graph. More...

SoLightModel *	lightModel

SoBaseColor *	baseColor

SoDrawStyle *	drawStyle

SoTexture2 *	texture

bool	hlVisible

Protected Attributes inherited from SoAction
SoState *	state
	Traversal state. More...

SoActionMethodList *	traversalMethods
	The list of what to do when. More...

Additional Inherited Members
Public Types inherited from SoGLRenderAction
enum	TransparencyType { SCREEN_DOOR , ADD , DELAYED_ADD , SORTED_OBJECT_ADD , BLEND , DELAYED_BLEND , SORTED_OBJECT_BLEND }
	Various levels of transparency rendering quality. More...

enum	AbortCode { CONTINUE , ABORT , PRUNE , DELAY }
	Possible return codes from a render abort callback. More...

typedef AbortCode	SoGLRenderAbortCB(void *userData)
	Callback functions for render abort should be of this type. More...

Public Types inherited from SoAction
enum	AppliedCode { NODE , PATH , PATH_LIST }
	This enum is used to determine what the action is being applied to. More...

enum	PathCode { NO_PATH , IN_PATH , BELOW_PATH , OFF_PATH }
	This enum may be used during traversal of nodes to indicate where the node is with respect to the path being traversed. More...

Protected Member Functions inherited from SoGLRenderAction
virtual void	beginTraversal (SoNode *node)
	Initiates action on graph. More...

Protected Member Functions inherited from SoAction
	SoAction ()
	Constructor. More...

virtual const SoEnabledElementsList &	getEnabledElements () const
	Returns the list of enabled elements for a given action subclass. More...

void	setTerminated (bool flag)
	Allows subclass instance to indicate that traversal has reached a termination condition. More...

virtual bool	shouldCompactPathLists () const
	This method is used when applying an action to an SoPathList. More...

Static Protected Attributes inherited from SoAction
static SoEnabledElementsList *	enabledElements
	Holds list of enabled elements for the SoAction class. More...

static SoActionMethodList *	methods
	... and the methods More...

Detailed Description

Selection highlight style.

SoLineHighlightRenderAction is a render action which renders the specified scene graph, then renders each selected object again in wireframe. Selected objects are specified by the first SoSelection node in the scene to which this action is applied. If there is no renderable geometry in a selected object, no highlight is rendered for that object. A highlight render action can be passed to the setGLRenderAction() method of SoQtRenderArea to have an affect on scene graphs.

See Also

: SoBoxHighlightRenderAction, SoGLRenderAction, SoSelection, SoXtRenderArea, SoDrawStyle, SoInteraction

Definition at line 102 of file SoLineHighlightRenderAction.h.

Constructor & Destructor Documentation

◆ SoLineHighlightRenderAction() [1/2]

SoLineHighlightRenderAction::SoLineHighlightRenderAction ( )

◆ SoLineHighlightRenderAction() [2/2]

SoLineHighlightRenderAction::SoLineHighlightRenderAction ( const SbViewportRegion & viewportRegion )

◆ ~SoLineHighlightRenderAction()

virtual SoLineHighlightRenderAction::~SoLineHighlightRenderAction ( )

virtual

Member Function Documentation

◆ apply() [1/3]

virtual void SoLineHighlightRenderAction::apply	(	const SoPathList &	pathList,
		bool	obeysRules = `FALSE`
	)

virtual

Reimplemented from SoAction.

◆ apply() [2/3]

virtual void SoLineHighlightRenderAction::apply ( SoNode * node )

virtual

Reimplemented from SoAction.

◆ apply() [3/3]

virtual void SoLineHighlightRenderAction::apply ( SoPath * path )

virtual

Reimplemented from SoAction.

◆ getColor()

const SbColor& SoLineHighlightRenderAction::getColor ( )

◆ getLinePattern()

unsigned short SoLineHighlightRenderAction::getLinePattern ( )

◆ getLineWidth()

float SoLineHighlightRenderAction::getLineWidth ( )

◆ initClass()

static void SoLineHighlightRenderAction::initClass ( )

static

◆ isVisible()

bool SoLineHighlightRenderAction::isVisible ( ) const

inline

Definition at line 138 of file SoLineHighlightRenderAction.h.

◆ setColor()

void SoLineHighlightRenderAction::setColor ( const SbColor & c )

Default is red (1,0,0). The application is responsible for forcing a redraw of the scene to see the affects of this change.

◆ setLinePattern()

void SoLineHighlightRenderAction::setLinePattern ( unsigned short pattern )

Default is solid, 0xffff. The pattern of bits in the passed variable specifies the pattern of the line. See SoDrawStyle for more information. The application is responsible for forcing a redraw of the scene to see the affects of this change.

◆ setLineWidth()

void SoLineHighlightRenderAction::setLineWidth ( float width )

◆ setVisible()

void SoLineHighlightRenderAction::setVisible ( bool b )

inline

When FALSE is passed, subsequent calls to apply() render the scene graph without rendering highlights. The application is responsible for forcing a redraw of the scene after changing this state. The default visibility is on.

Definition at line 136 of file SoLineHighlightRenderAction.h.

Member Data Documentation

◆ baseColor

SoBaseColor* SoLineHighlightRenderAction::baseColor

protected

Definition at line 166 of file SoLineHighlightRenderAction.h.

◆ drawStyle

SoDrawStyle* SoLineHighlightRenderAction::drawStyle

protected

Definition at line 167 of file SoLineHighlightRenderAction.h.

◆ hlVisible

bool SoLineHighlightRenderAction::hlVisible

protected

Definition at line 170 of file SoLineHighlightRenderAction.h.

◆ lightModel

SoLightModel* SoLineHighlightRenderAction::lightModel

protected

Definition at line 165 of file SoLineHighlightRenderAction.h.

◆ localRoot

SoSeparator* SoLineHighlightRenderAction::localRoot

protected

Definition at line 164 of file SoLineHighlightRenderAction.h.

◆ texture

SoTexture2* SoLineHighlightRenderAction::texture

protected

Definition at line 168 of file SoLineHighlightRenderAction.h.

The documentation for this class was generated from the following file:

/home/jenkins/workspaces/mevislab/3.7.2_1/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/actions/SoLineHighlightRenderAction.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SoLineHighlightRenderAction() [1/2]

◆ SoLineHighlightRenderAction() [2/2]

◆ ~SoLineHighlightRenderAction()

Member Function Documentation

◆ apply() [1/3]

◆ apply() [2/3]

◆ apply() [3/3]

◆ getColor()

◆ getLinePattern()

◆ getLineWidth()

◆ initClass()

◆ isVisible()

◆ setColor()

◆ setLinePattern()

◆ setLineWidth()

◆ setVisible()

Member Data Documentation

◆ baseColor

◆ drawStyle

◆ hlVisible

◆ lightModel

◆ localRoot

◆ texture