ParticleRenderer Class Reference

A particle renderer. More...

#include <ParticleRenderer.h>

Inheritance diagram for ParticleRenderer:

Collaboration diagram for ParticleRenderer:

Public Member Functions
	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
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...

Detailed Description

A particle renderer.

Constructor & Destructor Documentation

ParticleRenderer()

ParticleRenderer::ParticleRenderer

(

)

Constructor.

~ParticleRenderer()

ParticleRenderer::~ParticleRenderer ( )

virtual

Destructor.

Member Function Documentation

CopyAttributesTo()

void ParticleRenderer::CopyAttributesTo ( ParticleRenderer *  renderer )

virtual

Copies the renderer attributes to other renderer.

Parameters

[out]

renderer

The renderer to copy the attributes to.

Reimplemented in ParticleEntityRenderer.

GetParentTechnique()

const ParticleTechnique * ParticleRenderer::GetParentTechnique

(

)

const

Sets the renderer particle technique.

Returns

The renderer particle technique.

GetRendererType()

const Ogre::String & ParticleRenderer::GetRendererType

(

)

const

Retrieves the renderer type.

Returns

The renderer type.

Initialize()

virtual void ParticleRenderer::Initialize ( )

pure virtual

Initializes the renderer.

Implemented in ParticleEntityRenderer.

IsRendererInitialised()

bool ParticleRenderer::IsRendererInitialised

(

)

const

Checks the renderer initialization status.

Returns

True if the renderer is initialized, false if not.

SetParentTechnique()

void ParticleRenderer::SetParentTechnique

(

ParticleTechnique *

parent_technique

)

Sets the renderer parent technique.

Parameters

[in]

parent_technique

Parent technique for the renderer.

SetRendererInitialised()

void ParticleRenderer::SetRendererInitialised

(

bool

renderer_initialised

)

Toggles renderer initialization state.

Parameters

[in]

renderer_initialised

True to mark the renderer as initialized, false to mark it as not initialized.

SetRendererType()

void ParticleRenderer::SetRendererType

(

Ogre::String

renderer_type

)

Sets the renderer type.

Parameters

[in]

renderer_type

The renderer type.

SetVisible()

virtual void ParticleRenderer::SetVisible ( bool  visible = true )

pure virtual

Toggles the visibility of the particle renderer.

Parameters

[in]

visible

True to make th renderer visibible, false to make it invisible.

Implemented in ParticleEntityRenderer.

UpdateRenderQueue()

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

pure virtual

Adds the particle to the scene render queue.

Parameters

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

Implemented in ParticleEntityRenderer.

Member Data Documentation

parent_technique_

ParticleTechnique* ParticleRenderer::parent_technique_

protected

The renderer particle tchnique.

renderer_initialized_

bool ParticleRenderer::renderer_initialized_

protected

Indicates if the renderer has been initialized.

renderer_type_

Ogre::String ParticleRenderer::renderer_type_

protected

The type of renderer.

---

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

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