Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 4836 in orxonox.OLD for orxonox/trunk/src/lib/particles


Ignore:
Timestamp:
Jul 12, 2005, 12:33:16 AM (19 years ago)
Author:
bensch
Message:

orxonox/trunk: renamed all the \param → @param and so on in Doxygen tags.
Thanks a lot to the kDevelop team. this took since the last commit :)

Location:
orxonox/trunk/src/lib/particles
Files:
8 edited

Legend:

Unmodified
Added
Removed

  • orxonox/trunk/src/lib/particles/particle_emitter.cc

    r4746 r4836  
    3131
    3232/**
    33    \brief standard constructor
     33 * standard constructor
    3434*/
    3535ParticleEmitter::ParticleEmitter(const Vector& direction, float angle, float emissionRate,
    … …  
    4747
    4848/**
    49    \brief constructs and loads a ParticleEmitter from a XML-element
    50    \param root the XML-element to load from
     49 * constructs and loads a ParticleEmitter from a XML-element
     50 * @param root the XML-element to load from
    5151*/
    5252ParticleEmitter::ParticleEmitter(const TiXmlElement* root)
    … …  
    6161
    6262/**
    63    \brief standard destructor
     63 * standard destructor
    6464
    6565   removes the EmitterSystem from the ParticleEngine
    … …  
    8787
    8888/**
    89    \brief loads a ParticleEmitter from a XML-element
    90    \param root the XML-element to load from
     89 * loads a ParticleEmitter from a XML-element
     90 * @param root the XML-element to load from
    9191*/
    9292void ParticleEmitter::loadParams(const TiXmlElement* root)
    … …  
    120120
    121121/**
    122    \brief this start the emitter
     122 * this start the emitter
    123123*/
    124124void ParticleEmitter::start() {}
    … …  
    126126
    127127/**
    128    \brief this stops the emitter
     128 * this stops the emitter
    129129*/
    130130void ParticleEmitter::stop() {}
    … …  
    135135
    136136/**
    137    \param type the new Type of this emitter
     137 * @param type the new Type of this emitter
    138138*/
    139139void ParticleEmitter::setType(EMITTER_TYPE type)
    … …  
    143143
    144144/**
    145    \brief sets the type of emitter
    146    \param type the type as a const char*
     145 * sets the type of emitter
     146 * @param type the type as a const char*
    147147   dot: EMITTER_DOT, plane: EMITTER_PLANE, cube: EMITTER_CUBE, sphere, EMITTER_SPHERE;
    148148*/
    … …  
    172172
    173173/**
    174    \brief sets a new size to the emitter
     174 * sets a new size to the emitter
    175175*/
    176176void ParticleEmitter::setSize(float emitterSize)
    … …  
    183183
    184184/**
    185    \brief set the emission rate
    186    \param emissionRate: sets the number of particles emitted per second
     185 * set the emission rate
     186 * @param emissionRate: sets the number of particles emitted per second
    187187
    188188   if you want to change the value of this variable during emission time (to make it more dynamic)
    … …  
    198198
    199199/**
    200    \brief how much of the speed from the ParticleEmitter should flow onto the ParticleSystem
    201    \param value a Value between zero and one
     200 * how much of the speed from the ParticleEmitter should flow onto the ParticleSystem
     201 * @param value a Value between zero and one
    202202
    203203   if you want to change the value of this variable during emission time (to make it more dynamic)
    … …  
    215215
    216216/**
    217    \brief set the angle of the emitter
    218    \param angle around the direction in which there are particles to be emitted
    219    \param randomAngle A random spread-angle, the +- randomness of this option
     217 * set the angle of the emitter
     218 * @param angle around the direction in which there are particles to be emitted
     219 * @param randomAngle A random spread-angle, the +- randomness of this option
    220220
    221221   if you want to change the value of this variable during emission time (to make it more dynamic)
    … …  
    229229
    230230/**
    231    \brief sets the initial velocity of all particles emitted
    232    \param velocity The starting velocity of the emitted particles
    233    \param randomVelocity A random starting velocity, the +- randomness of this option
     231 * sets the initial velocity of all particles emitted
     232 * @param velocity The starting velocity of the emitted particles
     233 * @param randomVelocity A random starting velocity, the +- randomness of this option
    234234
    235235   if you want to change the value of this variable during emission time (to make it more dynamic)
    … …  
    243243
    244244/**
    245    \brief sets the initial Momentum of all particles emitted
    246    \param momentum the new Momentum (just a float for being not too complicated).
    247    \param randomMomentum variation from the given value.
     245 * sets the initial Momentum of all particles emitted
     246 * @param momentum the new Momentum (just a float for being not too complicated).
     247 * @param randomMomentum variation from the given value.
    248248 */
    249249void ParticleEmitter::setEmissionMomentum(float momentum, float randomMomentum)
    … …  
    254254
    255255/**
    256    \brief this set the time to life of a particle, after which it will die
    257    \param dt: the time to live in seconds
    258    \param system: the system into which to emitt
     256 * this set the time to life of a particle, after which it will die
     257 * @param dt: the time to live in seconds
     258 * @param system: the system into which to emitt
    259259
    260260   if you want to change the value of this variable during emission time (to make it more dynamic)
    … …  
    308308
    309309/**
    310    \brief outputs some nice debug information
     310 * outputs some nice debug information
    311311*/
    312312void ParticleEmitter::debug() const

  • orxonox/trunk/src/lib/particles/particle_emitter.h

    r4746 r4836  
    11/*!
    22    \file particle_emitter.h
    3     \brief Definition of a ParticleEmitter
     3  * Definition of a ParticleEmitter
    44*/
    55
    … …  
    5858  void setDirection(float x, float y, float z) { this->direction = Vector(x,y,z); }; //!< todo this should be done via PNODE
    5959
    60   /** \returns the type of the emitter */
     60  /** @returns the type of the emitter */
    6161  inline EMITTER_TYPE getType() const { return this->type; };
    62   /** \returns the Type as a const char * */
     62  /** @returns the Type as a const char * */
    6363  const char* getTypeC() const;
    64   /** \returns the Size of the emitter */
     64  /** @returns the Size of the emitter */
    6565  inline float getSize() const { return this->emitterSize; };
    66   /** \returns the emissionRate */
     66  /** @returns the emissionRate */
    6767  inline float getEmissionRate() const { return this->emissionRate; };
    68   /** \returns the inherit-speed-factor */
     68  /** @returns the inherit-speed-factor */
    6969  inline float getInheritSpeed() const { return this->inheritSpeed; };
    70   /** \returns the SpreadAngle of the emitter */
     70  /** @returns the SpreadAngle of the emitter */
    7171  inline float getSpread() const { return this->angle; };
    72   /** \returns the EmissionVelocity of the emitter */
     72  /** @returns the EmissionVelocity of the emitter */
    7373  inline float getEmissionVelocity() const { return this->velocity; };
    74   /** \returns the EmissionMomentum of this emitter */
     74  /** @returns the EmissionMomentum of this emitter */
    7575  inline float getEmissionMomentum() const { return this->momentum; };
    7676

  • orxonox/trunk/src/lib/particles/particle_engine.cc

    r4834 r4836  
    2929
    3030/**
    31    \brief standard constructor
     31 * standard constructor
    3232*/
    3333ParticleEngine::ParticleEngine ()
    … …  
    4242
    4343/**
    44    \brief the singleton reference to this class
     44 * the singleton reference to this class
    4545*/
    4646ParticleEngine* ParticleEngine::singletonRef = NULL;
    4747
    4848/**
    49    \brief deletes all the system, emitters, connections and Lists
     49 * deletes all the system, emitters, connections and Lists
    5050*/
    5151ParticleEngine::~ParticleEngine ()
    … …  
    8484/**
    8585  \brief loads the ParticleEngines settings and connections between particles and emitters
    86   \param root the XML-element to load this from.
     86* @param root the XML-element to load this from.
    8787 */
    8888void ParticleEngine::loadParams(const TiXmlElement* root)
    … …  
    9898
    9999/**
    100    \brief Adds a System to the System list.
     100 * Adds a System to the System list.
    101101
    102102   this is done automatically when creating a ParticleSystem
    … …  
    108108
    109109/**
    110    \brief Adds an emitter to the emitterList
     110 * Adds an emitter to the emitterList
    111111
    112112   this is done automatically when creating a ParticleEmitter
    … …  
    119119/**
    120120  \brief Connects a ParticleSystem to a ParticleSystem thus emitting Particles.
    121   \param emitter the Emitter to connect to the System
    122   \param system the System to connect to the Emitter
     121* @param emitter the Emitter to connect to the System
     122* @param system the System to connect to the Emitter
    123123*/
    124124void ParticleEngine::addConnection(const char* emitter, const char* system)
    … …  
    139139
    140140/**
    141    \brief Connects a ParticleSystem to a ParticleSystem thus emitting Particles.
    142    \param emitter the Emitter to connect to the System
    143    \param system the System to connect to the Emitter
     141 * Connects a ParticleSystem to a ParticleSystem thus emitting Particles.
     142 * @param emitter the Emitter to connect to the System
     143 * @param system the System to connect to the Emitter
    144144*/
    145145void ParticleEngine::addConnection(ParticleEmitter* emitter, ParticleSystem* system)
    … …  
    171171
    172172/**
    173    \brief Removes a system from the systemList and also removes all Connections to the System
    174    \param system The ParticleSystem to delete
     173 * Removes a system from the systemList and also removes all Connections to the System
     174 * @param system The ParticleSystem to delete
    175175*/
    176176bool ParticleEngine::removeSystem(ParticleSystem* system)
    … …  
    192192
    193193/**
    194    \brief removes an emitter from the emitterList and also from all Connections it is attached to.
    195    \param emitter the ParticleEmitter to remove.
     194 * removes an emitter from the emitterList and also from all Connections it is attached to.
     195 * @param emitter the ParticleEmitter to remove.
    196196*/
    197197bool ParticleEngine::removeEmitter(ParticleEmitter* emitter)
    … …  
    213213
    214214/**
    215    \brief removes a Connection between an Emitter and a System
    216    \param emitter The emitter of the connection to remove
    217    \param system The system of the connection to remove
    218    \returns true, if the connection was broken, false if the conntection was not found
     215 * removes a Connection between an Emitter and a System
     216 * @param emitter The emitter of the connection to remove
     217 * @param system The system of the connection to remove
     218 * @returns true, if the connection was broken, false if the conntection was not found
    219219
    220220   only if both system and emitter are in the connection the Connection will be broken
    … …  
    240240
    241241/**
    242    \brief removes a Connection between an Emitter and a System
    243    \param connection the connection to remove
     242 * removes a Connection between an Emitter and a System
     243 * @param connection the connection to remove
    244244
    245245   \see bool ParticleEngine::breakConnection(ParticleEmitter* emitter, ParticleSystem* system)
    … …  
    253253
    254254/**
    255    \brief this function ticks all the ParticleSystems, so an animation will flow
    256    \param dt passed since last tick
     255 * this function ticks all the ParticleSystems, so an animation will flow
     256 * @param dt passed since last tick
    257257*/
    258258void ParticleEngine::tick(float dt)
    … …  
    280280
    281281/**
    282    \brief draws all the systems and their Particles.
     282 * draws all the systems and their Particles.
    283283*/
    284284void ParticleEngine::draw() const
    … …  
    296296
    297297/**
    298    \param systemName the name of the system to search for
    299    \returns the system called by systemName or NULL if not found
     298 * @param systemName the name of the system to search for
     299 * @returns the system called by systemName or NULL if not found
    300300*/
    301301ParticleSystem* ParticleEngine::getSystemByName(const char* systemName) const
    … …  
    317317
    318318/**
    319    \param number the n-th system to return
    320    \returns the system called by number or NULL if not found
     319 * @param number the n-th system to return
     320 * @returns the system called by number or NULL if not found
    321321*/
    322322ParticleSystem* ParticleEngine::getSystemByNumber(unsigned int number) const
    … …  
    340340
    341341/**
    342    \param emitterName the name of the emitter to search for
    343    \returns the emitter called by emitterName or NULL if not found
     342 * @param emitterName the name of the emitter to search for
     343 * @returns the emitter called by emitterName or NULL if not found
    344344*/
    345345ParticleEmitter* ParticleEngine::getEmitterByName(const char* emitterName) const
    … …  
    362362
    363363/**
    364    \param number the n-th emitter to return
    365    \returns the emitter called by number or NULL if not found
     364 * @param number the n-th emitter to return
     365 * @returns the emitter called by number or NULL if not found
    366366*/
    367367ParticleEmitter* ParticleEngine::getEmitterByNumber(unsigned int number) const
    … …  
    385385
    386386/**
    387    \brief outputs some nice debug information
     387 * outputs some nice debug information
    388388*/
    389389void ParticleEngine::debug()

  • orxonox/trunk/src/lib/particles/particle_engine.h

    r4746 r4836  
    11/*!
    22    \file particle_engine.h
    3     \brief Definition of the ParticleEngine
     3  * Definition of the ParticleEngine
    44*/
    55
    … …  
    3434 public:
    3535  virtual ~ParticleEngine();
    36   /** \returns a Pointer to the only object of this Class */
     36  /** @returns a Pointer to the only object of this Class */
    3737  inline static ParticleEngine* getInstance() { if (!singletonRef) singletonRef = new ParticleEngine();  return singletonRef; };
    3838

  • orxonox/trunk/src/lib/particles/particle_system.cc

    r4827 r4836  
    3535
    3636/**
    37    \brief standard constructor
    38    \param maxCount the Count of particles in the System
    39    \param type The Type of the ParticleSystem
     37 * standard constructor
     38 * @param maxCount the Count of particles in the System
     39 * @param type The Type of the ParticleSystem
    4040*/
    4141ParticleSystem::ParticleSystem (unsigned int maxCount, PARTICLE_TYPE type)
    … …  
    4949/**
    5050  \brief creates a Particle System out of a XML-element
    51   \param root: the XML-element to load from
     51* @param root: the XML-element to load from
    5252 */
    5353ParticleSystem::ParticleSystem(const TiXmlElement* root)
    … …  
    5959
    6060/**
    61    \brief standard deconstructor
     61 * standard deconstructor
    6262*/
    6363ParticleSystem::~ParticleSystem()
    … …  
    147147
    148148/**
    149   \param maxCount the maximum count of particles that can be emitted
     149* @param maxCount the maximum count of particles that can be emitted
    150150 */
    151151void ParticleSystem::setMaxCount(int maxCount)
    … …  
    156156
    157157/**
    158    \param particleType the type of particles in this System
    159    \param count how many particles (in PARTICLE_MULTI-mode)
    160    \todo this will be different
     158 * @param particleType the type of particles in this System
     159 * @param count how many particles (in PARTICLE_MULTI-mode)
     160   @todo this will be different
    161161*/
    162162void ParticleSystem::setType(const char* particleType)
    … …  
    173173
    174174/**
    175    \param particleType the type of particles in this System
    176    \param count how many particles (in PARTICLE_MULTI-mode)
    177    \todo this will be different
     175 * @param particleType the type of particles in this System
     176 * @param count how many particles (in PARTICLE_MULTI-mode)
     177   @todo this will be different
    178178*/
    179179void ParticleSystem::setType(PARTICLE_TYPE particleType, int count)
    … …  
    205205// setting properties
    206206/**
    207    \brief sets the material to an external material
    208    \param material: the material to set this material to.
     207 * sets the material to an external material
     208 * @param material: the material to set this material to.
    209209
    210210   !! important if the extern material gets deleted it MUST be unregistered here or segfault !!
    … …  
    216216
    217217/**
    218    \brief Sets the lifespan of newly created particles
     218 * Sets the lifespan of newly created particles
    219219*/
    220220void ParticleSystem::setLifeSpan(float lifeSpan, float randomLifeSpan)
    … …  
    225225
    226226/**
    227    \brief sets the conserve Factor of newly created particles
     227 * sets the conserve Factor of newly created particles
    228228*/
    229229void ParticleSystem::setConserve(float conserve)
    … …  
    241241/////////////////////////////
    242242/**
    243    \brief sets a key in the radius-animation on a per-particle basis
    244    \param lifeCycleTime the time (partilceLifeTime/particleAge) [0-1]
    245    \param radius the radius at this position
    246    \param randRadius the randRadius at this position
     243 * sets a key in the radius-animation on a per-particle basis
     244 * @param lifeCycleTime the time (partilceLifeTime/particleAge) [0-1]
     245 * @param radius the radius at this position
     246 * @param randRadius the randRadius at this position
    247247*/
    248248void ParticleSystem::setRadius(float lifeCycleTime, float radius, float randRadius)
    … …  
    253253
    254254/**
    255    \brief sets a key in the mass-animation on a per-particle basis
    256    \param lifeCycleTime the time (partilceLifeTime/particleAge) [0-1]
    257    \param mass the mass at this position
    258    \param randMass the randomMass at this position
     255 * sets a key in the mass-animation on a per-particle basis
     256 * @param lifeCycleTime the time (partilceLifeTime/particleAge) [0-1]
     257 * @param mass the mass at this position
     258 * @param randMass the randomMass at this position
    259259*/
    260260void ParticleSystem::setMass(float lifeCycleTime, float mass, float randMass)
    … …  
    265265
    266266/**
    267    \brief sets a key in the color-animation on a per-particle basis
    268    \param lifeCycleTime: the time (partilceLifeTime/particleAge) [0-1]
    269    \param red: red
    270    \param green: green
    271    \param blue: blue
    272    \param alpha: alpha
     267 * sets a key in the color-animation on a per-particle basis
     268 * @param lifeCycleTime: the time (partilceLifeTime/particleAge) [0-1]
     269 * @param red: red
     270 * @param green: green
     271 * @param blue: blue
     272 * @param alpha: alpha
    273273*/
    274274void ParticleSystem::setColor(float lifeCycleTime, float red, float green, float blue, float alpha)
    … …  
    281281
    282282/**
    283    \brief ticks the system.
    284    \param dt the time to tick all the Particles of the System
     283 * ticks the system.
     284 * @param dt the time to tick all the Particles of the System
    285285
    286286   this is used to get all the particles some motion
    … …  
    350350
    351351/**
    352     \brief applies some force to a Particle.
    353     \param field the Field to apply.
     352  * applies some force to a Particle.
     353  * @param field the Field to apply.
    354354 */
    355355void ParticleSystem::applyField(Field* field)
    … …  
    365365
    366366/**
    367  * \returns the count of Faces of this ParticleSystem
     367 * @returns the count of Faces of this ParticleSystem
    368368 */
    369369unsigned int ParticleSystem::getFaceCount() const
    … …  
    383383
    384384/**
    385    \brief draws all the Particles of this System
     385 * draws all the Particles of this System
    386386
    387387   The Cases in this Function all do the same:
    … …  
    410410      {
    411411        glColor4fv(drawPart->color);
    412           //! \todo implement a faster code for the look-at Camera algorithm.
    413 
    414         const PNode* camera = State::getCamera();  //!< \todo MUST be different
     412          //! @todo implement a faster code for the look-at Camera algorithm.
     413
     414        const PNode* camera = State::getCamera();  //!< @todo MUST be different
    415415        Vector cameraPos = camera->getAbsCoor();
    416416        Vector cameraTargetPos = State::getCameraTarget()->getAbsCoor();
    … …  
    515515
    516516/**
    517    \brief adds a new Particle to the System
    518    \param position the initial position, where the particle gets emitted.
    519    \param velocity the initial velocity of the particle.
    520    \param orientation the initial orientation of the Paritcle.
    521    \param momentum the initial momentum of the Particle (the speed of its rotation).
    522    \param data some more data given by the emitter
     517 * adds a new Particle to the System
     518 * @param position the initial position, where the particle gets emitted.
     519 * @param velocity the initial velocity of the particle.
     520 * @param orientation the initial orientation of the Paritcle.
     521 * @param momentum the initial momentum of the Particle (the speed of its rotation).
     522 * @param data some more data given by the emitter
    523523*/
    524524void ParticleSystem::addParticle(const Vector& position, const Vector& velocity, const Quaternion& orientation, const Quaternion& momentum, unsigned int data)
    … …  
    566566      particles->momentum = momentum;
    567567
    568       //  particle->rotation = ; //! \todo rotation is once again something to be done.
     568      //  particle->rotation = ; //! @todo rotation is once again something to be done.
    569569      particles->massRand = 2*(float)rand()/RAND_MAX -1;
    570570      particles->radiusRand = 2* (float)rand()/RAND_MAX -1;
    … …  
    579579
    580580/**
    581    \brief outputs some nice debug information
     581 * outputs some nice debug information
    582582*/
    583583void ParticleSystem::debug() const

  • orxonox/trunk/src/lib/particles/particle_system.h

    r4746 r4836  
    8989  void setColor(float lifeCycleTime, float red, float green, float blue, float alpha);
    9090
    91   /** \returns the Type of the particles */
     91  /** @returns the Type of the particles */
    9292  inline PARTICLE_TYPE getType() const { return this->particleType; };
    93   /** \returns the Material that lies on this particles */
     93  /** @returns the Material that lies on this particles */
    9494  inline const Material* getMaterial() const { return this->material; };
    95   /** \returns the lifespan of the particles */
     95  /** @returns the lifespan of the particles */
    9696  inline float getLifeSpan() const { return this->lifeSpan; };
    97   /** \returns the starting-radius of the particles */
     97  /** @returns the starting-radius of the particles */
    9898  inline float getStartRadius() { return this->radiusAnim.getValue(0.0); };
    99   /** \returns the end-radius of the particles */
     99  /** @returns the end-radius of the particles */
    100100  inline float getEndRadius() { return this->radiusAnim.getValue(1.0); };
    101   /** \returns the conserve-factor of the particles */
     101  /** @returns the conserve-factor of the particles */
    102102  inline float getConserve() const { return this->conserve; };
    103   /** \returns the initial mass of the particles */
     103  /** @returns the initial mass of the particles */
    104104  inline float getMass() const { return this->initialMass; };
    105105
    … …  
    108108
    109109  virtual void applyField(Field* field);
    110   /** \brief this is an empty function, because the Physics are implemented in tick \param dt: useless here */
     110  /** \brief this is an empty function, because the Physics are implemented in tick @param dt: useless here */
    111111  virtual void tickPhys(float dt) {};
    112112

  • orxonox/trunk/src/lib/particles/quick_animation.cc

    r4746 r4836  
    2828
    2929/**
    30    \brief standard constructor
     30 * standard constructor
    3131*/
    3232QuickAnimation::QuickAnimation ()
    … …  
    4343
    4444/**
    45    \brief deletes all the deconstructor stuff
     45 * deletes all the deconstructor stuff
    4646*/
    4747QuickAnimation::~QuickAnimation ()
    … …  
    6060
    6161/**
    62    \brief adds a new entry to the list of keyframes
    63    \param position the position to add the key to
    64    \param value the Value to set for the position
    65    \returns false if the key existed already for a given position
     62 * adds a new entry to the list of keyframes
     63 * @param position the position to add the key to
     64 * @param value the Value to set for the position
     65 * @returns false if the key existed already for a given position
    6666*/
    6767void QuickAnimation::addEntry(float position, float value)
    … …  
    128128
    129129/**
    130    \brief changes an entry in the region of position
    131    \param position the Position of an existing keyframe
    132    \param region a deviation of the existing keyframe (like a delta in witch to search for
    133    \param value the new Value
     130 * changes an entry in the region of position
     131 * @param position the Position of an existing keyframe
     132 * @param region a deviation of the existing keyframe (like a delta in witch to search for
     133 * @param value the new Value
    134134
    135135   if the Entry at the in the region of the specified position is found, it will be changed.
    136136    Otherwise a new KeyFrame will be created with value at position.
    137    \todo rimplement
     137   @todo rimplement
    138138*/
    139139void QuickAnimation::changeEntry(float position, float value, float region)
    … …  
    202202
    203203/**
    204    \brief returns the value of the animation at a certain position
    205    \param position the position to get the value from :)
     204 * returns the value of the animation at a certain position
     205 * @param position the position to get the value from :)
    206206*/
    207207float QuickAnimation::getValue(float position)
    … …  
    226226
    227227/**
    228    \brief outputs some nice information about this class
     228 * outputs some nice information about this class
    229229*/
    230230void QuickAnimation::debug()

  • orxonox/trunk/src/lib/particles/quick_animation.h

    r4746 r4836  
    11/*!
    22    \file quick_animation.h
    3     \brief Definition of the QuickAnimation-class
     3  * Definition of the QuickAnimation-class
    44
    55*/
    … …  
    4343
    4444  void removeEntry(float position);
    45   /** \todo implemente those functions
     45  /** @todo implemente those functions
    4646      bool moveEntry(float position);
    4747  */
Note: See TracChangeset for help on using the changeset viewer.