Changeset 2096 in orxonox.OLD for orxonox/branches/chris/src/command_node.h

Timestamp:

Jul 9, 2004, 11:14:42 AM (20 years ago)

Author:

chris

Message:

orxonox/branches/chris: Messed with the Player class, added stuff here and there, debug world now creates a player and bind IO to it. Added some doxygen tags.

File:

• orxonox/branches/chris/src/command_node.h (modified) (4 diffs)

orxonox/branches/chris/src/command_node.h

@@ -15 +15 @@
 #define DEFAULT_KEYBIND_FILE "default.ini"
 
+//! Key aliasing structure
+/**
+        This structure contains the key aliasing information, e.g. the command strings that
+        have been bound to the keys.
+*/
 typedef struct
 {
@@ -21 +26 @@
 } KeyBindings;
 
+//! Command Node
+/**
+        This class gathers all incoming SDL_Events and processes them. Keyboard, mouse and joystick input is
+        captured and translated into command messages which are passed down to the bound WorldEntities (via WorldEntity::command()).
+        Other SDL_Events are passed to Orxonox::event_handler() to deal with them. If the CommandNode has been created
+        with bLocalInput set to false, it will query the network class for incoming commands that match his netID and pass
+        them on to his WorldEntities.
+*/
 class CommandNode {
  private:
-        bool bLocalInput;
-        int netID;
+        bool bLocalInput;       //!< Identifies the CommandNode that processes local input
+        int netID;      //!< Unique identifier that is used to determine between remote CommandNodes
         KeyBindings* aliases;
-        List<WorldEntity>* bound;
+        List<WorldEntity>* bound;       //!< List of WorldEntites that recieve commands from this CommandNode
         int coord[2];
         
@@ -33 +46 @@
         void process_local ();
         void process_network ();
-        void send_over_networ();
+        void send_over_network (Command* cmd);
         
  public:
@@ -44 +57 @@
   void unbind (WorldEntity* entity);
   void process ();
+  
+  void set_netID (int ID);
 };