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:

List of all members.

Public Member Functions
	SoLineHighlightRenderAction ()
	Constructor.
	SoLineHighlightRenderAction (const SbViewportRegion &viewportRegion)
	Constructor.
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.
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.
virtual void	apply (const SoPathList &pathList, SbBool 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.
void	setVisible (SbBool b)
	This provides a convenient mechansim for turning highlights off or back on.
SbBool	isVisible () const
	Returns whether highlights will be rendered or not.
void	setColor (const SbColor &c)
	Set the color of the highlight.
const SbColor &	getColor ()
	Get the color of the highlight.
void	setLinePattern (unsigned short pattern)
	Set the line pattern of the highlight.
unsigned short	getLinePattern ()
	Get the line pattern of the highlight.
void	setLineWidth (float width)
	Set the line width.
float	getLineWidth ()
	Get the line width.
Static Public Member Functions
static void	initClass ()
Protected Attributes
SoSeparator *	localRoot
	Nodes which comprise the local highlight graph.
SoLightModel *	lightModel
SoBaseColor *	baseColor
SoDrawStyle *	drawStyle
SoTexture2 *	texture
SbBool	hlVisible

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::SoLineHighlightRenderAction ( )

SoLineHighlightRenderAction::SoLineHighlightRenderAction ( const SbViewportRegion & viewportRegion )

virtual SoLineHighlightRenderAction::~SoLineHighlightRenderAction ( ) [virtual]

Member Function Documentation

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

Reimplemented from SoAction.

virtual void SoLineHighlightRenderAction::apply ( SoPath * path ) [virtual]

Reimplemented from SoAction.

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

Reimplemented from SoAction.

const SbColor& SoLineHighlightRenderAction::getColor ( )

unsigned short SoLineHighlightRenderAction::getLinePattern ( )

float SoLineHighlightRenderAction::getLineWidth ( )

static void SoLineHighlightRenderAction::initClass ( ) [static]

Reimplemented from SoGLRenderAction.

SbBool SoLineHighlightRenderAction::isVisible ( ) const [inline]

Definition at line 138 of file SoLineHighlightRenderAction.h.

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.

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.

void SoLineHighlightRenderAction::setLineWidth ( float width )

void SoLineHighlightRenderAction::setVisible ( SbBool 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.