Changeset 4954 in orxonox.OLD for orxonox/trunk/src/world_entities/weapons/weapon_manager.h

Timestamp:

Jul 25, 2005, 2:16:23 AM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: doxygen-tags (and flush)

File:

• orxonox/trunk/src/world_entities/weapons/weapon_manager.h (modified) (3 diffs)

orxonox/trunk/src/world_entities/weapons/weapon_manager.h

@@ -1 +1 @@
 /*!
-    \file weapon.h
-  *  a weapon that a player can use
-
-    A Player has a list of weapons, that can be choosen to shoot projectiles
-    (projectiles.{cc,h}) at ennemies. These weapons can be shooted sequentially
-    or (if able) combined. Therefore you can choose the weapon mode = choose
-    a weapon.
-
-    A weapon is characterized by:
-     o firing-rate: the initial firing rate of a weapon (1/s = Herz)
-     o slowdown-factor: this is a factor d: exp(-d*x), d is element of all positive R. it determines how fast the firing-rate will slow down. if no slowdown: d=0, the bigger d is, the faster the weapon will slow down!
-     o energy-consumption: this determines the energy that has to be used to produce this projectile = costs per projectile
-
-    Furthermore there are some other attributes, that will help to represent a firing
-    weapon in this world:
-     o sound file/ressource: this is a pointer to the sound-file/ressource. however it may be represented
-     o shooting animation
-
-
-     a player defines one or more weapon configurations. a player has got one to eight
-     weapon slots: places where weapons can be attached to. a weapon configuration
-     is a matching between weapons and slots.
-     Since its clear how many weapons a player will have, there is no list of weapons:
-     its hard coded and limited to 8 slots and 4 configs. More would be a waste of
-     memory and time you need to customize and change to a weapon config...
+ * @file weapon_manager.h
+ * every big WorldEntity has the ability to carry many different Weapons.
+ * for this to be easy there is the WeaponManager, that handels these weapons,
+ * and changes between them.
+ *
+ *
+ *
+ * @TODO 1. WeaponManager should also handle a List of availiableWeapons.
+ * @TODO 2. Weapons should now Types the counteract to capabilities, so we know where we can put them on the ship.
  */
 
@@ -90 +74 @@
     // setting up the WeaponManager with the following functions
     void setSlotPosition(int slot, const Vector& position);
-    void setSlotCapability(long slotCapability);
+    /** @param slot the slot to get the relative position from @returns the relative position of the Carrier to the Slot */
+    const Vector& getSlotPosition(int slot) const { return this->currentSlotConfig[slot].position.getRelCoor(); };
+    void setSlotCapability(int slot, long slotCapability);
+    /** @param slot the slot to get the capabilities from @returns the capabilies */
+    long getSlotCapability(int slot) const { return this->currentSlotConfig[slot].capability; };
+
     void setParent(PNode* parent);
+    /** @returns the Parent (carrier) of this WeaponManager */
+    PNode* getParent() const { return this->parent; };
 
     void addWeapon(Weapon* weapon, int configID = -1, int slotID = -1);
     void removeWeapon(Weapon* weapon, int configID = -1);
 
-    void nextWeaponConf();
+    void nextWeaponConfig();
     void previousWeaponConfig();
     void changeWeaponConfig(int weaponConfig);
@@ -113 +104 @@
 
   private:
-    PNode*                  parent;                                  //!< The parent, this WeaponManager is connected to.
+    PNode*                  parent;                                   //!< The parent, this WeaponManager is connected to.
 
-    int                     slotCount;                               //!< number of weapon slots the ship has.
-    int                     currentConfigID;                         //!< the currently selected config.
-    Weapon*                 configs[WM_MAX_CONFIGS][WM_MAX_SLOTS];   //!< An array of predefined configurations and assigned weapon.
-    WM_Slot                 currentSlotConfig[WM_MAX_SLOTS];         //!< The currentConfigureation.
+    int                     slotCount;                                //!< number of weapon slots the ship has.
+    int                     currentConfigID;                          //!< the currently selected config.
+    Weapon*                 configs[WM_MAX_CONFIGS][WM_MAX_SLOTS];    //!< An array of predefined configurations and assigned weapon.
+    WM_Slot                 currentSlotConfig[WM_MAX_SLOTS];          //!< The currentConfigureation.
 
-    Weapon*                 availiableWeapons[WM_MAX_LOADED_WEAPONS];
+    Weapon*                 availiableWeapons[WM_MAX_LOADED_WEAPONS]; //!< The availiable Weapons of this WeaponManager
 
     bool                    weaponChange;
 
-    Crosshair*              crosshair;                               //!< an aim.
-    tAnimation<Crosshair>*  crossHairSizeAnim;                       //!< An animation for the crosshair (scaling)
+    Crosshair*              crosshair;                                //!< an aim.
+    tAnimation<Crosshair>*  crossHairSizeAnim;                        //!< An animation for the crosshair (scaling)
 };