Changeset 3449 in orxonox.OLD for orxonox/trunk/src/world.h

Timestamp:

Mar 2, 2005, 2:23:47 PM (20 years ago)

Author:

bensch

Message:

orxonox/trunk: documented orxonox.cc/h world.cc/h vector.cc/h

File:

• orxonox/trunk/src/world.h (modified) (2 diffs)

orxonox/trunk/src/world.h

@@ -19 +19 @@
 class Light;
 
-//! The game environment
+//! The game world
+/**
+   this class initializes everything that should be displayed inside of the current level.
+   it is the main driving factor during gameplay.
+*/
 class World : public StoryEntity {
 
@@ -55 +59 @@
   void spawn (WorldEntity* entity, Vector* absCoor, Quaternion* absDir);
 
-  tList<WorldEntity>* entities;
+  tList<WorldEntity>* entities;//!< A template List of all entities. Every moving thing should be included here, and world automatically updates them.
   
   // base level data
-  TrackManager* trackManager;
-  Vector* pathnodes;
-  Camera* localCamera;  
+  TrackManager* trackManager;  //!< The reference of the TrackManager that handles the course through the Level.
+  Camera* localCamera;         //!< The current Camera
 
 
-  UPointCurve* testCurve;
  private:
-  Uint32 lastFrame; //!> last time of frame
-  bool bQuitOrxonox; //!> quit this application
-  bool bQuitCurrentGame; //!> quit only the current game and return to menu
-  bool bPause;
+  Uint32 lastFrame;             //!< last time of frame
+  bool bQuitOrxonox;            //!< quit this application
+  bool bQuitCurrentGame;        //!< quit only the current game and return to menu
+  bool bPause;                  //!< pause mode
 
-  GLMenuImageScreen* glmis;
+  GLMenuImageScreen* glmis;     //!< The Level-Loader Display
 
-  char* worldName;
-  int debugWorldNr;
-  GLuint objectList;
-  SDL_Surface *loadImage;
-  Skysphere* skySphere;
-  Light* light;
+  char* worldName;              //!< The name of this World
+  int debugWorldNr;             //!< The Debug Nr. needed, if something goes wrong
+  GLuint objectList;            //!< temporary: \todo this will be ereased soon
+  Skysphere* skySphere;         //!< The Environmental Heaven of orxonox \todo insert this to environment insted
+  Light* light;                 //!< The Lights of the Level
 
-  WorldEntity* localPlayer;
+  WorldEntity* localPlayer;     //!< The Player, you fly through the level.
  
-  PNode* nullParent;
+  PNode* nullParent;            //!< The zero-point, that everything has as its parent.
  
   void mainLoop ();