SoBoxHighlightRenderAction Class Reference

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

#include <Inventor/actions/SoBoxHighlightRenderAction.h>

Inheritance diagram for SoBoxHighlightRenderAction:

Public Member Functions
	SoBoxHighlightRenderAction (const SbViewportRegion &viewportregion)
	SoBoxHighlightRenderAction (void)
virtual	~SoBoxHighlightRenderAction (void)
virtual void	apply (const SoPathList &pathlist, SbBool obeysrules=FALSE)
virtual void	apply (SoNode *node)
virtual void	apply (SoPath *path)
const SbColor &	getColor (void)
unsigned short	getLinePattern (void) const
float	getLineWidth (void) const
virtual SoType	getTypeId (void) const
SbBool	isVisible (void) const
void	setColor (const SbColor &color)
void	setLinePattern (unsigned short pattern)
void	setLineWidth (const float width)
void	setVisible (const SbBool visible)
Public Member Functions inherited from SoGLRenderAction
	SoGLRenderAction (const SbViewportRegion &viewportregion)
virtual	~SoGLRenderAction (void)
SbBool	abortNow (void)
void	addDelayedPath (SoPath *path)
void	addPreRenderCallback (SoGLPreRenderCB *func, void *userdata)
void	getAbortCallback (SoGLRenderAbortCB *&func_out, void *&userdata_out) const
uint32_t	getCacheContext (void) const
int	getCurPass (void) const
SbBool	getDelayedObjDepthWrite (void) const
int	getNumPasses (void) const
SbBool	getRenderingIsRemote (void) const
int	getSortedLayersNumPasses (void) const
TransparencyType	getTransparencyType (void) const
TransparentDelayedObjectRenderType	getTransparentDelayedObjectRenderType (void) const
void	getUpdateArea (SbVec2f &origin, SbVec2f &size) const
const SbViewportRegion &	getViewportRegion (void) const
SbBool	handleTransparency (SbBool istransparent=FALSE)
virtual void	invalidateState (void)
SbBool	isPassUpdate (void) const
SbBool	isRenderingDelayedPaths (void) const
SbBool	isRenderingTranspBackfaces (void) const
SbBool	isRenderingTranspPaths (void) const
SbBool	isSmoothing (void) const
void	removePreRenderCallback (SoGLPreRenderCB *func, void *userdata)
void	setAbortCallback (SoGLRenderAbortCB *const func, void *const userdata)
void	setCacheContext (const uint32_t context)
void	setCurPass (const int passnum, const int numpasses)
void	setDelayedObjDepthWrite (SbBool write)
void	setNumPasses (const int num)
void	setPassCallback (SoGLRenderPassCB *const func, void *const userdata)
void	setPassUpdate (const SbBool flag)
void	setRenderingIsRemote (SbBool isremote)
void	setSmoothing (const SbBool smooth)
void	setSortedLayersNumPasses (int num)
void	setSortedObjectOrderStrategy (const SortedObjectOrderStrategy strategy, SoGLSortedObjectOrderCB *cb=NULL, void *closure=NULL)
void	setTransparencyType (const TransparencyType type)
void	setTransparentDelayedObjectRenderType (TransparentDelayedObjectRenderType type)
void	setUpdateArea (const SbVec2f &origin, const SbVec2f &size)
void	setViewportRegion (const SbViewportRegion &newregion)
Public Member Functions inherited from SoAction
virtual	~SoAction (void)
void	apply (SoAction *beingApplied)
const SoPath *	getCurPath (void)
PathCode	getCurPathCode (void) const
virtual SoNode *	getCurPathTail (void)
SoNode *	getNodeAppliedTo (void) const
const SoPathList *	getOriginalPathListAppliedTo (void) const
SoPath *	getPathAppliedTo (void) const
PathCode	getPathCode (int &numindices, const int *&indices)
const SoPathList *	getPathListAppliedTo (void) const
SoState *	getState (void) const
AppliedCode	getWhatAppliedTo (void) const
SbBool	hasTerminated (void) const
SbBool	isLastPathListAppliedTo (void) const
virtual SbBool	isOfType (SoType type) const
void	popCurPath (const PathCode prevpathcode)
void	popCurPath (void)
void	popPushCurPath (const int childindex, SoNode *node=NULL)
void	pushCurPath (const int childindex, SoNode *node=NULL)
void	pushCurPath (void)
void	switchToNodeTraversal (SoNode *node)
void	switchToPathTraversal (SoPath *path)
void	traverse (SoNode *const node)
void	usePathCode (int &numindices, const int *&indices)

Static Public Member Functions
static void	addMethod (const SoType type, SoActionMethod method)
static void	enableElement (const SoType type, const int stackindex)
static SoType	getClassTypeId (void)
static void	initClass (void)
Static Public Member Functions inherited from SoGLRenderAction
static void	addMethod (const SoType type, SoActionMethod method)
static void	enableElement (const SoType type, const int stackindex)
static SoType	getClassTypeId (void)
static void	initClass (void)
Static Public Member Functions inherited from SoAction
static SoType	getClassTypeId (void)
static void	initClass (void)
static void	initClasses (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 SoActionMethodList *	getClassActionMethods (void)
static SoEnabledElementsList *	getClassEnabledElements (void)
Static Protected Member Functions inherited from SoGLRenderAction
static SoActionMethodList *	getClassActionMethods (void)
static SoEnabledElementsList *	getClassEnabledElements (void)
Static Protected Member Functions inherited from SoAction
static SoActionMethodList *	getClassActionMethods (void)
static SoEnabledElementsList *	getClassEnabledElements (void)

Protected Attributes
SbBool	hlVisible
Protected Attributes inherited from SoAction
SoState *	state
SoActionMethodList *	traversalMethods

Additional Inherited Members
Public Types inherited from SoGLRenderAction
enum	AbortCode { CONTINUE , ABORT , PRUNE , DELAY }
typedef AbortCode	SoGLRenderAbortCB(void *userdata)
enum	SortedObjectOrderStrategy { BBOX_CENTER , BBOX_CLOSEST_CORNER , BBOX_FARTHEST_CORNER , CUSTOM_CALLBACK }
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 }
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 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() [1/2]

SoBoxHighlightRenderAction::SoBoxHighlightRenderAction

(

void

)

Default constructor. Note: passes a default SbViewportRegion to the parent constructor.

SoBoxHighlightRenderAction() [2/2]

SoBoxHighlightRenderAction::SoBoxHighlightRenderAction

(

const SbViewportRegion &

viewportregion

)

Constructor, taking an explicit viewportregion to render.

~SoBoxHighlightRenderAction()

SoBoxHighlightRenderAction::~SoBoxHighlightRenderAction ( void )

virtual

Destructor.

Member Function Documentation

addMethod()

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

apply() [1/3]

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.

apply() [2/3]

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

apply() [3/3]

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.

enableElement()

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

getClassActionMethods()

SoActionMethodList * SoBoxHighlightRenderAction::getClassActionMethods ( void )

staticprotected

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.

getClassEnabledElements()

SoEnabledElementsList * SoBoxHighlightRenderAction::getClassEnabledElements ( void )

staticprotected

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.

getClassTypeId()

SoType SoBoxHighlightRenderAction::getClassTypeId ( void )

static

This static method returns the SoType object associated with objects of this class.

getColor()

const SbColor & SoBoxHighlightRenderAction::getColor

(

void

)

Returns the rendering color of the highlighted boxes.

getEnabledElements()

const SoEnabledElementsList & SoBoxHighlightRenderAction::getEnabledElements ( void ) const

protectedvirtual

Returns list of enabled elements.

Reimplemented from SoGLRenderAction.

getLinePattern()

unsigned short SoBoxHighlightRenderAction::getLinePattern

(

void

)

const

Returns the line pattern used when drawing boxes.

getLineWidth()

float SoBoxHighlightRenderAction::getLineWidth

(

void

)

const

Returns the line width used when drawing highlight boxes.

getTypeId()

SoType SoBoxHighlightRenderAction::getTypeId ( void ) const

virtual

Returns the type identification of an object derived from a class inheriting SoAction. This is used for runtime type checking and "downward" casting.

Reimplemented from SoGLRenderAction.

initClass()

void SoBoxHighlightRenderAction::initClass ( void )

static

Initializes the runtime type system for this class, and sets up the enabled elements and action method list.

isVisible()

SbBool SoBoxHighlightRenderAction::isVisible

(

void

)

const

Returns TRUE if highlighted boxes are visible otherwise FALSE.

setColor()

void SoBoxHighlightRenderAction::setColor

(

const SbColor &

color

)

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

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).

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.

setVisible()

void SoBoxHighlightRenderAction::setVisible

(

const SbBool

visible

)

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

Member Data Documentation

hlVisible

SoBoxHighlightRenderAction::hlVisible

protected

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

---

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

• SoBoxHighlightRenderAction.h
• SoBoxHighlightRenderAction.cpp