SiRenderArea Class Reference
[Viewer Components]

RenderArea interface. More...

#include <Inventor/ViewerComponents/SiRenderArea.h>

Inheritance diagram for SiRenderArea:

List of all members.

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

---

Detailed Description

RenderArea interface.

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

SEE ALSO

RenderArea

---

Member Enumeration Documentation

enum SiRenderArea::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.

enum SiRenderArea::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.

---

Member Function Documentation

virtual SbColorRGBA SiRenderArea::getClearColor

(

)

const [pure virtual]

See also:

setClearColor().

Implemented in RenderArea, and SoRenderAreaCore.

virtual float SiRenderArea::getClearDepth

(

)

const [pure virtual]

See also:

setClearDepth().

Implemented in RenderArea, and SoRenderAreaCore.

virtual ClearPolicy SiRenderArea::getClearPolicy

(

)

const [pure virtual]

See also:

setClearPolicy().

Implemented in RenderArea, and SoRenderAreaCore.

virtual SoNode* SiRenderArea::getSceneGraph

(

)

const [pure virtual]

See also:

setSceneGraph().

Implemented in RenderArea, and SoRenderAreaCore.

virtual SbVec2i32 SiRenderArea::getSize

(

)

const [pure virtual]

See also:

setSize().

Implemented in RenderArea, and SoRenderAreaCore.

virtual SbEventHandler<RenderEventArg&>& SiRenderArea::onStartRender

(

)

[pure virtual]

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

Implemented in 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 SoRenderAreaCore.

virtual void SiRenderArea::setClearColor

(

const SbColorRGBA &

color

)

[pure virtual]

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

See also setClearPolicy.

Parameters:

color

RGBA value used to clear the color buffer.

Implemented in 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.

Parameters:

depth

value used to clear the depth buffer.

Implemented in 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.

Parameters:

policy

color buffer and depth buffer clear policy.

Implemented in 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.

Parameters:

newScene

: scene graph to be managed.

Implemented in RenderArea, RenderAreaInteractive, and SoRenderAreaCore.

virtual void SiRenderArea::setSize

(

const SbVec2i32 &

size

)

[pure virtual]

Defines the size to use for rendering.

Implemented in RenderArea, and SoRenderAreaCore.

---

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

• Inventor/ViewerComponents/SiRenderArea.h