Mellinger at 16:41, 11 September 2008

2008-09-11T16:41:29Z

New page

==Location==
<tt>src/extlib/3DAPI</tt>

==Synopsis==
The <tt>Scene</tt> class provides a rectangular view on a 3D scene. Inheriting from [[Programming Reference:GraphObject Class|<tt>GraphObject</tt>]], a <tt>Scene</tt> object is drawn onto a [[Programming Reference:GraphDisplay Class|<tt>GraphDisplay</tt>]].

The scene itself consists of scene objects as defined by the [[Programming Reference:3D API|3D API]].

==Methods==
===Scene(GraphDisplay)===
In the constructor, specify the [[Programming Reference:GraphDisplay Class|GraphDisplay]] associated with the scene object.
===Add(primObj pointer)===
Adds a 3D API object to the scene.
===Remove(primObj pointer)===
Removes a 3D API object from the scene.
===DeleteObjects()===
Deletes all objects that are part of the scene.
===Move(float deltaT)===
Moves all 3D API objects one step forward in time, using their specified velocities, and tests for collisions.
{{GraphObjectMethods}}

==Properties==
===OnCollideFunc OnCollide (w)===
Specifies a callback function to be called for each collision between scene objects. The callback function takes references to a pair of scene objects as arguments.
Collision testing is done from the <tt>Move()</tt> member function.
===SetOfObjects Objects (r)===
The objects contained in the scene, as a <tt>std::set</tt> of object pointers.
===string ImagePath (rw)===
Reference path for texture images specified using relative paths.
===float CameraX, CameraY, CameraZ (rw)===
Camera position in scene coordinates.
===cameraNLight CameraAndLight (rw)===
Provides access to the scene's 3D API <tt>cameraNLight</tt> object that defines details of projection and scene lighting.
===int BitDepth (rw)===
The scene's rendering bit depth. Typically, this is 16 or 24.
===bool DoubleBuffering (rw)===
Switch double buffering on or off. When switched on, the scene will be rendered into an offscreen buffer, and only displayed after rendering is finished.
===bool DisableVsync (rw)===
When double buffering is enabled, buffer switching will be synchronized to the display's vertical sync pulse. While this is desired for most purposes, it will affect BCI2000 system timing, and should thus be disabled. This will not work for all graphics cards.
===bool HardwareAccelerated (r)===
''True'' if OpenGL rendering is realized in hardware, ''false'' in case of a software renderer.

==See also==
[[Programming Reference:3D API]], [[Programming Reference:GraphObject Class]], [[Programming Reference:GraphDisplay Class]]

[[Category:Framework API]][[Category:Development]]

Programming Reference:Scene Class - Revision history

Mellinger at 16:41, 11 September 2008