Open Inventor Release 2024.1.3
 
Loading...
Searching...
No Matches
SiRenderArea Class Referenceabstract

VSG extension RenderArea interface. More...

#include <Inventor/ViewerComponents/SiRenderArea.h>

+ Inheritance diagram for SiRenderArea:

Classes

struct  RenderEventArg
 Structure given when a start render event is raised. More...
 

Public Types

enum  ClearPolicy {
  NONE ,
  COLORBUFFER ,
  DEPTHBUFFER ,
  COLORBUFFER_AND_DEPTHBUFFER
}
 Policy values to clear color and depth buffers beforing rendering. More...
 
enum  RenderStatus {
  ABORTED ,
  INTERACTIVE ,
  STILL
}
 Returned by the render method. More...
 

Public Member Functions

virtual void setSceneGraph (SoNode *newScene)=0
 Defines the scene graph which is managed here.
 
virtual SoNodegetSceneGraph () const =0
 
virtual void setClearPolicy (ClearPolicy policy)=0
 Defines the color buffer and depth buffer clear policy.
 
virtual ClearPolicy getClearPolicy () const =0
 
virtual void setClearColor (const SbColorRGBA &color)=0
 Defines the RGBA value used when the color buffer is cleared.
 
virtual SbColorRGBA getClearColor () const =0
 
virtual void setClearDepth (float depth)=0
 Defines the depth value used when the depth buffer is cleared.
 
virtual float getClearDepth () const =0
 
virtual void setSize (const SbVec2i32 &size)=0
 Defines the size to use for rendering.
 
virtual SbVec2i32 getSize () const =0
 
virtual RenderStatus render ()=0
 Render the managed scene graph (see setSceneGraph).
 
virtual SbEventHandler< RenderEventArg & > & onStartRender ()=0
 Returns the event handler that raises when a new render starts.
 

Detailed Description

VSG extension RenderArea interface.

This interface provides the list of methods that a renderArea classs must define.

SEE ALSO

RenderArea

Definition at line 43 of file SiRenderArea.h.

Member Enumeration Documentation

◆ ClearPolicy

Policy values to clear color and depth buffers beforing rendering.

Enumerator
NONE 

Do not clear both color buffer and depth buffer beforing rendering.

COLORBUFFER 

Clear only color buffer beforing rendering.

DEPTHBUFFER 

Clear only depth buffer beforing rendering.

COLORBUFFER_AND_DEPTHBUFFER 

Clear both color buffer and depth buffer beforing rendering.

Definition at line 64 of file SiRenderArea.h.

◆ RenderStatus

Returned by the render method.

Enumerator
ABORTED 

The frame rendering has been ended before its completion.

INTERACTIVE 

The frame has been rendered in interactive mode (some shapes may have been rendered with low quality settings)

STILL 

The frame has been rendered in still mode.

Definition at line 128 of file SiRenderArea.h.

Member Function Documentation

◆ getClearColor()

virtual SbColorRGBA SiRenderArea::getClearColor ( ) const
pure virtual

◆ getClearDepth()

virtual float SiRenderArea::getClearDepth ( ) const
pure virtual

◆ getClearPolicy()

virtual ClearPolicy SiRenderArea::getClearPolicy ( ) const
pure virtual

◆ getSceneGraph()

virtual SoNode * SiRenderArea::getSceneGraph ( ) const
pure virtual

◆ getSize()

virtual SbVec2i32 SiRenderArea::getSize ( ) const
pure virtual

◆ onStartRender()

virtual SbEventHandler< RenderEventArg & > & SiRenderArea::onStartRender ( )
pure virtual

Returns the event handler that raises when a new render starts.

Implemented in SoOffscreenRenderArea, RenderArea, and SoRenderAreaCore.

◆ render()

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.

◆ setClearColor()

virtual void SiRenderArea::setClearColor ( const SbColorRGBA color)
pure virtual

Defines the RGBA value used when the color buffer is cleared.

See also setClearPolicy.

Parameters
colorRGBA value used to clear the color buffer.

Implemented in SoOffscreenRenderArea, RenderArea, SoRenderAreaCore, and openinventor::inventor::viewercomponents::qt::qml::RenderArea.

◆ setClearDepth()

virtual void SiRenderArea::setClearDepth ( float  depth)
pure virtual

Defines the depth value used when the depth buffer is cleared.

See also setClearPolicy.

Parameters
depthvalue used to clear the depth buffer.

Implemented in SoOffscreenRenderArea, RenderArea, SoRenderAreaCore, and openinventor::inventor::viewercomponents::qt::qml::RenderArea.

◆ setClearPolicy()

virtual void SiRenderArea::setClearPolicy ( ClearPolicy  policy)
pure virtual

Defines the color buffer and depth buffer clear policy.

See also setClearColor and setClearDepth.

Parameters
policycolor buffer and depth buffer clear policy.

Implemented in SoOffscreenRenderArea, RenderArea, SoRenderAreaCore, and openinventor::inventor::viewercomponents::qt::qml::RenderArea.

◆ setSceneGraph()

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.

Parameters
newScenescene graph.

Implemented in SoOffscreenRenderArea, SoRenderAreaCore, RenderArea, RenderAreaInteractive, openinventor::inventor::viewercomponents::qt::qml::RenderArea, and openinventor::inventor::viewercomponents::qt::qml::RenderAreaInteractive.

◆ setSize()

virtual void SiRenderArea::setSize ( const SbVec2i32 size)
pure virtual

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