ParticleUniverse::RibbonTrailRenderer Class Reference

#include <ParticleUniverseRibbonTrailRenderer.h>

Inheritance diagram for ParticleUniverse::RibbonTrailRenderer:

Public Member Functions
	RibbonTrailRenderer (void)
virtual	~RibbonTrailRenderer (void)
virtual void	_notifyRescaled (const Vector3 &scale)
bool	isUseVertexColours (void) const
void	setUseVertexColours (bool useVertexColours)
size_t	getMaxChainElements (void) const
void	setMaxChainElements (size_t maxChainElements)
Real	getTrailLength (void) const
void	setTrailLength (Real trailLength)
Real	getTrailWidth (void) const
void	setTrailWidth (Real trailWidth)
bool	isRandomInitialColour (void) const
void	setRandomInitialColour (bool randomInitialColour)
const ColourValue &	getInitialColour (void) const
void	setInitialColour (const ColourValue &initialColour)
const ColourValue &	getColourChange (void) const
void	setColourChange (const ColourValue &colourChange)
void	_destroyAll (void)
virtual void	setVisible (bool visible)
virtual void	_prepare (ParticleTechnique *technique)
virtual void	_unprepare (ParticleTechnique *technique)
virtual void	_updateRenderQueue (Ogre::RenderQueue *queue, ParticlePool *pool)
virtual void	_notifyAttached (Ogre::Node *parent, bool isTagPoint=false)
virtual void	_setMaterialName (const String &materialName)
virtual void	_notifyCurrentCamera (Camera *cam)
virtual void	_notifyParticleQuota (size_t quota)
virtual void	_notifyDefaultDimensions (Real width, Real height, Real depth)
virtual void	_notifyParticleResized (void)
virtual void	_notifyParticleZRotated (void)
virtual void	setRenderQueueGroup (uint8 queueId)
virtual SortMode	_getSortMode (void) const
virtual void	copyAttributesTo (ParticleRenderer *renderer)
virtual void	particleEmitted (ParticleTechnique *particleTechnique, Particle *particle)
virtual void	particleExpired (ParticleTechnique *particleTechnique, Particle *particle)
Public Member Functions inherited from ParticleUniverse::ParticleRenderer
	ParticleRenderer (void)
virtual	~ParticleRenderer (void)
const String &	getRendererType (void) const
void	setRendererType (String rendererType)
ParticleTechnique *	getParentTechnique (void) const
void	setParentTechnique (ParticleTechnique *parentTechnique)
bool	isRendererInitialised (void) const
void	setRendererInitialised (bool rendererInitialised)
virtual void	_notifyStart (void)
virtual void	_notifyStop (void)
virtual void	_processParticle (ParticleTechnique *particleTechnique, Particle *particle, Real timeElapsed, bool firstParticle)
bool	getUseSoftParticles (void) const
void	setUseSoftParticles (bool useSoftParticles)
Real	getSoftParticlesContrastPower (void) const
Real	getSoftParticlesScale (void) const
Real	getSoftParticlesDelta (void) const
void	setSoftParticlesContrastPower (Real softParticlesContrastPower)
void	setSoftParticlesScale (Real softParticlesScale)
void	setSoftParticlesDelta (Real softParticlesDelta)
virtual uint8	getRenderQueueGroup (void) const
const bool	isSorted (void) const
void	setSorted (bool sorted)
const uchar	getTextureCoordsRows (void) const
void	setTextureCoordsRows (uchar const textureCoordsRows)
const uchar	getTextureCoordsColumns (void) const
void	setTextureCoordsColumns (uchar const textureCoordsColumns)
size_t	getNumTextureCoords (void)
virtual void	copyParentAttributesTo (ParticleRenderer *renderer)
void	addTextureCoords (const Real u, const Real v, const Real width, const Real height)
const vector< Ogre::FloatRect * > &	getTextureCoords (void) const
Public Member Functions inherited from ParticleUniverse::IAlias
	IAlias (void)
virtual	~IAlias (void)
const String &	getAliasName (void) const
void	setAliasName (String aliasName)
const AliasType	getAliasType (void) const
void	setAliasType (AliasType aliasType)
Public Member Functions inherited from ParticleUniverse::IElement
	IElement (void)
virtual	~IElement (void)
Public Member Functions inherited from ParticleUniverse::TechniqueListener
	TechniqueListener (void)
virtual	~TechniqueListener (void)

Static Public Attributes
static const bool	DEFAULT_USE_VERTEX_COLOURS
static const size_t	DEFAULT_MAX_ELEMENTS
static const Real	DEFAULT_LENGTH
static const Real	DEFAULT_WIDTH
static const bool	DEFAULT_RANDOM_INITIAL_COLOUR
static const ColourValue	DEFAULT_INITIAL_COLOUR
static const ColourValue	DEFAULT_COLOUR_CHANGE
Static Public Attributes inherited from ParticleUniverse::ParticleRenderer
static const uint8	DEFAULT_RENDER_QUEUE_GROUP
static const bool	DEFAULT_SORTED
static const uchar	DEFAULT_TEXTURECOORDS_ROWS
static const uchar	DEFAULT_TEXTURECOORDS_COLUMNS
static const bool	DEFAULT_USE_SOFT_PARTICLES
static const Real	DEFAULT_SOFT_PARTICLES_CONTRAST_POWER
static const Real	DEFAULT_SOFT_PARTICLES_SCALE
static const Real	DEFAULT_SOFT_PARTICLES_DELTA

Protected Attributes
vector< RibbonTrailRendererVisualData * >	mAllVisualData
vector< RibbonTrailRendererVisualData * >	mVisualData
size_t	mQuota
Ogre::RibbonTrail *	mTrail
String	mRibbonTrailName
bool	mUseVertexColours
size_t	mMaxChainElements
Real	mTrailLength
Real	mTrailWidth
bool	mRandomInitialColour
bool	mSetLength
bool	mSetWidth
ColourValue	mInitialColour
ColourValue	mColourChange
Ogre::SceneNode *	mChildNode
Protected Attributes inherited from ParticleUniverse::ParticleRenderer
ParticleTechnique *	mParentTechnique
Ogre::BillboardSet *	mBillboardSet
String	mRendererType
bool	mCullIndividual
Real	mHeight
Real	mWidth
Real	mDepth
bool	mSorted
uint8	mQueueId
bool	mRendererInitialised
Vector3	_mRendererScale
vector< Ogre::FloatRect * >	mUVList
uchar	mTextureCoordsRows
uchar	mTextureCoordsColumns
bool	mTextureCoordsRowsAndColumnsSet
bool	mTextureCoordsSet
bool	mUseSoftParticles
Real	mSoftParticlesContrastPower
Real	mSoftParticlesScale
Real	mSoftParticlesDelta
bool	mNotifiedDepthMap
bool	mVisible
bool	mDepthCheckEnabled
bool	mDepthWriteEnabled
Protected Attributes inherited from ParticleUniverse::IAlias
String	mAliasName
AliasType	mAliasType

Additional Inherited Members
Public Types inherited from ParticleUniverse::IAlias
enum	AliasType {   AT_UNDEFINED, AT_TECHNIQUE, AT_RENDERER, AT_EMITTER,   AT_AFFECTOR, AT_OBSERVER, AT_EXTERN, AT_HANDLER,   AT_BEHAVIOUR }
Public Attributes inherited from ParticleUniverse::ParticleRenderer
bool	autoRotate
Protected Member Functions inherited from ParticleUniverse::ParticleRenderer
void	_createSoftMaterial (void)
void	_stripNameFromSoftPrefix (String &name)

Detailed Description

The RibbonTrailRenderer class is responsible to render particles as a RibbonTrail.

Constructor & Destructor Documentation

ParticleUniverse::RibbonTrailRenderer::RibbonTrailRenderer

(

void

)

virtual ParticleUniverse::RibbonTrailRenderer::~RibbonTrailRenderer ( void  )

virtual

Member Function Documentation

void ParticleUniverse::RibbonTrailRenderer::_destroyAll

(

void

)

Deletes all ChildSceneNodes en Entities.

virtual SortMode ParticleUniverse::RibbonTrailRenderer::_getSortMode ( void  ) const

virtual

Gets the particles sort mode

Implements ParticleUniverse::ParticleRenderer.

virtual void ParticleUniverse::RibbonTrailRenderer::_notifyAttached ( Ogre::Node *  parent, bool  isTagPoint = false  )

virtual

Delegated to by ParticleTechnique::_notifyAttached

Implements ParticleUniverse::ParticleRenderer.

virtual void ParticleUniverse::RibbonTrailRenderer::_notifyCurrentCamera ( Camera *  cam )

virtual

Delegated to by ParticleTechnique::_notifyCurrentCamera

Implements ParticleUniverse::ParticleRenderer.

virtual void ParticleUniverse::RibbonTrailRenderer::_notifyDefaultDimensions ( Real  width, Real  height, Real  depth  )

virtual

The particle default size has changed

Implements ParticleUniverse::ParticleRenderer.

virtual void ParticleUniverse::RibbonTrailRenderer::_notifyParticleQuota ( size_t  quota )

virtual

The particle quota has changed

Implements ParticleUniverse::ParticleRenderer.

virtual void ParticleUniverse::RibbonTrailRenderer::_notifyParticleResized ( void  )

virtual

Callback when particles are resized

Implements ParticleUniverse::ParticleRenderer.

virtual void ParticleUniverse::RibbonTrailRenderer::_notifyParticleZRotated ( void  )

virtual

Callback when particles are rotated

Reimplemented from ParticleUniverse::ParticleRenderer.

virtual void ParticleUniverse::RibbonTrailRenderer::_notifyRescaled ( const Vector3 &  scale )

virtual

Notify that the Particle System is rescaled.

Reimplemented from ParticleUniverse::ParticleRenderer.

virtual void ParticleUniverse::RibbonTrailRenderer::_prepare ( ParticleTechnique *  technique )

virtual

Prepare the renderer before it can be used.

Implements ParticleUniverse::ParticleRenderer.

virtual void ParticleUniverse::RibbonTrailRenderer::_setMaterialName ( const String &  materialName )

virtual

Sets the material this renderer must use; called by ParticleTechnique.

Implements ParticleUniverse::ParticleRenderer.

virtual void ParticleUniverse::RibbonTrailRenderer::_unprepare ( ParticleTechnique *  technique )

virtual

Reverse the actions from the _prepare.

Reimplemented from ParticleUniverse::ParticleRenderer.

virtual void ParticleUniverse::RibbonTrailRenderer::_updateRenderQueue ( Ogre::RenderQueue *  queue, ParticlePool *  pool  )

virtual

Updates the renderqueue

Remarks

The subclass must update the render queue using whichever Renderable instance(s) it wishes.

Reimplemented from ParticleUniverse::ParticleRenderer.

virtual void ParticleUniverse::RibbonTrailRenderer::copyAttributesTo ( ParticleRenderer *  renderer )

virtual

Copy attributes to another renderer.

Reimplemented from ParticleUniverse::ParticleRenderer.

const ColourValue& ParticleUniverse::RibbonTrailRenderer::getColourChange

(

void

)

const

const ColourValue& ParticleUniverse::RibbonTrailRenderer::getInitialColour

(

void

)

const

size_t ParticleUniverse::RibbonTrailRenderer::getMaxChainElements

(

void

)

const

Real ParticleUniverse::RibbonTrailRenderer::getTrailLength

(

void

)

const

Real ParticleUniverse::RibbonTrailRenderer::getTrailWidth

(

void

)

const

bool ParticleUniverse::RibbonTrailRenderer::isRandomInitialColour

(

void

)

const

bool ParticleUniverse::RibbonTrailRenderer::isUseVertexColours

(

void

)

const

Getters and Setters

virtual void ParticleUniverse::RibbonTrailRenderer::particleEmitted ( ParticleTechnique *  particleTechnique, Particle *  particle  )

virtual

Implements ParticleUniverse::TechniqueListener.

virtual void ParticleUniverse::RibbonTrailRenderer::particleExpired ( ParticleTechnique *  particleTechnique, Particle *  particle  )

virtual

Implements ParticleUniverse::TechniqueListener.

void ParticleUniverse::RibbonTrailRenderer::setColourChange

(

const ColourValue &

colourChange

)

void ParticleUniverse::RibbonTrailRenderer::setInitialColour

(

const ColourValue &

initialColour

)

void ParticleUniverse::RibbonTrailRenderer::setMaxChainElements

(

size_t

maxChainElements

)

void ParticleUniverse::RibbonTrailRenderer::setRandomInitialColour

(

bool

randomInitialColour

)

virtual void ParticleUniverse::RibbonTrailRenderer::setRenderQueueGroup ( uint8  queueId )

virtual

Sets renderqueue group

Reimplemented from ParticleUniverse::ParticleRenderer.

void ParticleUniverse::RibbonTrailRenderer::setTrailLength

(

Real

trailLength

)

void ParticleUniverse::RibbonTrailRenderer::setTrailWidth

(

Real

trailWidth

)

void ParticleUniverse::RibbonTrailRenderer::setUseVertexColours

(

bool

useVertexColours

)

virtual void ParticleUniverse::RibbonTrailRenderer::setVisible ( bool  visible )

virtual

Enable the RibbonTrailDisable the RibbonTrailMake all objects visible or invisible.

Reimplemented from ParticleUniverse::ParticleRenderer.

Member Data Documentation

const ColourValue ParticleUniverse::RibbonTrailRenderer::DEFAULT_COLOUR_CHANGE

static

const ColourValue ParticleUniverse::RibbonTrailRenderer::DEFAULT_INITIAL_COLOUR

static

const Real ParticleUniverse::RibbonTrailRenderer::DEFAULT_LENGTH

static

const size_t ParticleUniverse::RibbonTrailRenderer::DEFAULT_MAX_ELEMENTS

static

const bool ParticleUniverse::RibbonTrailRenderer::DEFAULT_RANDOM_INITIAL_COLOUR

static

const bool ParticleUniverse::RibbonTrailRenderer::DEFAULT_USE_VERTEX_COLOURS

static

const Real ParticleUniverse::RibbonTrailRenderer::DEFAULT_WIDTH

static

vector<RibbonTrailRendererVisualData*> ParticleUniverse::RibbonTrailRenderer::mAllVisualData

protected

Ogre::SceneNode* ParticleUniverse::RibbonTrailRenderer::mChildNode

protected

ColourValue ParticleUniverse::RibbonTrailRenderer::mColourChange

protected

ColourValue ParticleUniverse::RibbonTrailRenderer::mInitialColour

protected

size_t ParticleUniverse::RibbonTrailRenderer::mMaxChainElements

protected

size_t ParticleUniverse::RibbonTrailRenderer::mQuota

protected

bool ParticleUniverse::RibbonTrailRenderer::mRandomInitialColour

protected

String ParticleUniverse::RibbonTrailRenderer::mRibbonTrailName

protected

bool ParticleUniverse::RibbonTrailRenderer::mSetLength

protected

bool ParticleUniverse::RibbonTrailRenderer::mSetWidth

protected

Ogre::RibbonTrail* ParticleUniverse::RibbonTrailRenderer::mTrail

protected

Real ParticleUniverse::RibbonTrailRenderer::mTrailLength

protected

Real ParticleUniverse::RibbonTrailRenderer::mTrailWidth

protected

bool ParticleUniverse::RibbonTrailRenderer::mUseVertexColours

protected

vector<RibbonTrailRendererVisualData*> ParticleUniverse::RibbonTrailRenderer::mVisualData

protected

---

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

• ParticleRenderers/ParticleUniverseRibbonTrailRenderer.h