SoRenderManager.3coin4 - Man Page

class Superimposition

enum RenderMode { AS_IS, WIREFRAME, POINTS, WIREFRAME_OVERLAY, HIDDEN_LINE, BOUNDING_BOX }
enum StereoMode { MONO, ANAGLYPH, SEPARATE_OUTPUT, QUAD_BUFFER = SEPARATE_OUTPUT, INTERLEAVED_ROWS, INTERLEAVED_COLUMNS }
enum BufferType { BUFFER_SINGLE, BUFFER_DOUBLE }
enum AutoClippingStrategy { NO_AUTO_CLIPPING, FIXED_NEAR_PLANE, VARIABLE_NEAR_PLANE }

SoRenderManager (void)
virtual ~SoRenderManager ()
virtual void render (const SbBool clearwindow=TRUE, const SbBool clearzbuffer=TRUE)
virtual void render (SoGLRenderAction *action, const SbBool initmatrices=TRUE, const SbBool clearwindow=TRUE, const SbBool clearzbuffer=TRUE)
Superimposition * addSuperimposition (SoNode *scene, uint32_t flags=Superimposition::AUTOREDRAW|Superimposition::ZBUFFERON|Superimposition::CLEARZBUFFER)
void removeSuperimposition (Superimposition *s)
virtual void setSceneGraph (SoNode *const sceneroot)
virtual SoNode * getSceneGraph (void) const
void setCamera (SoCamera *camera)
SoCamera * getCamera (void) const
void setAutoClipping (AutoClippingStrategy autoclipping)
AutoClippingStrategy getAutoClipping (void) const
void setNearPlaneValue (float value)
float getNearPlaneValue (void) const
void setTexturesEnabled (const SbBool onoff)
SbBool isTexturesEnabled (void) const
void setDoubleBuffer (const SbBool enable)
SbBool isDoubleBuffer (void) const
void setRenderMode (const RenderMode mode)
RenderMode getRenderMode (void) const
void setStereoMode (const StereoMode mode)
StereoMode getStereoMode (void) const
void setStereoOffset (const float offset)
float getStereoOffset (void) const
void setRenderCallback (SoRenderManagerRenderCB *f, void *const userData=NULL)
SbBool isAutoRedraw (void) const
void setRedrawPriority (const uint32_t priority)
uint32_t getRedrawPriority (void) const
void scheduleRedraw (void)
void setWindowSize (const SbVec2s &newsize)
const SbVec2s & getWindowSize (void) const
void setSize (const SbVec2s &newsize)
const SbVec2s & getSize (void) const
void setOrigin (const SbVec2s &newOrigin)
const SbVec2s & getOrigin (void) const
void setViewportRegion (const SbViewportRegion &newRegion)
const SbViewportRegion & getViewportRegion (void) const
void setBackgroundColor (const SbColor4f &color)
const SbColor4f & getBackgroundColor (void) const
void setOverlayColor (const SbColor4f &color)
SbColor4f getOverlayColor (void) const
void setBackgroundIndex (const int index)
int getBackgroundIndex (void) const
void setRGBMode (const SbBool onOrOff)
SbBool isRGBMode (void) const
virtual void activate (void)
virtual void deactivate (void)
void setAntialiasing (const SbBool smoothing, const int numPasses)
void getAntialiasing (SbBool &smoothing, int &numPasses) const
void setGLRenderAction (SoGLRenderAction *const action)
SoGLRenderAction * getGLRenderAction (void) const
void setAudioRenderAction (SoAudioRenderAction *const action)
SoAudioRenderAction * getAudioRenderAction (void) const
void addPreRenderCallback (SoRenderManagerRenderCB *cb, void *data)
void removePreRenderCallback (SoRenderManagerRenderCB *cb, void *data)
void addPostRenderCallback (SoRenderManagerRenderCB *cb, void *data)
void removePostRenderCallback (SoRenderManagerRenderCB *cb, void *data)
void reinitialize (void)

static void enableRealTimeUpdate (const SbBool flag)
static SbBool isRealTimeUpdateEnabled (void)
static uint32_t getDefaultRedrawPriority (void)

int isActive (void) const
void redraw (void)
void renderScene (SoGLRenderAction *action, SoNode *scene, uint32_t clearmask)
void actuallyRender (SoGLRenderAction *action, const SbBool initmatrices=TRUE, const SbBool clearwindow=TRUE, const SbBool clearzbuffer=TRUE)
void renderSingle (SoGLRenderAction *action, SbBool initmatrices, SbBool clearwindow, SbBool clearzbuffer)
Render once in correct draw style.
void renderStereo (SoGLRenderAction *action, SbBool initmatrices, SbBool clearwindow, SbBool clearzbuffer)
Render scene according to current stereo mode.
void initStencilBufferForInterleavedStereo (void)
void clearBuffers (SbBool color, SbBool depth)

Sets how rendering of primitives is done.

Enumerator

AS_IS

Render primitives as they are described in the scene graph.

WIREFRAME

Render polygons as wireframe

POINTS

Render only the vertices of the polygons and lines.

WIREFRAME_OVERLAY

Render a wireframe overlay in addition to the AS_IS mode

HIDDEN_LINE

As WIREFRAME, but culls lines which would otherwise not be shown due to geometric culling.

BOUNDING_BOX

Only show the bounding box of each object.

Manages how to render stereoscopic images.

Enumerator

MONO

No stereoscopic rendering

ANAGLYPH

Anaglyph rendering is used to provide a stereoscopic 3D effect, when viewed with 3D glasses. The image is made up of two color layers which are superimposed on each other, and appears as 3 dimensional when viewed through corresponding colored filters (glasses)

SEPARATE_OUTPUT

Send output to separate buffers.

QUAD_BUFFER

Same as SEPARATE_OUTPUT, SEPARATE_OUTPUT is more commonly known as QUAD_BUFFER, when also using double buffering.

INTERLEAVED_ROWS

Render every second row as left and right image. If rendered with a polarized projector, polarized filters can be used to give a 3D effect.

INTERLEAVED_COLUMNS

Render every second column as left and right image. If rendered with a polarized projector, polarized filters can be used to give a 3D effect.

Buffering strategy

Enumerator

BUFFER_SINGLE

Output to one buffer

BUFFER_DOUBLE

Alternate between output buffers

Strategy for adjusting camera near/far clipping plane

Enumerator

NO_AUTO_CLIPPING

Turn off automatic clipping. The user needs to set the correct values in the camera.

FIXED_NEAR_PLANE

Keep near plane at a fixed distance from the camera. The far plane is always set at the end of the bounding box.

VARIABLE_NEAR_PLANE

Variable adjustment of the near plane relative to the camera.

Constructor.

Destructor.

Render the scene graph.

All SbBool arguments should normally be TRUE, but they can be set to FALSE to optimize for special cases (e.g. when doing wireframe rendering one doesn't need a depth buffer).

Parameters

clearwindow If set to TRUE, clear the rendering buffer before drawing.
clearzbuffer If set to TRUE, clear the depth buffer values before rendering.

Render the scene graph.

All SbBool arguments should normally be TRUE, but they can be set to FALSE to optimize for special cases (e.g. when doing wireframe rendering one doesn't need a depth buffer).

Parameters

clearwindow If set to TRUE, clear the rendering buffer before drawing.
clearzbuffer If set to TRUE, clear the depth buffer values before rendering.  
initmatrices If set to TRUE, the projection and modelview matrices are reset to identity.
action Renders with a user supplied action.

Add a superimposition for this scene graph. A superimposition can either be a scene rendered in the background, or a scene rendered in the front of the actual scene graph.

This is useful, for instance, if you want to add a gradient or an image in the background, and for having some HUD info in the foreground.

Please note that if you use superimpositions, multipass antialiasing have to be handled in the render manager, and not in SoGLRenderAction, so the pass update features in SoGLRenderAction will be disabled.

See also

SoGLRenderAction::setNumPasses()

SoGLRenderAction::setPassUpdate()

SoGLRenderAction::setPassCallback()

Removes a superimposition.

See also

addSuperimposition()

Set the node which is top of the scene graph we're managing. The sceneroot node reference count will be increased by 1, and any previously set scene graph top node will have its reference count decreased by 1.

See also

getSceneGraph()

Returns the pointer to root of scene graph.

Sets the camera to be used.

Returns the current camera.

Sets strategy for adjusting camera clipping plane

See also

SoRenderManager::AutoClippingStrategy

This method returns the current auto clipping strategy.

See also

setAutoClipping

When the SoRenderManager::FIXED_NEAR_PLANE auto clipping strategy is used, you set the value of the near plane distance with this method.

See also

setAutoClipping, getNearPlaneValue, SoRenderManager::AutoClippingStrategy

This method returns the near plane distance value that will be used when the SoRenderManager::FIXED_NEAR_PLANE auto clipping strategy is used.

Default value is 0.6.

See also

setAutoClipping, setNearPlaneValue, SoRenderManager::AutoClippingStrategy

Enable/disable textures when rendering. Defaults to TRUE.

See also

isTexturesEnabled

Returns whether textures are enabled or not.

See also

setTexturesEnabled

Tell the scene manager that double buffering is used

returns if the scene manager is double buffered

Sets the render mode.

Returns the current render mode.

Sets the stereo mode.

Returns the current stereo mode.

Sets the stereo offset used when doing stereo rendering.

Returns the current stereo offset.

Set the callback function f to invoke when rendering the scene. userdata will be passed as the first argument of the function.

Returns TRUE if the SoRenderManager automatically redraws the scene upon detecting changes in the scene graph.

The automatic redraw is turned on and off by setting either a valid callback function with setRenderCallback(), or by passing NULL.

Set up the redraw priority for the SoOneShotSensor used to trigger redraws. By setting this lower than for your own sensors, you can make sure some code is always run before redraw happens.

See also

SoDelayQueueSensor

Returns value of priority on the redraw sensor.

Redraw at first opportunity as system becomes idle.

Multiple calls to this method before an actual redraw have taken place will only result in a single redraw of the scene.

Update window size of our SoGLRenderAction's viewport settings.

Note that this will only change the information about window dimensions, the actual viewport size and origin (i.e. the rectangle which redraws are confined to) will stay the same.

See also

setViewportRegion()

Returns the current render action window size.

See also

setWindowSize()

Set size of rendering area for the viewport within the current window.

Returns size of render area.

Set only the origin of the viewport region within the rendering window.

See also

setViewportRegion(), setWindowSize()

Returns origin of rendering area viewport.

See also

setOrigin()

Update our SoGLRenderAction's viewport settings.

This will change both the information about window dimensions and the actual viewport size and origin.

See also

setWindowSize()

Returns current viewport region used by the render action and the event handling.

See also

setViewportRegion()

Sets color of rendering canvas.

Returns color used for clearing the rendering area before rendering the scene.

Sets color of overlay.

Returns color used rendering overlay.

Set index of background color in the color lookup table if rendering in color index mode.

Note: color index mode is not supported yet in Coin.

Returns index of color map for background filling.

See also

setBackgroundIndex()

Turn RGB true color mode on or off. If you turn true color mode off, color index mode will be used instead.

Returns the 'truecolor or colorindex' mode flag.

Activate rendering and event handling. Default is off.

Deactivate rendering and event handling.

Turn antialiased rendering on or off.

See documentation for SoGLRenderAction::setSmoothing() and SoGLRenderAction::setNumPasses().

Returns rendering pass information.

See also

setAntialiasing()

Set the action to use for rendering. Overrides the default action made in the constructor.

Returns pointer to render action.

Set the action to use for rendering audio. Overrides the default action made in the constructor.

Returns pointer to audio render action.

Set whether or not for SoRenderManager instances to 'touch' the global realTime field after a redraw. If this is not done, redrawing when animating the scene will only happen as fast as the realTime interval goes (which defaults to 12 times a second).

See also

SoDB::setRealTimeInterval()

Returns whether or not we automatically notify everything connected to the realTime field after a redraw.

Returns the default priority of the redraw sensor.

See also

SoDelayQueueSensor, setRedrawPriority()

Adds a function to be called before rendering starts

Parameters

cb function to be called
data User specified data to supply to callback function

Removes a pre render callback.

Precondition

The tuple (cb, data) must exactly match an earlier call to SoRenderManager::addPreRenderCallback

Parameters

cb function to be called
data User specified data to supply to callback function

Adds a function to be called after rendering is complete

Parameters

cb function to be called
data User specified data to supply to callback function

Removes a post render callback.

Precondition

The tuple (cb, data) must exactly match an earlier call to SoRenderManager::addPostRenderCallback

Parameters

cb function to be called
data User specified data to supply to callback function

Reinitialize after parameters affecting the OpenGL context have changed.

Returns the active flag.

Do an immediate redraw by calling the redraw callback function.

Renders a scene and applies clear state as given by this renderManager

Parameters

action Action to apply
scene Scene to render
clearmask mask to pass to glClear

Convenience function for SoRenderManager::renderScene

Parameters

action Renders with a user supplied action.
initmatrices If set to TRUE, the projection and modelview matrices are reset to identity.
clearwindow If set to TRUE, clear the rendering buffer before drawing.
clearzbuffer If set to TRUE, clear the depth buffer values before rendering.

Render once in correct draw style. Convenience function for SoRenderManager::renderScene

Parameters

action Renders with a user supplied action.
initmatrices If set to TRUE, the projection and modelview matrices are reset to identity.
clearwindow If set to TRUE, clear the rendering buffer before drawing.
clearzbuffer If set to TRUE, clear the depth buffer values before rendering.  

Render scene according to current stereo mode. Convenience function for SoRenderManager::renderScene

Parameters

action Renders with a user supplied action.
initmatrices If set to TRUE, the projection and modelview matrices are reset to identity.
clearwindow If set to TRUE, clear the rendering buffer before drawing.
clearzbuffer If set to TRUE, clear the depth buffer values before rendering.  

Initializes stencil buffers for interleaved stereo

Clears buffers with the background color set correctly

Parameters

color Set to TRUE if color buffer should be cleared
depth Set to TRUE if depth buffer should be cleared