Particle Universe  1.2
ParticleUniverse::SphereRenderer Class Reference

#include <ParticleUniverseSphereRenderer.h>

Inheritance diagram for ParticleUniverse::SphereRenderer:

Public Member Functions

 SphereRenderer (void)
 
virtual ~SphereRenderer (void)
 
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)
 
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)
 
SphereSetgetSphereSet (void) const
 
virtual void setVisible (bool visible)
 
- Public Member Functions inherited from ParticleUniverse::ParticleRenderer
 ParticleRenderer (void)
 
virtual ~ParticleRenderer (void)
 
const StringgetRendererType (void) const
 
void setRendererType (String rendererType)
 
ParticleTechniquegetParentTechnique (void) const
 
void setParentTechnique (ParticleTechnique *parentTechnique)
 
bool isRendererInitialised (void) const
 
void setRendererInitialised (bool rendererInitialised)
 
virtual void _notifyStart (void)
 
virtual void _notifyStop (void)
 
virtual void _notifyRescaled (const Vector3 &scale)
 
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 StringgetAliasName (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)
 

Protected Attributes

SphereSetmSphereSet
 
- Protected Attributes inherited from ParticleUniverse::ParticleRenderer
ParticleTechniquemParentTechnique
 
Ogre::BillboardSetmBillboardSet
 
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
 
- 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 Member Functions inherited from ParticleUniverse::ParticleRenderer
void _createSoftMaterial (void)
 
void _stripNameFromSoftPrefix (String &name)
 

Detailed Description

The SphereRenderer class is responsible to render particles as a sphere.

Constructor & Destructor Documentation

ParticleUniverse::SphereRenderer::SphereRenderer ( void  )
virtual ParticleUniverse::SphereRenderer::~SphereRenderer ( void  )
virtual

Member Function Documentation

virtual SortMode ParticleUniverse::SphereRenderer::_getSortMode ( void  ) const
inlinevirtual

Gets the particles sort mode

Implements ParticleUniverse::ParticleRenderer.

virtual void ParticleUniverse::SphereRenderer::_notifyAttached ( Ogre::Node parent,
bool  isTagPoint = false 
)
virtual
virtual void ParticleUniverse::SphereRenderer::_notifyCurrentCamera ( Camera cam)
virtual
virtual void ParticleUniverse::SphereRenderer::_notifyDefaultDimensions ( Real  width,
Real  height,
Real  depth 
)
virtual

The particle default size has changed

Implements ParticleUniverse::ParticleRenderer.

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

The particle quota has changed

Implements ParticleUniverse::ParticleRenderer.

virtual void ParticleUniverse::SphereRenderer::_notifyParticleResized ( void  )
virtual

Callback when particles are resized

Implements ParticleUniverse::ParticleRenderer.

virtual void ParticleUniverse::SphereRenderer::_notifyParticleZRotated ( void  )
virtual

Callback when particles are rotated

Reimplemented from ParticleUniverse::ParticleRenderer.

virtual void ParticleUniverse::SphereRenderer::_prepare ( ParticleTechnique technique)
virtual

Prepare the renderer before it can be used.

Implements ParticleUniverse::ParticleRenderer.

void ParticleUniverse::SphereRenderer::_setMaterialName ( const String materialName)
virtual

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

Implements ParticleUniverse::ParticleRenderer.

virtual void ParticleUniverse::SphereRenderer::_unprepare ( ParticleTechnique technique)
virtual

Reverse the actions from the _prepare.

Reimplemented from ParticleUniverse::ParticleRenderer.

virtual void ParticleUniverse::SphereRenderer::_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::SphereRenderer::copyAttributesTo ( ParticleRenderer renderer)
virtual

Copy attributes to another renderer.

Reimplemented from ParticleUniverse::ParticleRenderer.

SphereSet* ParticleUniverse::SphereRenderer::getSphereSet ( void  ) const
inline

Access SphereSet in use

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

Sets renderqueue group

Reimplemented from ParticleUniverse::ParticleRenderer.

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

To make currently displayed objects visible or not.

Reimplemented from ParticleUniverse::ParticleRenderer.

Member Data Documentation

SphereSet* ParticleUniverse::SphereRenderer::mSphereSet
protected

The sphere set that's doing the rendering


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