ParticleSystem Class Reference

A particle system. More...

#include <ParticleSystem.h>

Inheritance diagram for ParticleSystem:

Collaboration diagram for ParticleSystem:

Public Member Functions
	ParticleSystem (const Ogre::String &name)
	Constructor. More...
virtual	~ParticleSystem ()
	Destructor. More...
void	CopyAttributesTo (ParticleSystem *ps)
	Copies the system attributes to another ParticleSystem. More...
const Ogre::String &	getMovableType () const
	Retrieves the movable type. More...
const Ogre::AxisAlignedBox &	getBoundingBox () const
	Retrieves the object bounding box. More...
Ogre::Real	getBoundingRadius () const
	Retrieves the bounding radius. More...
void	_updateRenderQueue (Ogre::RenderQueue *queue)
	Adds the system to the scene render queue. More...
void	visitRenderables (Ogre::Renderable::Visitor *visitor, bool debug_renderables=false)
	Visits renderables. More...
void	Update (Ogre::Real time_elapsed)
	Updates the system. More...
ParticleTechnique *	CreateTechnique ()
	Technique creator. More...
void	AddTechnique (ParticleTechnique *technique)
	Adds a technique to the system. More...
void	DestroyAllTechniques ()
	Removes al techniques from the system. More...

Private Attributes
std::vector< ParticleTechnique * >	techniques_
	List of the system techniques. More...

Detailed Description

A particle system.

Todo:

What is this?

Constructor & Destructor Documentation

ParticleSystem()

ParticleSystem::ParticleSystem

(

const Ogre::String &

name

)

Constructor.

~ParticleSystem()

ParticleSystem::~ParticleSystem ( )

virtual

Destructor.

Member Function Documentation

_updateRenderQueue()

void ParticleSystem::_updateRenderQueue

(

Ogre::RenderQueue *

queue

)

Adds the system to the scene render queue.

Parameters

[in,out]

queue

The queue to update.

AddTechnique()

void ParticleSystem::AddTechnique

(

ParticleTechnique *

technique

)

Adds a technique to the system.

Parameters

[in]

technique

Technique to add to the system

CopyAttributesTo()

void ParticleSystem::CopyAttributesTo

(

ParticleSystem *

ps

)

Copies the system attributes to another ParticleSystem.

Parameters

[out]

ps

The ParticleSystem to copy the attributes to.

CreateTechnique()

ParticleTechnique * ParticleSystem::CreateTechnique

(

)

Technique creator.

Creates a new technique and adds it to the system.

Returns

Pointer to the newly created technique.

DestroyAllTechniques()

void ParticleSystem::DestroyAllTechniques

(

)

Removes al techniques from the system.

getBoundingBox()

const Ogre::AxisAlignedBox & ParticleSystem::getBoundingBox

(

)

const

Retrieves the object bounding box.

Returns

The bounding box.

getBoundingRadius()

Ogre::Real ParticleSystem::getBoundingRadius

(

)

const

Retrieves the bounding radius.

Returns

The bounding radius.

getMovableType()

const Ogre::String & ParticleSystem::getMovableType

(

)

const

Retrieves the movable type.

Returns

The movable type.

Todo:

Understand and document.

Update()

void ParticleSystem::Update

(

Ogre::Real

time_elapsed

)

Updates the system.

Updates the system status based on the elapsed time.

Parameters

[in]

time_elapsed

The elapsed time.

visitRenderables()

void ParticleSystem::visitRenderables ( Ogre::Renderable::Visitor *  visitor, bool  debug_renderables = false  )

inline

Visits renderables.

Parameters

[in]	visitor	The visitor.
[in]	debug_renderables	True to debug the renderables, default is false

Todo:

Understand and document.

Member Data Documentation

techniques_

std::vector<ParticleTechnique*> ParticleSystem::techniques_

private

List of the system techniques.

---

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

• src/core/particles/ParticleSystem.h
• src/core/particles/ParticleSystem.cpp