SoHighlightRenderAction Class Reference
[Actions]
Abstract base class for Highlight Render Actions. More...
#include <Inventor/actions/SoHighlightRenderAction.h>
Public Member Functions | |
| virtual SoType | getTypeId () const |
| virtual void | clearApplyResult () |
| virtual void | apply (SoNode *node) |
| void | setVisible (SbBool b) |
| SbBool | isVisible () const |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
Friends | |
| class | ::SoHighlightRenderActionSync |
| class | ::SoTraversalPassHighlight |
| class | inventor::impl::SoHighlightRenderActionImpl |
Detailed Description
Abstract base class for Highlight Render Actions.
To implement a new Highlight Render Action, the methods getPreTraversalNode() and getPostTraversalNode() can be implemented.
If a more complex highlighting is needed, then the apply() method can be re-implemented instead.
SEE ALSO
SoLineHighlightRenderAction, SoColorHighlightRenderAction, SoBoxHighlightRenderAction, SoHaloHighlightRenderAction, SoGLRenderAction, SoSelection, SoWinRenderArea, SoDrawStyle, SoInteraction
Member Function Documentation
| virtual void SoHighlightRenderAction::apply | ( | SoNode * | node | ) | [virtual] |
This renders the passed scene graph, and also renders highlighted selected objects as specified by the first SoSelection node found in the scene graph.
Reimplemented from SoGLRenderAction.
Reimplemented in SoBoxHighlightRenderAction.
| virtual void SoHighlightRenderAction::clearApplyResult | ( | ) | [virtual] |
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 SoHighlightRenderAction::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoGLRenderAction.
Reimplemented in SoBoxHighlightRenderAction, SoColorHighlightRenderAction, SoHaloHighlightRenderAction, and SoLineHighlightRenderAction.
| virtual SoType SoHighlightRenderAction::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Reimplemented from SoGLRenderAction.
Reimplemented in SoBoxHighlightRenderAction, SoColorHighlightRenderAction, SoHaloHighlightRenderAction, and SoLineHighlightRenderAction.
| SbBool SoHighlightRenderAction::isVisible | ( | ) | const |
Returns whether highlights will be rendered or not.
| void SoHighlightRenderAction::setVisible | ( | SbBool | b | ) |
This provides a convenient mechanism for turning highlights off or 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.
Friends And Related Function Documentation
friend class ::SoHighlightRenderActionSync [friend] |
friend class ::SoTraversalPassHighlight [friend] |
friend class inventor::impl::SoHighlightRenderActionImpl [friend] |
The documentation for this class was generated from the following file:
- Inventor/actions/SoHighlightRenderAction.h