Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

SoBoxHighlightRenderAction Class Reference

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

#include <Inventor/actions/SoBoxHighlightRenderAction.h>

Inheritance diagram for SoBoxHighlightRenderAction::

SoGLRenderAction SoAction List of all members.

Public Methods

 SoBoxHighlightRenderAction (void)
 SoBoxHighlightRenderAction (const SbViewportRegion &viewportregion)
virtual ~SoBoxHighlightRenderAction ()
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 SbColorgetColor (void)
void setLinePattern (unsigned short pattern)
unsigned short getLinePattern (void) const
void setLineWidth (const float width)
float getLineWidth (void) const

Static Public Methods

void initClass (void)

Protected Attributes

SbBool hlVisible

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

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

SoBoxHighlightRenderAction::SoBoxHighlightRenderAction const SbViewportRegion & viewportregion
 

Constructor, taking an explicit viewportregion to render.

SoBoxHighlightRenderAction::~SoBoxHighlightRenderAction void [virtual]
 

Destructor.


Member Function Documentation

void SoBoxHighlightRenderAction::initClass void [static]
 

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

Reimplemented from SoGLRenderAction.

void SoBoxHighlightRenderAction::apply SoNode * node [virtual]
 

Overloaded to add highlighting after the "ordinary" rendering.

Reimplemented from SoAction.

void SoBoxHighlightRenderAction::apply SoPath * path [virtual]
 

This method will just call the SoGLRenderAction::apply() method (so no highlighting will be done).

It has been overloaded to avoid confusing the compiler, which typically want to see either all or none of the apply() methods overloaded.

Reimplemented from SoAction.

void SoBoxHighlightRenderAction::apply const SoPathList & pathlist,
SbBool obeysrules = FALSE
[virtual]
 

This method will just call the SoGLRenderAction::apply() method (so no highlighting will be done).

It has been overloaded to avoid confusing the compiler, which typically want to see either all or none of the apply() methods overloaded.

Reimplemented from SoAction.

void SoBoxHighlightRenderAction::setVisible const SbBool visible
 

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

SbBool SoBoxHighlightRenderAction::isVisible void const
 

Return if highlighted boxes are to be visible.

void SoBoxHighlightRenderAction::setColor const SbColor & color
 

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

const SbColor & SoBoxHighlightRenderAction::getColor void
 

Returns rendering color of the highlighted boxes.

void SoBoxHighlightRenderAction::setLinePattern unsigned short pattern
 

Sets the line pattern used for the highlighted boxes. Defaults to 0xffff (i.e. drawn with no stipples).

unsigned short SoBoxHighlightRenderAction::getLinePattern void const
 

Returns line pattern used when drawing boxes.

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.

float SoBoxHighlightRenderAction::getLineWidth void const
 

Returns the line width used when drawing highlight boxes.


Member Data Documentation

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:
Generated at Tue Mar 5 03:31:22 2002 for Coin by doxygen1.2.9 written by Dimitri van Heesch, © 1997-2001