H3D::Scene Class Reference
[X3D node classes.]

The Scene node is topmost node that takes care of the rendering of the scene graph both haptically and graphically. More...

#include <Scene.h>

Inheritance diagram for H3D::Scene:

List of all members.

Public Types
typedef TypedMFNode< H3DWindowNode >	MFWindow
typedef TypedSFNode< X3DChildNode >	SFChildNode
Public Member Functions
	Scene (Inst< SFChildNode > _sceneRoot=0, Inst< MFWindow > _window=0, Inst< SFFloat > _frameRate=0)
	Constructor.
	~Scene ()
	Destructor.
void	setActive (bool _active)
	Set whether this Scene instance should be active or not.
bool	isActive ()
	Returns if the Scene instance is active or not.
virtual void	idle ()
	This function will be called by the event loop when there are no other events to process and the Scene is active.
Static Public Member Functions
static void	mainLoop ()
	Static function that is called to start the main event loop.
Public Attributes
auto_ptr< SFChildNode >	sceneRoot
	The scene graph to render in this scene.
auto_ptr< MFWindow >	window
	The windows to render into this scene.
auto_ptr< SFFloat >	frameRate
	The instantaneous frame rate of the scene.
Static Public Attributes
static SFTime *	time = new SFTime( TimeStamp() )
	Current time within the simulation, updated during each graphic loop.
static set< Scene * >	scenes
	All instances of Scene that has been created.
static H3DNodeDatabase	database
	The H3DNodeDatabase for this node.
static EventSink *	eventSink = new EventSink
Classes
class	EventSink
	The EventSink class makes all fields up-to-date what are routed to it, with the exception of PeriodicUpdateFields. More...

---

Detailed Description

The Scene node is topmost node that takes care of the rendering of the scene graph both haptically and graphically.

Scene::mainLoop() can be called to start the main event loop, e.g. start the haptic and graphical rendering. Before this function is called at least one instance of Scene must have created and be active.

---

Member Function Documentation

void Scene::idle (   )  [virtual]

This function will be called by the event loop when there are no other events to process and the Scene is active. Performs the rendering.

void Scene::mainLoop (   )  [static]

Static function that is called to start the main event loop. Before this function is called at least one instance of Scene must have created and be active.

void H3D::Scene::setActive (  bool  _active  )  [inline]

Set whether this Scene instance should be active or not. If a Scene is not active it will not be rendered at all.

---

Member Data Documentation

auto_ptr< SFFloat > H3D::Scene::frameRate

The instantaneous frame rate of the scene. Access type: outputOnly

auto_ptr< SFChildNode > H3D::Scene::sceneRoot

The scene graph to render in this scene. Access type: inputOutput

SFTime * Scene::time = new SFTime( TimeStamp() ) [static]

Current time within the simulation, updated during each graphic loop. Access type: outputOnly

auto_ptr< MFWindow > H3D::Scene::window

The windows to render into this scene. Access type: inputOutput

---