SoSceneManager Class Reference

The SoSceneManager class provides the main interface between the scene graph and the GUI toolkit. More...

#include <Inventor/SoSceneManager.h>

Public Member Functions
	SoSceneManager (void)
virtual	~SoSceneManager ()
virtual void	activate (void)
virtual void	deactivate (void)
void	getAntialiasing (SbBool &smoothing, int &numPasses) const
SoAudioRenderAction *	getAudioRenderAction (void) const
const SbColor &	getBackgroundColor (void) const
int	getBackgroundIndex (void) const
SoCamera *	getCamera (void) const
SoGLRenderAction *	getGLRenderAction (void) const
SoHandleEventAction *	getHandleEventAction (void) const
const SbVec2s &	getOrigin (void) const
uint32_t	getRedrawPriority (void) const
virtual SoNode *	getSceneGraph (void) const
const SbVec2s &	getSize (void) const
const SbViewportRegion &	getViewportRegion (void) const
const SbVec2s &	getWindowSize (void) const
SbBool	isAutoRedraw (void) const
SbBool	isRGBMode (void) const
virtual SbBool	processEvent (const SoEvent *const event)
void	reinitialize (void)
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)
void	scheduleRedraw (void)
void	setAntialiasing (const SbBool smoothing, const int numPasses)
void	setAudioRenderAction (SoAudioRenderAction *const action)
void	setBackgroundColor (const SbColor &color)
void	setBackgroundIndex (const int index)
void	setCamera (SoCamera *camera)
void	setGLRenderAction (SoGLRenderAction *const action)
void	setHandleEventAction (SoHandleEventAction *hea)
void	setOrigin (const SbVec2s &newOrigin)
void	setRedrawPriority (const uint32_t priority)
void	setRenderCallback (SoSceneManagerRenderCB *f, void *const userData=NULL)
void	setRGBMode (const SbBool onOrOff)
virtual void	setSceneGraph (SoNode *const sceneroot)
void	setSize (const SbVec2s &newsize)
void	setViewportRegion (const SbViewportRegion &newRegion)
void	setWindowSize (const SbVec2s &newsize)

Static Public Member Functions
static void	enableRealTimeUpdate (const SbBool flag)
static uint32_t	getDefaultRedrawPriority (void)
static SbBool	isRealTimeUpdateEnabled (void)

Protected Member Functions
int	isActive (void) const
void	redraw (void)

Detailed Description

The SoSceneManager class provides the main interface between the scene graph and the GUI toolkit.

The render area class from the GUI toolkit you are using uses this class as the interface against the scene graph. Event handling and providing "hooks" to do rendering are the main functions of the class.

A Coin library instance within an application will typically contain a single SoSceneManager object. The pointer for this object is stored in the GUI render area class.

Constructor & Destructor Documentation

SoSceneManager()

SoSceneManager::SoSceneManager

(

void

)

Constructor. Sets up default SoGLRenderAction and SoHandleEventAction instances.

~SoSceneManager()

SoSceneManager::~SoSceneManager ( )

virtual

Destructor.

Member Function Documentation

activate()

void SoSceneManager::activate ( void )

virtual

Activate rendering and event handling. Default is off.

deactivate()

void SoSceneManager::deactivate ( void )

virtual

Deactivate rendering and event handling.

enableRealTimeUpdate()

void SoSceneManager::enableRealTimeUpdate ( const SbBool flag )

static

Set whether or not for SoSceneManager 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()

getAntialiasing()

void SoSceneManager::getAntialiasing	(	SbBool &	smoothing,
		int &	numpasses ) const

Returns rendering pass information.

See also

setAntialiasing()

getAudioRenderAction()

SoAudioRenderAction * SoSceneManager::getAudioRenderAction

(

void

)

const

Returns pointer to audio render action.

getBackgroundColor()

const SbColor & SoSceneManager::getBackgroundColor

(

void

)

const

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

getBackgroundIndex()

int SoSceneManager::getBackgroundIndex

(

void

)

const

Returns index of colormap for background filling.

See also

setBackgroundIndex()

getCamera()

SoCamera * SoSceneManager::getCamera

(

void

)

const

Returns the current camera.

getDefaultRedrawPriority()

uint32_t SoSceneManager::getDefaultRedrawPriority ( void )

static

Returns the default priority of the redraw sensor.

See also

SoDelayQueueSensor, setRedrawPriority()

getGLRenderAction()

SoGLRenderAction * SoSceneManager::getGLRenderAction

(

void

)

const

Returns pointer to render action.

getHandleEventAction()

SoHandleEventAction * SoSceneManager::getHandleEventAction

(

void

)

const

Returns pointer to event handler action.

getOrigin()

const SbVec2s & SoSceneManager::getOrigin

(

void

)

const

Returns origin of rendering area viewport.

See also

setOrigin()

getRedrawPriority()

uint32_t SoSceneManager::getRedrawPriority

(

void

)

const

Returns value of priority on the redraw sensor.

getSceneGraph()

SoNode * SoSceneManager::getSceneGraph ( void ) const

virtual

Returns pointer to root of scene graph.

getSize()

const SbVec2s & SoSceneManager::getSize

(

void

)

const

Returns size of render area.

getViewportRegion()

const SbViewportRegion & SoSceneManager::getViewportRegion

(

void

)

const

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

See also

setViewportRegion()

getWindowSize()

const SbVec2s & SoSceneManager::getWindowSize

(

void

)

const

Returns the current render action window size.

See also

setWindowSize()

isActive()

int SoSceneManager::isActive ( void ) const

protected

Returns the active flag.

isAutoRedraw()

SbBool SoSceneManager::isAutoRedraw

(

void

)

const

Returns TRUE if the SoSceneManager 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.

isRealTimeUpdateEnabled()

SbBool SoSceneManager::isRealTimeUpdateEnabled ( void )

static

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

isRGBMode()

SbBool SoSceneManager::isRGBMode

(

void

)

const

Returns the "truecolor or colorindex" mode flag.

processEvent()

SbBool SoSceneManager::processEvent ( const SoEvent *const event )

virtual

Process the given event by applying an SoHandleEventAction on the scene graph.

redraw()

void SoSceneManager::redraw ( void )

protected

Do an immediate redraw by calling the redraw callback function.

reinitialize()

void SoSceneManager::reinitialize

(

void

)

Reinitialize after parameters affecting the OpenGL context have changed.

render() [1/2]

void SoSceneManager::render ( const SbBool clearwindow = TRUE, const SbBool clearzbuffer = TRUE )

virtual

Render the scene graph.

If clearwindow is TRUE, clear the rendering buffer before drawing. If clearzbuffer is TRUE, clear the depth buffer values before rendering. Both of these 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).

render() [2/2]

void SoSceneManager::render ( SoGLRenderAction * action, const SbBool initmatrices = TRUE, const SbBool clearwindow = TRUE, const SbBool clearzbuffer = TRUE )

virtual

Render method used for thread safe rendering.

Since only one thread can use an SoGLRenderAction, this method enables you to supply your own thread-specific SoGLRenderAction to be used for rendering the scene.

If initmatrices is TRUE, the OpenGL model and projection matrices will be initialized to identity matrices before applying the action.

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

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since

Coin 2.0

scheduleRedraw()

void SoSceneManager::scheduleRedraw

(

void

)

Redraw at first opportunity as system becomes idle.

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

setAntialiasing()

void SoSceneManager::setAntialiasing	(	const SbBool	smoothing,
		const int	numpasses )

Turn antialiased rendering on or off.

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

setAudioRenderAction()

void SoSceneManager::setAudioRenderAction

(

SoAudioRenderAction *const

action

)

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

setBackgroundColor()

void SoSceneManager::setBackgroundColor

(

const SbColor &

color

)

Sets color of rendering canvas.

setBackgroundIndex()

void SoSceneManager::setBackgroundIndex

(

const int

index

)

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.

setCamera()

void SoSceneManager::setCamera

(

SoCamera *

camera

)

Sets the camera to be used.

setGLRenderAction()

void SoSceneManager::setGLRenderAction

(

SoGLRenderAction *const

action

)

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

setHandleEventAction()

void SoSceneManager::setHandleEventAction

(

SoHandleEventAction *

hea

)

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

setOrigin()

void SoSceneManager::setOrigin

(

const SbVec2s &

newOrigin

)

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

See also

setViewportRegion(), setWindowSize()

setRedrawPriority()

void SoSceneManager::setRedrawPriority

(

const uint32_t

priority

)

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

setRenderCallback()

void SoSceneManager::setRenderCallback	(	SoSceneManagerRenderCB *	f,
		void *const	userdata = NULL )

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

setRGBMode()

void SoSceneManager::setRGBMode

(

const SbBool

yes

)

Turn RGB truecolor mode on or off. If you turn truecolor mode off, colorindex mode will be used instead.

setSceneGraph()

void SoSceneManager::setSceneGraph ( SoNode *const sceneroot )

virtual

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()

setSize()

void SoSceneManager::setSize

(

const SbVec2s &

newsize

)

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

setViewportRegion()

void SoSceneManager::setViewportRegion

(

const SbViewportRegion &

newregion

)

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()

setWindowSize()

void SoSceneManager::setWindowSize

(

const SbVec2s &

newsize

)

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()

---

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

• SoSceneManager.h
• SoSceneManager.cpp