ParticleEntityRenderer Class Reference

A particle entity renderer. More...

#include <ParticleEntityRenderer.h>

Inheritance diagram for ParticleEntityRenderer:

Collaboration diagram for ParticleEntityRenderer:

Public Member Functions
	ParticleEntityRenderer ()
	Constructor. More...
virtual	~ParticleEntityRenderer ()
	Destructor. More...
virtual void	CopyAttributesTo (ParticleRenderer *renderer)
	Copies the atributtes to other renderer. More...
const Ogre::String &	GetMeshName () const
	Retrieves the emitter's mesh name. More...
void	SetMeshName (const Ogre::String &mesh_name)
	Sets the emitter's mesh name. More...
void	Clear ()
	Clears all data in the entity. More...
virtual void	SetVisible (bool visible)
	Toggles the particle entity visibility. More...
virtual void	Initialize ()
	Initializes the particle. More...
virtual void	UpdateRenderQueue (Ogre::RenderQueue *queue, ParticlePool< VisualParticle > &pool)
	Adds the particle to the scene render queue. More...
Public Member Functions inherited from ParticleRenderer
	ParticleRenderer ()
	Constructor. More...
virtual	~ParticleRenderer ()
	Destructor. More...
virtual void	CopyAttributesTo (ParticleRenderer *renderer)
	Copies the renderer attributes to other renderer. More...
void	SetRendererInitialised (bool renderer_initialised)
	Toggles renderer initialization state. More...
bool	IsRendererInitialised () const
	Checks the renderer initialization status. More...
void	SetRendererType (Ogre::String renderer_type)
	Sets the renderer type. More...
const Ogre::String &	GetRendererType () const
	Retrieves the renderer type. More...
void	SetParentTechnique (ParticleTechnique *parent_technique)
	Sets the renderer parent technique. More...
const ParticleTechnique *	GetParentTechnique () const
	Sets the renderer particle technique. More...
virtual void	SetVisible (bool visible=true)=0
	Toggles the visibility of the particle renderer. More...
virtual void	Initialize ()=0
	Initializes the renderer. More...
virtual void	UpdateRenderQueue (Ogre::RenderQueue *queue, ParticlePool< VisualParticle > &pool)=0
	Adds the particle to the scene render queue. More...

Protected Attributes
std::vector< ParticleEntityAdditionalData * >	all_additional_data_
	Additional data for the rendered. More...
std::vector< ParticleEntityAdditionalData * >	unassigned_additional_data_
	Additional data for the rendered that is not yet assigned. More...
std::vector< Ogre::Entity * >	entities_
	List of entities. More...
Ogre::String	mesh_name_
	The mesh name for the particles. More...
Protected Attributes inherited from ParticleRenderer
bool	renderer_initialized_
	Indicates if the renderer has been initialized. More...
Ogre::String	renderer_type_
	The type of renderer. More...
ParticleTechnique *	parent_technique_
	The renderer particle tchnique. More...

Static Protected Attributes
static ParticleEntityRendererDictionary::MeshName	mesh_name_dictionary_
	A dictionary of mesh names. More...

Detailed Description

A particle entity renderer.

Constructor & Destructor Documentation

ParticleEntityRenderer()

ParticleEntityRenderer::ParticleEntityRenderer

(

)

Constructor.

~ParticleEntityRenderer()

ParticleEntityRenderer::~ParticleEntityRenderer ( )

virtual

Destructor.

Member Function Documentation

Clear()

void ParticleEntityRenderer::Clear

(

)

Clears all data in the entity.

CopyAttributesTo()

void ParticleEntityRenderer::CopyAttributesTo ( ParticleRenderer *  renderer )

virtual

Copies the atributtes to other renderer.

Parameters

[out]

renderer

Renderer to copy the attributes to.

Reimplemented from ParticleRenderer.

GetMeshName()

const Ogre::String & ParticleEntityRenderer::GetMeshName

(

)

const

Retrieves the emitter's mesh name.

Returns

The emitter mesh name.

Initialize()

void ParticleEntityRenderer::Initialize ( )

virtual

Initializes the particle.

Implements ParticleRenderer.

SetMeshName()

void ParticleEntityRenderer::SetMeshName

(

const Ogre::String &

mesh_name

)

Sets the emitter's mesh name.

Parameters

[in]

mesh_name

The name for the emitter's mesh.

SetVisible()

void ParticleEntityRenderer::SetVisible ( bool  visible )

virtual

Toggles the particle entity visibility.

Parameters

[in]

visible

True to make the particle visible, false to make it invisible.

Implements ParticleRenderer.

UpdateRenderQueue()

void ParticleEntityRenderer::UpdateRenderQueue ( Ogre::RenderQueue *  queue, ParticlePool< VisualParticle > &  pool  )

virtual

Adds the particle to the scene render queue.

Parameters

[in]	queue	Unused.
[in]	pool	The particle pool.

Implements ParticleRenderer.

Member Data Documentation

all_additional_data_

std::vector<ParticleEntityAdditionalData*> ParticleEntityRenderer::all_additional_data_

protected

Additional data for the rendered.

entities_

std::vector<Ogre::Entity*> ParticleEntityRenderer::entities_

protected

List of entities.

Todo:

What are these entities?

mesh_name_

Ogre::String ParticleEntityRenderer::mesh_name_

protected

The mesh name for the particles.

mesh_name_dictionary_

ParticleEntityRendererDictionary::MeshName ParticleEntityRenderer::mesh_name_dictionary_

staticprotected

A dictionary of mesh names.

unassigned_additional_data_

std::vector<ParticleEntityAdditionalData*> ParticleEntityRenderer::unassigned_additional_data_

protected

Additional data for the rendered that is not yet assigned.

---

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

• src/core/particles/renderer/ParticleEntityRenderer.h
• src/core/particles/renderer/ParticleEntityRenderer.cpp