Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/trunk/src/world_entities/weapons/projectile.h @ 5498

Last change on this file since 5498 was 5498, checked in by bensch, 18 years ago

orxonox/trunk: redocumented the WorldEntity and Weapon classes

File size: 1.9 KB
Line 
1/*!
2 * @file projectile.h
3 * a projectile, that is been shooted by a weapon
4 *
5 * You can use this class to make some Projectiles/Bullets/Lasers/Rockets/etc.
6 *
7 */
8
9#ifndef _PROJECTILE_H
10#define _PROJECTILE_H
11
12#include "world_entity.h"
13
14class Projectile : public WorldEntity
15{
16  public:
17    Projectile ();
18    virtual ~Projectile ();
19
20    void setFlightDirection(const Quaternion& flightDirection);
21    void setVelocity(const Vector &velocity);
22    void setLifeSpan(float lifeSpan);
23
24
25    void setEnergies(float energyMin, float energyMax);
26    /** @returns the minimal charched energy */
27    inline float getEnergyMin() { return this->energyMin; };
28    /** @returns the maximal charched energy */
29    inline float getEnergyMax() { return this->energyMax; };
30    /** @returns if the Projectile can be charged */
31    inline bool isChageable() { return this->bChargeable; };
32
33
34    /** @brief This is called, when the Projectile is Emitted */
35    virtual void activate() = 0;
36    /** @brief This is called, when the Projectile is being destroyed, or deleted */
37    virtual void deactivate() = 0;
38
39    virtual void destroy ();
40
41    virtual void tick (float time);
42    virtual void draw ();
43
44  protected:
45    // energy
46    float                 energyMin;                 //!< The minimal Energy a Projectile needs to be emitted.
47    float                 energyMax;                 //!< The maximal Energy a Projectile can take, before being emitted.
48    bool                  bChargeable;               //!< if the Projectile is Charegeable
49
50    float                 lifeCycle;                 //!< The percentage of the Lifetime done [0-1]
51    float                 lifeSpan;                  //!< The entire lifespan of the Shoot. in seconds
52
53    Vector                flightDirection;           //!< DOF direction in which the shoot flighs
54
55    Vector                velocity;                  //!< velocity of the projectile.
56};
57
58#endif /* _PROJECTILE_H */
Note: See TracBrowser for help on using the repository browser.