RenderArea interface. More...
#include <Inventor/ViewerComponents/SiRenderArea.h>
Classes | |
struct | RenderEventArg |
Structure given when a start render event is raised. More... | |
Public Types | |
enum | ClearPolicy { NONE, COLORBUFFER, DEPTHBUFFER, COLORBUFFER_AND_DEPTHBUFFER } |
enum | RenderStatus { ABORTED, INTERACTIVE, STILL } |
Public Member Functions | |
virtual void | setSceneGraph (SoNode *newScene)=0 |
virtual SoNode * | getSceneGraph () const =0 |
virtual void | setClearPolicy (ClearPolicy policy)=0 |
virtual ClearPolicy | getClearPolicy () const =0 |
virtual void | setClearColor (const SbColorRGBA &color)=0 |
virtual SbColorRGBA | getClearColor () const =0 |
virtual void | setClearDepth (float depth)=0 |
virtual float | getClearDepth () const =0 |
virtual void | setSize (const SbVec2i32 &size)=0 |
virtual SbVec2i32 | getSize () const =0 |
virtual RenderStatus | render ()=0 |
virtual SbEventHandler < RenderEventArg & > & | onStartRender ()=0 |
This interface provides the list of methods that a renderArea classs must define.
Policy values to clear color and depth buffers beforing rendering.
virtual SbColorRGBA SiRenderArea::getClearColor | ( | ) | const [pure virtual] |
Implemented in SoOffscreenRenderArea, openinventor::inventor::viewercomponents::qt::qml::RenderArea, RenderArea, and SoRenderAreaCore.
virtual float SiRenderArea::getClearDepth | ( | ) | const [pure virtual] |
Implemented in SoOffscreenRenderArea, openinventor::inventor::viewercomponents::qt::qml::RenderArea, RenderArea, and SoRenderAreaCore.
virtual ClearPolicy SiRenderArea::getClearPolicy | ( | ) | const [pure virtual] |
Implemented in SoOffscreenRenderArea, openinventor::inventor::viewercomponents::qt::qml::RenderArea, RenderArea, and SoRenderAreaCore.
virtual SoNode* SiRenderArea::getSceneGraph | ( | ) | const [pure virtual] |
Implemented in SoOffscreenRenderArea, openinventor::inventor::viewercomponents::qt::qml::RenderArea, RenderArea, and SoRenderAreaCore.
virtual SbVec2i32 SiRenderArea::getSize | ( | ) | const [pure virtual] |
Implemented in SoOffscreenRenderArea, openinventor::inventor::viewercomponents::qt::qml::RenderArea, RenderArea, and SoRenderAreaCore.
virtual SbEventHandler<RenderEventArg&>& SiRenderArea::onStartRender | ( | ) | [pure virtual] |
Returns the event handler that raises when a new render starts.
Implemented in SoOffscreenRenderArea, RenderArea, and SoRenderAreaCore.
virtual RenderStatus SiRenderArea::render | ( | ) | [pure virtual] |
Render the managed scene graph (see setSceneGraph).
See RenderStatus documentation for details on the returned value.
Implemented in SoOffscreenRenderArea, and SoRenderAreaCore.
virtual void SiRenderArea::setClearColor | ( | const SbColorRGBA & | color | ) | [pure virtual] |
Defines the RGBA value used when the color buffer is cleared.
See also setClearPolicy.
color | RGBA value used to clear the color buffer. |
Implemented in SoOffscreenRenderArea, openinventor::inventor::viewercomponents::qt::qml::RenderArea, RenderArea, and SoRenderAreaCore.
virtual void SiRenderArea::setClearDepth | ( | float | depth | ) | [pure virtual] |
Defines the depth value used when the depth buffer is cleared.
See also setClearPolicy.
depth | value used to clear the depth buffer. |
Implemented in SoOffscreenRenderArea, openinventor::inventor::viewercomponents::qt::qml::RenderArea, RenderArea, and SoRenderAreaCore.
virtual void SiRenderArea::setClearPolicy | ( | ClearPolicy | policy | ) | [pure virtual] |
Defines the color buffer and depth buffer clear policy.
See also setClearColor and setClearDepth.
policy | color buffer and depth buffer clear policy. |
Implemented in SoOffscreenRenderArea, openinventor::inventor::viewercomponents::qt::qml::RenderArea, RenderArea, and SoRenderAreaCore.
virtual void SiRenderArea::setSceneGraph | ( | SoNode * | newScene | ) | [pure virtual] |
Defines the scene graph which is managed here.
This is the Open Inventor scene which will be traversed for rendering and event processing.
newScene | scene graph. |
Implemented in SoOffscreenRenderArea, openinventor::inventor::viewercomponents::qt::qml::RenderArea, openinventor::inventor::viewercomponents::qt::qml::RenderAreaInteractive, RenderArea, RenderAreaInteractive, and SoRenderAreaCore.
virtual void SiRenderArea::setSize | ( | const SbVec2i32 & | size | ) | [pure virtual] |
Defines the size to use for rendering.
Implemented in SoOffscreenRenderArea, openinventor::inventor::viewercomponents::qt::qml::RenderArea, RenderArea, and SoRenderAreaCore.