From fdd51ab588a2ec9fca54215039803d187a10178e Mon Sep 17 00:00:00 2001 From: Clyne Sullivan Date: Mon, 7 Dec 2015 08:49:56 -0500 Subject: doxygen --- doc/html/classWorld.html | 115 +++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 102 insertions(+), 13 deletions(-) (limited to 'doc/html/classWorld.html') diff --git a/doc/html/classWorld.html b/doc/html/classWorld.html index 6071450..54103c3 100644 --- a/doc/html/classWorld.html +++ b/doc/html/classWorld.html @@ -3,7 +3,7 @@ - + gamedev: World Class Reference @@ -22,7 +22,7 @@ - @@ -31,7 +31,7 @@
+
gamedev
- + @@ -213,11 +213,9 @@ std::vector< Object * >  - + - +

Protected Member Functions

-void singleDetect (Entity *e)
void singleDetect (Entity *e)
 
-void deleteEntities (void)
void deleteEntities (void)
 
- + - + @@ -244,7 +240,58 @@ char * 

@@ -226,11 +224,9 @@ Protected Attributes

 
int x_start
 
-unsigned int lineCount
unsigned int lineCount
 
-vec2 * star
vec2 * star
 
Texturec * bgTex
bgm

Detailed Description

The world class. This class does everything a world should do.

-

Member Data Documentation

+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + + +
void World::deleteEntities (void )
+ 		+protected
+
+

Empties all entity vectors. Each entity vector is iterated through, calling delete for each entry. Once all specific vectors are cleared, the general entity vector is emptied of the pointers to those other vectors. This function should only be called in World's destructor, as there shouldn't be another reason to call this function.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void World::singleDetect (Entity * e)
+ 		+protected
+
+

Handle physics for a single entity. This function handles gravity and death for an entity. The public version of this, World::detect(), handles all entities in the world as well as the player. World::singleDetect() should never be used outside of World::detect(), which is why it is declared private.

+ +
+
+

Member Data Documentation

@@ -264,6 +311,48 @@ char * bgm

The line array. This array is created through 'new' in World::generate(), with an amount of elements provided by the function.

+
+
+ +
+
+ + + + + +
+ + + + +
unsigned int World::lineCount
+ 		+protected
+
+

Number of lines in the world. While this number is helpful for knowing the world's width, it is kept private for security reasons. To compensate for this, World::getTheWidth() is provided (see below).

+ +
+
+ +
+
+ + + + + +
+ + + + +
vec2* World::star
+ 		+protected
+
+

An array of star coordinates.

+
@@ -296,7 +385,7 @@ char * bgm
Generated by   doxygen - 1.8.10 + 1.8.9.1
-- cgit v1.2.3