SoLineHighlightRenderAction Class Reference
[Actions]
Selection highlight style. More...
#include <Inventor/actions/SoLineHighlightRenderAction.h>
Public Member Functions | |
| virtual SoType | getTypeId () const |
| SoLineHighlightRenderAction () | |
| SoLineHighlightRenderAction (const SbViewportRegion &viewportRegion) | |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
Deprecated | |
|
| |
| virtual SoDEPRECATED void | clearApplyResult () |
| virtual SoDEPRECATED void | apply (SoPath *path) |
| virtual SoDEPRECATED void | apply (const SoPathList &pathList, SbBool obeysRules=FALSE) |
| virtual void | apply (SoNode *node) |
| void | setVisible (SbBool b) |
| SbBool | isVisible () const |
| void | setColor (const SbColor &c) |
| const SbColor & | getColor () |
| void | setLinePattern (unsigned short pattern) |
| unsigned short | getLinePattern () |
| void | setLineWidth (float width) |
| float | getLineWidth () |
| void | setPointSize (float size) |
| float | getPointSize () |
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 SoWinRenderArea to have an effect on scene graphs.
EXAMPLE
- Here is an example of how a line highlight can be specified for a particular selection node and render area.
SoWinRenderArea *myRenderArea;
SoSelection *mySelection;
// Set the highlight render action
myRenderArea->setGLRenderAction(
new SoLineHighlightRenderAction());
// Automatic redraw on selection changes
myRenderArea->redrawOnSelectionChange(mySelection);
SEE ALSO
SoBoxHighlightRenderAction, SoGLRenderAction, SoSelection, SoWinRenderArea, SoDrawStyle, SoInteraction
Constructor & Destructor Documentation
| SoLineHighlightRenderAction::SoLineHighlightRenderAction | ( | ) |
Constructor.
| SoLineHighlightRenderAction::SoLineHighlightRenderAction | ( | const SbViewportRegion & | viewportRegion | ) |
Constructor which takes the normal SoGLRenderAction parameters.
Member Function Documentation
| virtual void SoLineHighlightRenderAction::apply | ( | SoNode * | node | ) | [virtual] |
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.
Reimplemented from SoGLRenderAction.
| virtual SoDEPRECATED void SoLineHighlightRenderAction::apply | ( | const SoPathList & | pathList, | |
| SbBool | obeysRules = FALSE | |||
| ) | [inline, virtual] |
- Deprecated:
-
Deprecated since Open Inventor 9810
No longer used.
Reimplemented from SoGLRenderAction.
| virtual SoDEPRECATED void SoLineHighlightRenderAction::apply | ( | SoPath * | path | ) | [inline, virtual] |
- Deprecated:
-
Deprecated since Open Inventor 9810
No longer used.
Reimplemented from SoGLRenderAction.
| virtual SoDEPRECATED void SoLineHighlightRenderAction::clearApplyResult | ( | ) | [inline, virtual] |
- Deprecated:
-
Deprecated since Open Inventor 9810
No longer used.
When applied, an action may reference nodes or create objects (e.g. SoPath) that reference nodes. This is especially true for SoSearchAction and SoRayPickAction. These references will prevent the nodes from being destroyed and so may appear to be a "memory leak".All references are cleared when the action is destroyed or re-applied. However it may be useful to clear them explicitly to remove references to nodes.
Reimplemented from SoAction.
| static SoType SoLineHighlightRenderAction::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoGLRenderAction.
| const SbColor& SoLineHighlightRenderAction::getColor | ( | ) |
Gets the color of the highlight.
| unsigned short SoLineHighlightRenderAction::getLinePattern | ( | ) |
Gets the line pattern of the highlight.
| float SoLineHighlightRenderAction::getLineWidth | ( | ) |
Gets the line width of the highlight.
| float SoLineHighlightRenderAction::getPointSize | ( | ) |
Gets the point size of the highlight.
| virtual SoType SoLineHighlightRenderAction::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Reimplemented from SoGLRenderAction.
| SbBool SoLineHighlightRenderAction::isVisible | ( | ) | const [inline] |
Returns whether highlights will be rendered or not.
| void SoLineHighlightRenderAction::setColor | ( | const SbColor & | c | ) |
Sets the color of the highlight.
Default is red (1,0,0). The application is responsible for forcing a redraw of the scene to see the effects of this change.
| void SoLineHighlightRenderAction::setLinePattern | ( | unsigned short | pattern | ) |
Sets the line pattern of the highlight.
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 effects of this change.
| void SoLineHighlightRenderAction::setLineWidth | ( | float | width | ) |
Sets the line width of the highlight.
Default is 3. The application is responsible for forcing a redraw of the scene to see the effects of this change.
| void SoLineHighlightRenderAction::setPointSize | ( | float | size | ) |
Sets the size of points (diameter in pixels) rendered by the highlight.
Default is 1. Value must be greater than zero. Only applies to point primitives, e.g. SoPointSet.
| void SoLineHighlightRenderAction::setVisible | ( | SbBool | b | ) |
This provides a convenient mechanism for turning highlights off or back on.
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.
The documentation for this class was generated from the following file:
- Inventor/actions/SoLineHighlightRenderAction.h