Changeset 4836 in orxonox.OLD for orxonox/trunk/src/lib/particles/particle_system.cc
- Timestamp:
- Jul 12, 2005, 12:33:16 AM (19 years ago)
-
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
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
orxonox/trunk/src/lib/particles/particle_system.cc
r4827 r4836 35 35 36 36 /** 37 \briefstandard constructor38 \param maxCount the Count of particles in the System39 \param type The Type of the ParticleSystem37 * standard constructor 38 * @param maxCount the Count of particles in the System 39 * @param type The Type of the ParticleSystem 40 40 */ 41 41 ParticleSystem::ParticleSystem (unsigned int maxCount, PARTICLE_TYPE type) … … 49 49 /** 50 50 \brief creates a Particle System out of a XML-element 51 \param root: the XML-element to load from51 * @param root: the XML-element to load from 52 52 */ 53 53 ParticleSystem::ParticleSystem(const TiXmlElement* root) … … 59 59 60 60 /** 61 \briefstandard deconstructor61 * standard deconstructor 62 62 */ 63 63 ParticleSystem::~ParticleSystem() … … 147 147 148 148 /** 149 \param maxCount the maximum count of particles that can be emitted149 * @param maxCount the maximum count of particles that can be emitted 150 150 */ 151 151 void ParticleSystem::setMaxCount(int maxCount) … … 156 156 157 157 /** 158 \param particleType the type of particles in this System159 \param count how many particles (in PARTICLE_MULTI-mode)160 \todo this will be different158 * @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 161 161 */ 162 162 void ParticleSystem::setType(const char* particleType) … … 173 173 174 174 /** 175 \param particleType the type of particles in this System176 \param count how many particles (in PARTICLE_MULTI-mode)177 \todo this will be different175 * @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 178 178 */ 179 179 void ParticleSystem::setType(PARTICLE_TYPE particleType, int count) … … 205 205 // setting properties 206 206 /** 207 \briefsets the material to an external material208 \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. 209 209 210 210 !! important if the extern material gets deleted it MUST be unregistered here or segfault !! … … 216 216 217 217 /** 218 \briefSets the lifespan of newly created particles218 * Sets the lifespan of newly created particles 219 219 */ 220 220 void ParticleSystem::setLifeSpan(float lifeSpan, float randomLifeSpan) … … 225 225 226 226 /** 227 \briefsets the conserve Factor of newly created particles227 * sets the conserve Factor of newly created particles 228 228 */ 229 229 void ParticleSystem::setConserve(float conserve) … … 241 241 ///////////////////////////// 242 242 /** 243 \briefsets a key in the radius-animation on a per-particle basis244 \param lifeCycleTime the time (partilceLifeTime/particleAge) [0-1]245 \param radius the radius at this position246 \param randRadius the randRadius at this position243 * 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 247 247 */ 248 248 void ParticleSystem::setRadius(float lifeCycleTime, float radius, float randRadius) … … 253 253 254 254 /** 255 \briefsets a key in the mass-animation on a per-particle basis256 \param lifeCycleTime the time (partilceLifeTime/particleAge) [0-1]257 \param mass the mass at this position258 \param randMass the randomMass at this position255 * 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 259 259 */ 260 260 void ParticleSystem::setMass(float lifeCycleTime, float mass, float randMass) … … 265 265 266 266 /** 267 \briefsets a key in the color-animation on a per-particle basis268 \param lifeCycleTime: the time (partilceLifeTime/particleAge) [0-1]269 \param red: red270 \param green: green271 \param blue: blue272 \param alpha: alpha267 * 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 273 273 */ 274 274 void ParticleSystem::setColor(float lifeCycleTime, float red, float green, float blue, float alpha) … … 281 281 282 282 /** 283 \briefticks the system.284 \param dt the time to tick all the Particles of the System283 * ticks the system. 284 * @param dt the time to tick all the Particles of the System 285 285 286 286 this is used to get all the particles some motion … … 350 350 351 351 /** 352 \briefapplies 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. 354 354 */ 355 355 void ParticleSystem::applyField(Field* field) … … 365 365 366 366 /** 367 * \returns the count of Faces of this ParticleSystem367 * @returns the count of Faces of this ParticleSystem 368 368 */ 369 369 unsigned int ParticleSystem::getFaceCount() const … … 383 383 384 384 /** 385 \briefdraws all the Particles of this System385 * draws all the Particles of this System 386 386 387 387 The Cases in this Function all do the same: … … 410 410 { 411 411 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 different412 //! @todo implement a faster code for the look-at Camera algorithm. 413 414 const PNode* camera = State::getCamera(); //!< @todo MUST be different 415 415 Vector cameraPos = camera->getAbsCoor(); 416 416 Vector cameraTargetPos = State::getCameraTarget()->getAbsCoor(); … … 515 515 516 516 /** 517 \briefadds a new Particle to the System518 \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 emitter517 * 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 523 523 */ 524 524 void ParticleSystem::addParticle(const Vector& position, const Vector& velocity, const Quaternion& orientation, const Quaternion& momentum, unsigned int data) … … 566 566 particles->momentum = momentum; 567 567 568 // particle->rotation = ; //! \todo rotation is once again something to be done.568 // particle->rotation = ; //! @todo rotation is once again something to be done. 569 569 particles->massRand = 2*(float)rand()/RAND_MAX -1; 570 570 particles->radiusRand = 2* (float)rand()/RAND_MAX -1; … … 579 579 580 580 /** 581 \briefoutputs some nice debug information581 * outputs some nice debug information 582 582 */ 583 583 void ParticleSystem::debug() const
Note: See TracChangeset
for help on using the changeset viewer.
