ParticleSystems::VectorDS Class Reference

The VectorDS Class. More...

#include <VectorDS.h>

Inheritance diagram for ParticleSystems::VectorDS:

List of all members.

Public Member Functions
	VectorDS ()
	The Constructor.
virtual	~VectorDS ()
	The Destructor.
virtual void	addParticles (Particle *particle)
	A virtual Function.
virtual void	killParticles ()
	A virtual Function.
virtual void	evolve ()
	A virtual Function.
virtual bool	positionCheck (GraphicsLib::Point3 pos)
	A virtual Function.
virtual void	draw ()
	A virtual Function.
virtual int	numParticles ()
	A virtual Function.
virtual bool	hasDead ()
	A virtual Function.
virtual Particle *	getDead ()
	A virtual Function.
virtual void	addCollisionObject (CollisionObject *co)
	A virtual Function.
virtual void	deleteCollisionObject (CollisionObject *co)
	A virtual Function.
Public Attributes
allP	particles
	The typdef definition.
dead	deadParticles
	The typdef definition.
cObjects	collisionObjects
	The typdef definition.

---

Detailed Description

The VectorDS Class.

The VectorDS Class extends the DataStructure Class. The VectorDS Class uses the vector container Class to store all the Particles and CollisionObjects.

See also:

DataStructure

Author:

Hannes Ricklefs

Definition at line 53 of file VectorDS.h.

---

Constructor & Destructor Documentation

VectorDS::VectorDS (   )

The Constructor. Constructs a new VectorDS Definition at line 12 of file VectorDS.cpp.

VectorDS::~VectorDS (   )  [virtual]

The Destructor. Destructs a VectorDS Definition at line 15 of file VectorDS.cpp.

---

Member Function Documentation

void VectorDS::addCollisionObject (  CollisionObject *  co  )  [virtual]

A virtual Function. Add a new CollisionObject to the VectorDS Parameters: co  a pointer to the CollisionObject Implements ParticleSystems::DataStructure. Definition at line 129 of file VectorDS.cpp. References collisionObjects.

void VectorDS::addParticles (  Particle *  particle  )  [virtual]

A virtual Function. Adds a new Particle. Parameters: particle  a pointer to the new Particle Implements ParticleSystems::DataStructure. Definition at line 18 of file VectorDS.cpp. References particles.

void VectorDS::deleteCollisionObject (  CollisionObject *  co  )  [virtual]

A virtual Function. Deletes the given CollisionObject Parameters: co  a pointer to the about to be deleted CollisionObject Implements ParticleSystems::DataStructure. Definition at line 133 of file VectorDS.cpp.

void VectorDS::draw (   )  [virtual]

A virtual Function. Draws all the Particle and CollisionObjects within this VectorDS Implements ParticleSystems::DataStructure. Definition at line 71 of file VectorDS.cpp. References collisionObjects, and particles.

void VectorDS::evolve (   )  [virtual]

A virtual Function. Evolves the Particles within the VectorDS Implements ParticleSystems::DataStructure. Definition at line 26 of file VectorDS.cpp. References collisionObjects, deadParticles, and particles.

Particle * VectorDS::getDead (   )  [virtual]

A virtual Function. Returns a pointer to a dead Particle !! Should only be used if hasDead returns True !! Otherwise NULL will be returned. Returns: A pointer to a dead Particle. Implements ParticleSystems::DataStructure. Definition at line 110 of file VectorDS.cpp. References deadParticles.

bool VectorDS::hasDead (   )  [virtual]

A virtual Function. Returns true if the VectorDS contains any dead Particles Returns: True is dead Particles are stored Implements ParticleSystems::DataStructure. Definition at line 106 of file VectorDS.cpp. References deadParticles.

void VectorDS::killParticles (   )  [virtual]

A virtual Function. Removes all Particles Implements ParticleSystems::DataStructure. Definition at line 22 of file VectorDS.cpp. References particles.

int VectorDS::numParticles (   )  [virtual]

A virtual Function. Return the number of Particles within this VectorDS as an int. Returns: The number of Particles Implements ParticleSystems::DataStructure. Definition at line 102 of file VectorDS.cpp. References particles.

bool VectorDS::positionCheck (  GraphicsLib::Point3  pos  )  [virtual]

A virtual Function. Checks is the given point is colliding with any of the CollisionObjects. Parameters: pos  the position to be checked Returns: True if in collision range Implements ParticleSystems::DataStructure. Definition at line 67 of file VectorDS.cpp.

---

Member Data Documentation

cObjects ParticleSystems::VectorDS::collisionObjects

The typdef definition. Stores all the CollisionObjects Definition at line 159 of file VectorDS.h. Referenced by addCollisionObject(), draw(), and evolve().

dead ParticleSystems::VectorDS::deadParticles

The typdef definition. Stores all the dead Particles Definition at line 153 of file VectorDS.h. Referenced by evolve(), getDead(), and hasDead().

allP ParticleSystems::VectorDS::particles

The typdef definition. Stores all the Particles Definition at line 147 of file VectorDS.h. Referenced by addParticles(), draw(), evolve(), killParticles(), and numParticles().

---

The documentation for this class was generated from the following files:

• /Users/hannes/Documents/Uni/Bournemouth/Term2/ProgrammingGFX/ParticleSystem/VectorDS.h
• /Users/hannes/Documents/Uni/Bournemouth/Term2/ProgrammingGFX/ParticleSystem/VectorDS.cpp

---