proland::RandomParticleLayer Class Reference
[particles]

A ParticleLayer to add random 3D coordinates to a particle. More...

#include <RandomParticleLayer.h>

Inheritance diagram for proland::RandomParticleLayer:
proland::ParticleLayer

List of all members.

Classes

struct  RandomParticle
 Layer specific particle data for managing random particles. More...

Public Member Functions

 RandomParticleLayer (box3f bounds)
 Creates a new RandomParticleLayer.
virtual ~RandomParticleLayer ()
 Deletes this RandomParticleLayer.
RandomParticlegetRandomParticle (ParticleStorage::Particle *p)
 Returns the random specific data of the given particle.
virtual void addNewParticles ()
 Adds new particles.

Protected Member Functions

 RandomParticleLayer ()
 Creates an uninitialized RandomParticleLayer.
void init (box3f bounds)
 Initializes this RandomParticleLayer.
virtual void initParticle (ParticleStorage::Particle *p)
 Initializes the random position of the given particle.

Private Attributes

box3f bounds
 The bounds of the random positions.

Detailed Description

A ParticleLayer to add random 3D coordinates to a particle.

This class provides particle data to store a position for each particle.

Authors:
Antoine Begault, Eric Bruneton

Constructor & Destructor Documentation

proland::RandomParticleLayer::RandomParticleLayer ( box3f  bounds  ) 

Creates a new RandomParticleLayer.

Parameters:
bounds the bounds of the random positions.
virtual proland::RandomParticleLayer::~RandomParticleLayer (  )  [virtual]

Deletes this RandomParticleLayer.

proland::RandomParticleLayer::RandomParticleLayer (  )  [protected]

Creates an uninitialized RandomParticleLayer.


Member Function Documentation

virtual void proland::RandomParticleLayer::addNewParticles (  )  [virtual]

Adds new particles.

The default implementation of this method does nothing.

Reimplemented from proland::ParticleLayer.

RandomParticle* proland::RandomParticleLayer::getRandomParticle ( ParticleStorage::Particle p  )  [inline]

Returns the random specific data of the given particle.

Parameters:
p a particle.
void proland::RandomParticleLayer::init ( box3f  bounds  )  [protected]

Initializes this RandomParticleLayer.

See RandomParticleLayer.

virtual void proland::RandomParticleLayer::initParticle ( ParticleStorage::Particle p  )  [protected, virtual]

Initializes the random position of the given particle.

Reimplemented from proland::ParticleLayer.


Member Data Documentation

The bounds of the random positions.


Generated on Sat May 12 09:41:37 2012 for proland by  doxygen 1.6.1