Changeset 3225 in orxonox.OLD for orxonox/trunk/src

Timestamp:

Dec 20, 2004, 12:23:58 AM (20 years ago)

Author:

patrick

Message:

/orxonox/trunk: unstable - added many comments and now redefinit all function/variable names with underline

Location:

orxonox/trunk/src

Files:

• camera.cc (modified) (1 diff)
• camera.h (modified) (1 diff)
• campaign.cc (modified) (3 diffs)
• command_node.cc (modified) (12 diffs)
• command_node.h (modified) (2 diffs)
• game_loader.cc (modified) (7 diffs)
• game_loader.h (modified) (1 diff)
• world.cc (modified) (18 diffs)
• world.h (modified) (2 diffs)

orxonox/trunk/src/camera.cc

@@ -61 +61 @@
    as smooth camera movement or swaying).
 */
-void Camera::time_slice (Uint32 deltaT)
+void Camera::timeSlice (Uint32 deltaT)
 {
   if( this->t <= deltaTime)

orxonox/trunk/src/camera.h

@@ -60 +60 @@
   ~Camera ();
   
-  void time_slice (Uint32 deltaT);
+  void timeSlice (Uint32 deltaT);
   void apply ();
   void bind (WorldEntity* entity);

orxonox/trunk/src/campaign.cc

@@ -104 +104 @@
       if( ( nextWorldID == WORLD_ID_GAMEEND) ||( se == NULL) ) 
         {
-          printf("Campaign::start() - quiting campaing story loop\n");
+          printf("Campaign::start() - quitting campaing story loop\n");
           if(se != NULL)
             delete se;
@@ -148 +148 @@
 }
 
+/*
+  \brief this changes to the next level
+*/
 void Campaign::nextLevel()
 {
@@ -157 +160 @@
 }
 
+/*
+  \brief change to the previous level - not implemented
+
+  this propably useless
+*/
 void Campaign::previousLevel()
 {}
 
 
+/*
+  \brief lookup a entity with a given id
+  \param story id to be lookuped
+  \returns the entity found or NULL if search ended without match
+*/
 StoryEntity* Campaign::getStoryEntity(int storyID)
 {

orxonox/trunk/src/command_node.cc

@@ -108 +108 @@
    \param filename: The path and name of the file to load the bindings from
 */
-void CommandNode::load_bindings (char* filename)
+void CommandNode::loadBindings (char* filename)
 {
   FILE* stream;
@@ -125 +125 @@
   // create parser
   IniParser parser (filename);
-  if( parser.get_section ("Bindings") == -1)
+  if( parser.getSection ("Bindings") == -1)
     {
       printf("Could not find key bindings in %s\n", filename);
@@ -145 +145 @@
         {
         case 0:
-          printf("Key binding %d(%s) set to %s\n", index[1], SDLK_to_keyname( index[1]), valuebuf);
+          printf("Key binding %d(%s) set to %s\n", index[1], SDLKToKeyname( index[1]), valuebuf);
           strcpy (aliases->keys[index[1]], valuebuf);
           break;
         case 1:
-          printf("Button binding %d(%s) set to %s\n", index[1], SDLB_to_buttonname( index[1]), valuebuf);
+          printf("Button binding %d(%s) set to %s\n", index[1], SDLBToButtonname( index[1]), valuebuf);
           strcpy (aliases->buttons[index[1]], valuebuf);
           break;
@@ -166 +166 @@
 void CommandNode::bind (WorldEntity* entity)
 {
-  bound->add(entity);
+  bound->add (entity);
 }
 
@@ -175 +175 @@
 void CommandNode::unbind (WorldEntity* entity)
 {
-  bound->remove(entity);
-}
-
-int* CommandNode::name_to_index (char* name)
+  bound->remove (entity);
+}
+
+int* CommandNode::nameToIndex (char* name)
 {
   coord[0] = -1;
   coord[1] = -1;
   int c;
-  if( (c = keyname_to_SDLK (name)) != -1)
+  if( (c = keynameToSDLK (name)) != -1)
     {
       coord[1] = c;
       coord[0] = 0;
     }
-  if( (c = buttonname_to_SDLB (name)) != -1)
+  if( (c = buttonnameToSDLB (name)) != -1)
     {
       coord[1] = c;
@@ -203 +203 @@
   if( this->bEnabled) 
     {
-      if( bLocalInput) process_local ();
-      else process_network ();
+      if( bLocalInput) processLocal ();
+      else processNetwork ();
     }
 }
@@ -220 +220 @@
           strcpy (cmd.cmd, aliases->keys[event.key.keysym.sym]);
           cmd.bUp = false;
-          if( strlen (cmd.cmd) > 0) relay (&cmd);
+          if( strlen (cmd.cmd) > 0) relay(&cmd);
           break;
         case SDL_KEYUP:
           strcpy( cmd.cmd, aliases->keys[event.key.keysym.sym]);
           cmd.bUp = true;
-          if( strlen (cmd.cmd) > 0) relay (&cmd);
+          if( strlen (cmd.cmd) > 0) relay(&cmd);
           break;
         case SDL_MOUSEMOTION:
@@ -237 +237 @@
           strcpy( cmd.cmd, aliases->buttons[event.button.button]);
           cmd.bUp = true;
-          if( strlen (cmd.cmd) > 0) relay (&cmd);
+          if( strlen (cmd.cmd) > 0) relay(&cmd);
           break;
         case SDL_MOUSEBUTTONDOWN:
           strcpy( cmd.cmd, aliases->buttons[event.button.button]);
           cmd.bUp = false;
-          if( strlen (cmd.cmd) > 0) relay (&cmd);
+          if( strlen (cmd.cmd) > 0) relay(&cmd);
           break;
         case SDL_JOYAXISMOTION:
@@ -252 +252 @@
         default:
           Orxonox *orx = Orxonox::getInstance();
-          orx->event_handler (&event);
+          orx->eventHandler(&event);
           break;
         }
@@ -259 +259 @@
 
 
-void CommandNode::process_network ()
+void CommandNode::processNetwork ()
 {
 
@@ -269 +269 @@
 
   Orxonox *orx = Orxonox::getInstance();
-  if( orx->system_command (cmd)) return;
+  if( orx->systemCommand (cmd)) return;
 
   GameLoader* gl = GameLoader::getInstance();
   if( gl->worldCommand(cmd)) return;
 
-  if( bLocalInput) send_over_network (cmd);
+  if( bLocalInput) sendOverNetwork (cmd);
   
   if( this->world->command(cmd)) return;
@@ -291 +291 @@
    \param ID: the new ID to use
 */
-void CommandNode::set_netID (int ID)
+void CommandNode::setNetID (int ID)
 {
   netID = ID;
 }
 
-void CommandNode::send_over_network (Command* cmd)
-{
-}
+void CommandNode::sendOverNetwork (Command* cmd)
+{
+}

orxonox/trunk/src/command_node.h

@@ -49 +49 @@
 
   void relay (Command* cmd);
-  int* name_to_index (char* name);
-  void process_local ();
-  void process_network ();
-  void send_over_network (Command* cmd);
+  int* nameToIndex (char* name);
+  void processLocal ();
+  void processNetwork ();
+  void sendOverNetwork (Command* cmd);
   
  public:
@@ -59 +59 @@
   ~CommandNode ();
 
-  void reset();
-  void enable(bool bEnabled);
+  void reset ();
+  void enable (bool bEnabled);
   void load_bindings (char* filename);
   void bind (WorldEntity* entity);
   void unbind (WorldEntity* entity);
-  void addToWorld(World* world);
+  void addToWorld (World* world);
   void process ();
   
-  void set_netID (int ID);
+  void setNetID (int ID);
 };
 

orxonox/trunk/src/game_loader.cc

@@ -42 +42 @@
 
 
+/**
+   \brief this class is a singleton class
+   \returns an instance of itself
+
+   if you are unsure about singleton classes, check the theory out on the internet :)
+*/
 GameLoader* GameLoader::getInstance()
 {
@@ -57 +63 @@
 
 
+/**
+   \brief reads a campaign definition file into a campaign class
+   \param filename to be loaded
+   \returns the loaded campaign
+
+   this will interprete the map/campaign files and recursivly load a tree of worlds/campaigns
+*/
 ErrorMessage GameLoader::loadCampaign(char* name)
 {
@@ -64 +77 @@
 }
 
+
+/**
+   \brief loads a debug campaign for test purposes only.
+   \param the identifier of the campaign.
+   \returns error message if not able to do so.
+*/
 ErrorMessage GameLoader::loadDebugCampaign(Uint32 campaignID)
 {
@@ -117 +136 @@
 }
 
-ErrorMessage GameLoader::free()
+/**
+   \brief release the mem
+ */
+ErrorMessage GameLoader::destroy()
 {}
 
 
+/**
+   \brief reads a campaign definition file into a campaign class
+   \param filename to be loaded
+   \returns the loaded campaign
+
+   this will interprete the map/campaign files and recursivly load a tree of worlds/campaigns
+*/
 Campaign* GameLoader::fileToCampaign(char *name)
 {
@@ -133 +162 @@
    \brief handle keyboard commands 
    \param cmd: the command to handle
-   \return true if the command was handled by the system
+   \returns true if the command was handled by the system
 */
 bool GameLoader::worldCommand (Command* cmd)
@@ -172 +201 @@
 }
 
+
+/*
+  \brief this changes to the next level
+*/
 void GameLoader::nextLevel()
 {
@@ -178 +211 @@
 }
 
+
+/*
+  \brief change to the previous level - not implemented
+
+  this propably useless
+*/
 void GameLoader::previousLevel()
 {

orxonox/trunk/src/game_loader.h

@@ -26 +26 @@
   ErrorMessage pause();
   ErrorMessage resume();
-  ErrorMessage free();
+  ErrorMessage destroy();
 
   void nextLevel();

orxonox/trunk/src/world.cc

@@ -72 +72 @@
 
 
-/** 
-    \brief initialize the world before use.
-*/
 ErrorMessage World::init()
 {
@@ -118 +115 @@
       switch(this->debugWorldNr)
         {
+          /*
+            this loads the hard-coded debug world. this only for simplicity and will be 
+            removed by a reald world-loader, which interprets a world-file.
+            if you want to add an own debug world, just add a case DEBUG_WORLD_[nr] and
+            make whatever you want...
+           */
         case DEBUG_WORLD_0:
           {
@@ -497 +500 @@
       else
         {
-          /* TO DO: implement check whether this particular free entity 
+          /* \todo: implement check whether this particular free entity 
              is out of the game area
-             TO DO: call function to notify the entity that it left 
+             \todo: call function to notify the entity that it left 
              the game area
           */
@@ -513 +516 @@
     \param deltaT: the time passed since the last frame in milliseconds
 */
-void World::time_slice (Uint32 deltaT)
+void World::timeSlice (Uint32 deltaT)
 {
   //List<WorldEntity> *l;
@@ -544 +547 @@
    Camera Placement
 */
-void World::calc_camera_pos (Location* loc, Placement* plc)
+void World::calcCameraPos (Location* loc, Placement* plc)
 {
   track[loc->part].map_camera (loc, plc);
@@ -560 +563 @@
 }
 
+
+
+/**
+   \brief function to put your own debug stuff into it. it can display informations about
+   the current class/procedure
+*/
 void World::debug()
 {
@@ -576 +585 @@
 
 
+/*
+  \brief main loop of the world: executing all world relevant function
+
+  in this loop we synchronize (if networked), handle input events, give the heart-beat to
+  all other member-entities of the world (tick to player, enemies etc.), checking for
+  collisions drawing everything to the screen.
+*/
 void World::mainLoop()
 {
@@ -582 +598 @@
   while( !this->bQuitOrxonox && !this->bQuitCurrentGame) /* \todo implement pause */
     {
-      //debug routine
-      //debug();
       // Network
       synchronize();
@@ -594 +608 @@
         }
       // Process time
-      time_slice();
+      timeSlice();
       // Process collision
       collision();
@@ -616 +630 @@
 /**
    \brief run all input processing
-*/
-void World::handle_input ()
+
+   the command node is the central input event dispatcher. the node uses the even-queue from
+   sdl and has its own event-passing-queue.
+*/
+void World::handleInput ()
 {
   // localinput
-  CommandNode* cn = Orxonox::getInstance()->get_localinput();
+  CommandNode* cn = Orxonox::getInstance()->getLocalInput();
   cn->process();
   // remoteinput
@@ -627 +644 @@
 /**
    \brief advance the timeline
-*/
-void World::time_slice ()
+
+   this calculates the time used to process one frame (with all input handling, drawing, etc)
+   the time is mesured in ms and passed to all world-entities and other classes that need
+   a heart-beat.
+*/
+void World::timeSlice ()
 {
   Uint32 currentFrame = SDL_GetTicks();
@@ -642 +663 @@
       else
         {
+          /* the frame-rate is limited to 100 frames per second, all other things are for
+             nothing.
+          */
           printf("fps = 1000 - frame rate is adjusted\n");
           SDL_Delay(10);
           dt = 10;
         }
-      
-      this->time_slice (dt);
+      this->timeSlice (dt);
       this->update ();
-      this->localCamera->time_slice (dt);
+      this->localCamera->timeSlice(dt);
     }
   this->lastFrame = currentFrame;
@@ -665 +688 @@
 
 /**
-        \brief render the current frame
+   \brief render the current frame
+   
+   clear all buffers and draw the world
 */
 void World::display ()
@@ -680 +705 @@
 }
 
+/**
+   \brief give back active camera
+   
+   this passes back the actualy active camera
+   \todo ability to define more than one camera or camera-places
+*/
 Camera* World::getCamera()
 {
@@ -686 +717 @@
 
 
+/**
+   \brief add and spawn a new entity to this world
+   \param entity to be added
+*/
 void World::spawn(WorldEntity* entity)
 {
@@ -707 +742 @@
 
 
+/**
+   \brief add and spawn a new entity to this world
+   \param entity to be added
+   \param location where to add
+*/
 void World::spawn(WorldEntity* entity, Location* loc)
 {
@@ -730 +770 @@
 
 
+/**
+   \brief add and spawn a new entity to this world
+   \param entity to be added
+   \param place where to be added
+*/
 void World::spawn(WorldEntity* entity, Placement* plc)
 {
@@ -747 +792 @@
 
 
+/*
+  \brief commands that the world must catch
+  \returns false if not used by the world
+*/
 bool World::command(Command* cmd)
 {

orxonox/trunk/src/world.h

@@ -25 +25 @@
 
   template<typename T> 
-    T* spawn(Location* loc, WorldEntity* owner);        // template to be able to spawn any derivation of WorldEntity
+    T* spawn (Location* loc, WorldEntity* owner);       // template to be able to spawn any derivation of WorldEntity
   template<typename T> 
-    T* spawn(Placement* plc, WorldEntity* owner);
+    T* spawn (Placement* plc, WorldEntity* owner);
   
-  virtual ErrorMessage init();
-  virtual ErrorMessage start();
-  virtual ErrorMessage stop();
-  virtual ErrorMessage pause();
-  virtual ErrorMessage resume();
+  virtual ErrorMessage init ();
+  virtual ErrorMessage start ();
+  virtual ErrorMessage stop ();
+  virtual ErrorMessage pause ();
+  virtual ErrorMessage resume ();
 
-  virtual void load();
-  virtual void destroy();
+  virtual void load ();
+  virtual void destroy ();
 
-  void time_slice (Uint32 deltaT);
+  void timeSlice (Uint32 deltaT);
   void collide ();
   void draw ();
   void update ();       // maps Locations to Placements
-  void calc_camera_pos (Location* loc, Placement* plc);
+  void calcCameraPos (Location* loc, Placement* plc);
         
   void unload ();
-  bool command(Command* cmd);
+  bool command (Command* cmd);
   
-  void setTrackLen(Uint32 tracklen);
-  int getTrackLen();
+  void setTrackLen (Uint32 tracklen);
+  int getTrackLen ();
   //bool system_command (Command* cmd);
-  Camera* getCamera();
+  Camera* getCamera ();
 
-  void spawn(WorldEntity* entity);
-  void spawn(WorldEntity* entity, Location* loc);
-  void spawn(WorldEntity* entity, Placement* plc);
+  void spawn (WorldEntity* entity);
+  void spawn (WorldEntity* entity, Location* loc);
+  void spawn (WorldEntity* entity, Placement* plc);
 
   tList<WorldEntity>* entities;
@@ -76 +76 @@
   WorldEntity* localPlayer;
   
-  void mainLoop();
-  void synchronize();
-  void handle_input();
-  void time_slice();
-  void collision();
-  void display();
-  void debug();
+  void mainLoop ();
+  void synchronize ();
+  void handle_input ();
+  void timeSlice ();
+  void collision ();
+  void display ();
+  void debug ();
 };