Interface SiRenderArea
-
- All Known Implementing Classes:
SoOffscreenRenderArea
,SoRenderAreaCore
public interface SiRenderArea
RenderArea interface. This interface provides the list of methods that a renderArea classs must define.RenderArea
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
SiRenderArea.ClearPolicies
Policy values to clear color and depth buffers beforing rendering.static class
SiRenderArea.RenderEventArg
Structure given when a start render event is raised.static class
SiRenderArea.RenderStatus
Returned by the render method.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description SbColorRGBA
getClearColor()
float
getClearDepth()
SiRenderArea.ClearPolicies
getClearPolicy()
SoNode
getSceneGraph()
SbVec2i32
getSize()
SbEventHandler<SiRenderArea.RenderEventArg>
onStartRender()
Returns the event handler that raises when a new render starts.SiRenderArea.RenderStatus
render()
Render the managed scene graph (see setSceneGraph).void
setClearColor(SbColorRGBA color)
Defines the RGBA value used when the color buffer is cleared.void
setClearDepth(float depth)
Defines the depth value used when the depth buffer is cleared.void
setClearPolicy(SiRenderArea.ClearPolicies policy)
Defines the color buffer and depth buffer clear policy.void
setSceneGraph(SoNode newScene)
Defines the scene graph which is managed here.void
setSize(SbVec2i32 size)
Defines the size to use for rendering.
-
-
-
Method Detail
-
onStartRender
SbEventHandler<SiRenderArea.RenderEventArg> onStartRender()
Returns the event handler that raises when a new render starts.
-
setClearPolicy
void setClearPolicy(SiRenderArea.ClearPolicies policy)
Defines the color buffer and depth buffer clear policy. See also setClearColor and setClearDepth.- Parameters:
policy
- color buffer and depth buffer clear policy.
-
render
SiRenderArea.RenderStatus render()
Render the managed scene graph (see setSceneGraph). See RenderStatus documentation for details on the returned value.
-
setSceneGraph
void setSceneGraph(SoNode newScene)
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.
-
getSceneGraph
SoNode getSceneGraph()
- See Also:
setSceneGraph()
-
getClearDepth
float getClearDepth()
- See Also:
setClearDepth()
-
getClearColor
SbColorRGBA getClearColor()
- See Also:
setClearColor()
-
setClearDepth
void setClearDepth(float depth)
Defines the depth value used when the depth buffer is cleared. See also setClearPolicy.- Parameters:
depth
- value used to clear the depth buffer.
-
getClearPolicy
SiRenderArea.ClearPolicies getClearPolicy()
- See Also:
setClearPolicy()
-
setSize
void setSize(SbVec2i32 size)
Defines the size to use for rendering.
-
setClearColor
void setClearColor(SbColorRGBA color)
Defines the RGBA value used when the color buffer is cleared. See also setClearPolicy.- Parameters:
color
- RGBA value used to clear the color buffer.
-
-