From 8898ad9b25fca6afe2374d293a981db02a83d7e9 Mon Sep 17 00:00:00 2001 From: "FWoltermann@gmail.com" Date: Thu, 31 May 2012 14:46:27 +0000 Subject: Committing the documentation to svn to have it accessible online --- Doc/doxygen/html/class_scene.html | 803 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 803 insertions(+) create mode 100644 Doc/doxygen/html/class_scene.html (limited to 'Doc/doxygen/html/class_scene.html') diff --git a/Doc/doxygen/html/class_scene.html b/Doc/doxygen/html/class_scene.html new file mode 100644 index 0000000..e3d43d7 --- /dev/null +++ b/Doc/doxygen/html/class_scene.html @@ -0,0 +1,803 @@ + + + + + +Starshatter_Open: Scene Class Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
Starshatter_Open +
+
Open source Starshatter engine
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Member Functions | +Static Public Member Functions | +Protected Attributes
+
+
Scene Class Reference
+
+
+ +

#include <Scene.h>

+ +

List of all members.

+ + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 Scene ()
virtual ~Scene ()
void AddBackground (Graphic *g)
void DelBackground (Graphic *g)
void AddForeground (Graphic *g)
void DelForeground (Graphic *g)
void AddGraphic (Graphic *g)
void DelGraphic (Graphic *g)
void AddSprite (Graphic *g)
void DelSprite (Graphic *g)
void AddLight (Light *l)
void DelLight (Light *l)
List< Graphic > & Background ()
List< Graphic > & Foreground ()
List< Graphic > & Graphics ()
List< Graphic > & Sprites ()
List< Light > & Lights ()
Color Ambient ()
void SetAmbient (Color a)
virtual void Collect ()
virtual bool IsLightObscured (const Point &obj_pos, const Point &light_pos, double obj_radius, Point *imp_point=0) const
+ + +

+Static Public Member Functions

static const char * TYPENAME ()
+ + + + + + + +

+Protected Attributes

List< Graphic > background
List< Graphic > foreground
List< Graphic > graphics
List< Graphic > sprites
List< Light > lights
Color ambient
+

Detailed Description

+
+

Definition at line 30 of file Scene.h.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + +
Scene::Scene ()
+
+ +

Definition at line 24 of file Scene.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Scene::~Scene ()
+ 		+virtual
+
+ +

Definition at line 27 of file Scene.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + + +
void Scene::AddBackground (Graphic * g)
+
+ +

Definition at line 40 of file Scene.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void Scene::AddForeground (Graphic * g)
+
+ +

Definition at line 62 of file Scene.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void Scene::AddGraphic (Graphic * g)
+
+ +

Definition at line 84 of file Scene.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void Scene::AddLight (Light * l)
+
+ +

Definition at line 132 of file Scene.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void Scene::AddSprite (Graphic * g)
+
+ +

Definition at line 110 of file Scene.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Color Scene::Ambient ()
+ 		+inline
+
+ +

Definition at line 55 of file Scene.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
List<Graphic>& Scene::Background ()
+ 		+inline
+
+ +

Definition at line 50 of file Scene.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void Scene::Collect ()
+ 		+virtual
+
+ +

Definition at line 153 of file Scene.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void Scene::DelBackground (Graphic * g)
+
+ +

Definition at line 51 of file Scene.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void Scene::DelForeground (Graphic * g)
+
+ +

Definition at line 73 of file Scene.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void Scene::DelGraphic (Graphic * g)
+
+ +

Definition at line 95 of file Scene.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void Scene::DelLight (Light * l)
+
+ +

Definition at line 142 of file Scene.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void Scene::DelSprite (Graphic * g)
+
+ +

Definition at line 121 of file Scene.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
List<Graphic>& Scene::Foreground ()
+ 		+inline
+
+ +

Definition at line 51 of file Scene.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
List<Graphic>& Scene::Graphics ()
+ 		+inline
+
+ +

Definition at line 52 of file Scene.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
bool Scene::IsLightObscured (const Point & obj_pos,
const Point & light_pos,
double obj_radius,
Point * imp_point = 0 
) const
+ 		+virtual
+
+ +

Definition at line 187 of file Scene.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
List<Light>& Scene::Lights ()
+ 		+inline
+
+ +

Definition at line 54 of file Scene.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void Scene::SetAmbient (Color a)
+ 		+inline
+
+ +

Definition at line 56 of file Scene.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
List<Graphic>& Scene::Sprites ()
+ 		+inline
+
+ +

Definition at line 53 of file Scene.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
static const char* Scene::TYPENAME ()
+ 		+inlinestatic
+
+ +

Definition at line 33 of file Scene.h.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
Color Scene::ambient
+ 		+protected
+
+ +

Definition at line 71 of file Scene.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<Graphic> Scene::background
+ 		+protected
+
+ +

Definition at line 66 of file Scene.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<Graphic> Scene::foreground
+ 		+protected
+
+ +

Definition at line 67 of file Scene.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<Graphic> Scene::graphics
+ 		+protected
+
+ +

Definition at line 68 of file Scene.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<Light> Scene::lights
+ 		+protected
+
+ +

Definition at line 70 of file Scene.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<Graphic> Scene::sprites
+ 		+protected
+
+ +

Definition at line 69 of file Scene.h.

+ +
+
+
The documentation for this class was generated from the following files:
    +
  • D:/SRC/StarshatterSVN/nGenEx/Scene.h
    • +
  • D:/SRC/StarshatterSVN/nGenEx/Scene.cpp
    • +
+
+
+ + + + -- cgit v1.1