Specialisation of ParticleSystemRenderer to render particles using a BillboardSet. More...
#include <OgreBillboardParticleRenderer.h>
Classes | |
class | CmdAccurateFacing |
Command object for accurate facing(see ParamCommand). More... | |
class | CmdBillboardOrigin |
Command object for billboard origin (see ParamCommand). More... | |
class | CmdBillboardRotationType |
Command object for billboard rotation type (see ParamCommand). More... | |
class | CmdBillboardType |
Command object for billboard type (see ParamCommand). More... | |
class | CmdCommonDirection |
Command object for common direction (see ParamCommand). More... | |
class | CmdCommonUpVector |
Command object for common up-vector (see ParamCommand). More... | |
class | CmdPointRendering |
Command object for point rendering (see ParamCommand). More... | |
Public Member Functions | |
BillboardParticleRenderer () | |
~BillboardParticleRenderer () | |
virtual ParticleVisualData * | _createVisualData (void) |
Create a new ParticleVisualData instance for attachment to a particle. More... | |
virtual void | _destroyVisualData (ParticleVisualData *vis) |
Destroy a ParticleVisualData instance. More... | |
SortMode | _getSortMode (void) const |
Gets the desired particles sort mode of this renderer. More... | |
void | _notifyAttached (Node *parent, bool isTagPoint=false) |
Delegated to by ParticleSystem::_notifyAttached. More... | |
void | _notifyCurrentCamera (Camera *cam) |
Delegated to by ParticleSystem::_notifyCurrentCamera. More... | |
void | _notifyDefaultDimensions (Real width, Real height) |
Tells the renderer that the particle default size has changed. More... | |
virtual void | _notifyParticleCleared (list< Particle * >::type ¤tParticles) |
Optional callback notified when particles cleared. More... | |
virtual void | _notifyParticleEmitted (Particle *particle) |
Optional callback notified when particle emitted. More... | |
virtual void | _notifyParticleExpired (Particle *particle) |
Optional callback notified when particle expired. More... | |
virtual void | _notifyParticleMoved (list< Particle * >::type ¤tParticles) |
Optional callback notified when particles moved. More... | |
void | _notifyParticleQuota (size_t quota) |
Tells the renderer that the particle quota has changed. More... | |
void | _notifyParticleResized (void) |
Optional callback notified when particles are resized individually. More... | |
void | _notifyParticleRotated (void) |
Optional callback notified when particles are rotated. More... | |
void | _setMaterial (MaterialPtr &mat) |
Sets the material this renderer must use; called by ParticleSystem. More... | |
void | _updateRenderQueue (RenderQueue *queue, list< Particle * >::type ¤tParticles, bool cullIndividually) |
Delegated to by ParticleSystem::_updateRenderQueue. More... | |
virtual void | copyParametersTo (StringInterface *dest) const |
Method for copying this object's parameters to another object. More... | |
BillboardOrigin | getBillboardOrigin (void) const |
Gets the point which acts as the origin point for all billboards in this set. More... | |
BillboardRotationType | getBillboardRotationType (void) const |
Gets billboard rotation type. More... | |
BillboardSet * | getBillboardSet (void) const |
Access BillboardSet in use. More... | |
BillboardType | getBillboardType (void) const |
Returns the billboard type in use. More... | |
const Vector3 & | getCommonDirection (void) const |
Gets the common direction for all billboards (BBT_ORIENTED_COMMON) More... | |
const Vector3 & | getCommonUpVector (void) const |
Gets the common up-vector for all billboards (BBT_PERPENDICULAR_SELF) More... | |
ParamDictionary * | getParamDictionary (void) |
Retrieves the parameter dictionary for this class. More... | |
const ParamDictionary * | getParamDictionary (void) const |
virtual String | getParameter (const String &name) const |
Generic parameter retrieval method. More... | |
const ParameterList & | getParameters (void) const |
Retrieves a list of parameters valid for this object. More... | |
const String & | getType (void) const |
Gets the type of this renderer - must be implemented by subclasses. More... | |
bool | getUseAccurateFacing (void) const |
Gets whether or not billboards use an 'accurate' facing model based on the vector from each billboard to the camera, rather than an optimised version using just the camera direction. More... | |
bool | isPointRenderingEnabled (void) const |
Returns whether point rendering is enabled. More... | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, void *) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz, const char *file, int line, const char *func) |
operator new, with debug line info More... | |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *ptr) |
placement operator new More... | |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info More... | |
void * | operator new[] (size_t sz) |
void | setBillboardOrigin (BillboardOrigin origin) |
Sets the point which acts as the origin point for all billboards in this set. More... | |
void | setBillboardRotationType (BillboardRotationType rotationType) |
Sets billboard rotation type. More... | |
void | setBillboardType (BillboardType bbt) |
Sets the type of billboard to render. More... | |
void | setCommonDirection (const Vector3 &vec) |
Use this to specify the common direction given to billboards of type BBT_ORIENTED_COMMON. More... | |
void | setCommonUpVector (const Vector3 &vec) |
Use this to specify the common up-vector given to billboards of type BBT_PERPENDICULAR_SELF. More... | |
void | setKeepParticlesInLocalSpace (bool keepLocal) |
Setting carried over from ParticleSystem. More... | |
virtual bool | setParameter (const String &name, const String &value) |
Generic parameter setting method. More... | |
virtual void | setParameterList (const NameValuePairList ¶mList) |
Generic multiple parameter setting method. More... | |
void | setPointRenderingEnabled (bool enabled) |
Set whether or not the BillboardSet will use point rendering rather than manually generated quads. More... | |
void | setRenderQueueGroup (uint8 queueID) |
Sets which render queue group this renderer should target with it's output. More... | |
void | setRenderQueueGroupAndPriority (uint8 queueID, ushort priority) |
Sets the render queue group and group priority this entity will be rendered through. More... | |
void | setUseAccurateFacing (bool acc) |
Sets whether or not billboards should use an 'accurate' facing model based on the vector from each billboard to the camera, rather than an optimised version using just the camera direction. More... | |
void | visitRenderables (Renderable::Visitor *visitor, bool debugRenderables=false) |
Required method to allow the renderer to communicate the Renderables it will be using to render the system to a visitor. More... | |
Static Public Member Functions | |
static void | cleanupDictionary () |
Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g. More... | |
Protected Member Functions | |
bool | createParamDictionary (const String &className) |
Internal method for creating a parameter dictionary for the class, if it does not already exist. More... | |
Protected Attributes | |
BillboardSet * | mBillboardSet |
The billboard set that's doing the rendering. More... | |
Static Protected Attributes | |
static CmdAccurateFacing | msAccurateFacingCmd |
static CmdBillboardOrigin | msBillboardOriginCmd |
static CmdBillboardRotationType | msBillboardRotationTypeCmd |
static CmdBillboardType | msBillboardTypeCmd |
static CmdCommonDirection | msCommonDirectionCmd |
static CmdCommonUpVector | msCommonUpVectorCmd |
static CmdPointRendering | msPointRenderingCmd |
Specialisation of ParticleSystemRenderer to render particles using a BillboardSet.
Definition at line 52 of file OgreBillboardParticleRenderer.h.
Ogre::BillboardParticleRenderer::BillboardParticleRenderer | ( | ) |
Ogre::BillboardParticleRenderer::~BillboardParticleRenderer | ( | ) |
|
inlinevirtualinherited |
Create a new ParticleVisualData instance for attachment to a particle.
Definition at line 97 of file OgreParticleSystemRenderer.h.
|
inlinevirtualinherited |
Destroy a ParticleVisualData instance.
Definition at line 105 of file OgreParticleSystemRenderer.h.
|
virtual |
Gets the desired particles sort mode of this renderer.
Implements Ogre::ParticleSystemRenderer.
|
virtual |
Delegated to by ParticleSystem::_notifyAttached.
Implements Ogre::ParticleSystemRenderer.
|
virtual |
Delegated to by ParticleSystem::_notifyCurrentCamera.
Implements Ogre::ParticleSystemRenderer.
Tells the renderer that the particle default size has changed.
Implements Ogre::ParticleSystemRenderer.
|
inlinevirtualinherited |
Optional callback notified when particles cleared.
Definition at line 89 of file OgreParticleSystemRenderer.h.
|
inlinevirtualinherited |
Optional callback notified when particle emitted.
Definition at line 83 of file OgreParticleSystemRenderer.h.
|
inlinevirtualinherited |
Optional callback notified when particle expired.
Definition at line 85 of file OgreParticleSystemRenderer.h.
|
inlinevirtualinherited |
Optional callback notified when particles moved.
Definition at line 87 of file OgreParticleSystemRenderer.h.
|
virtual |
Tells the renderer that the particle quota has changed.
Implements Ogre::ParticleSystemRenderer.
|
virtual |
Optional callback notified when particles are resized individually.
Reimplemented from Ogre::ParticleSystemRenderer.
|
virtual |
Optional callback notified when particles are rotated.
Reimplemented from Ogre::ParticleSystemRenderer.
|
virtual |
Sets the material this renderer must use; called by ParticleSystem.
Implements Ogre::ParticleSystemRenderer.
|
virtual |
Delegated to by ParticleSystem::_updateRenderQueue.
Implements Ogre::ParticleSystemRenderer.
|
staticinherited |
Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g.
MaterialManager) initializes.
|
inlinevirtualinherited |
Method for copying this object's parameters to another object.
dest | Pointer to object to have it's parameters set the same as this object. |
Definition at line 303 of file OgreStringInterface.h.
References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().
|
inlineprotectedinherited |
Internal method for creating a parameter dictionary for the class, if it does not already exist.
className | the name of the class using the dictionary |
Definition at line 186 of file OgreStringInterface.h.
References OGRE_LOCK_MUTEX.
|
inline |
Gets the point which acts as the origin point for all billboards in this set.
Definition at line 148 of file OgreBillboardParticleRenderer.h.
BillboardRotationType Ogre::BillboardParticleRenderer::getBillboardRotationType | ( | void | ) | const |
Gets billboard rotation type.
|
inline |
Access BillboardSet in use.
Definition at line 233 of file OgreBillboardParticleRenderer.h.
BillboardType Ogre::BillboardParticleRenderer::getBillboardType | ( | void | ) | const |
Returns the billboard type in use.
const Vector3& Ogre::BillboardParticleRenderer::getCommonDirection | ( | void | ) | const |
Gets the common direction for all billboards (BBT_ORIENTED_COMMON)
const Vector3& Ogre::BillboardParticleRenderer::getCommonUpVector | ( | void | ) | const |
Gets the common up-vector for all billboards (BBT_PERPENDICULAR_SELF)
|
inlineinherited |
Retrieves the parameter dictionary for this class.
Definition at line 219 of file OgreStringInterface.h.
|
inlineinherited |
Definition at line 224 of file OgreStringInterface.h.
|
inlinevirtualinherited |
Generic parameter retrieval method.
name | The name of the parameter to get |
Definition at line 272 of file OgreStringInterface.h.
References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().
|
inherited |
Retrieves a list of parameters valid for this object.
|
virtual |
Gets the type of this renderer - must be implemented by subclasses.
Implements Ogre::ParticleSystemRenderer.
bool Ogre::BillboardParticleRenderer::getUseAccurateFacing | ( | void | ) | const |
Gets whether or not billboards use an 'accurate' facing model based on the vector from each billboard to the camera, rather than an optimised version using just the camera direction.
bool Ogre::BillboardParticleRenderer::isPointRenderingEnabled | ( | void | ) | const |
Returns whether point rendering is enabled.
|
inlineinherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
inline |
Sets the point which acts as the origin point for all billboards in this set.
origin | A member of the BillboardOrigin enum specifying the origin for all the billboards in this set. |
Definition at line 142 of file OgreBillboardParticleRenderer.h.
void Ogre::BillboardParticleRenderer::setBillboardRotationType | ( | BillboardRotationType | rotationType | ) |
Sets billboard rotation type.
rotationType | A member of the BillboardRotationType enum specifying the rotation type for all the billboards in this set. |
void Ogre::BillboardParticleRenderer::setBillboardType | ( | BillboardType | bbt | ) |
Sets the type of billboard to render.
bbt | The type of billboard to render |
void Ogre::BillboardParticleRenderer::setCommonDirection | ( | const Vector3 & | vec | ) |
Use this to specify the common direction given to billboards of type BBT_ORIENTED_COMMON.
vec | The direction for all billboards. |
void Ogre::BillboardParticleRenderer::setCommonUpVector | ( | const Vector3 & | vec | ) |
Use this to specify the common up-vector given to billboards of type BBT_PERPENDICULAR_SELF.
vec | The up-vector for all billboards. |
|
virtual |
Setting carried over from ParticleSystem.
Implements Ogre::ParticleSystemRenderer.
|
virtualinherited |
Generic parameter setting method.
name | The name of the parameter to set |
value | String value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information. |
Referenced by Ogre::StringInterface::copyParametersTo().
|
virtualinherited |
Generic multiple parameter setting method.
paramList | Name/value pair list |
void Ogre::BillboardParticleRenderer::setPointRenderingEnabled | ( | bool | enabled | ) |
Set whether or not the BillboardSet will use point rendering rather than manually generated quads.
enabled | True to enable point rendering, false otherwise |
|
virtual |
Sets which render queue group this renderer should target with it's output.
Implements Ogre::ParticleSystemRenderer.
|
virtual |
Sets the render queue group and group priority this entity will be rendered through.
queueID | Enumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here. |
priority | The priority within a group to use. |
Implements Ogre::ParticleSystemRenderer.
void Ogre::BillboardParticleRenderer::setUseAccurateFacing | ( | bool | acc | ) |
Sets whether or not billboards should use an 'accurate' facing model based on the vector from each billboard to the camera, rather than an optimised version using just the camera direction.
acc | True to use the slower but more accurate model. Default is false. |
|
virtual |
Required method to allow the renderer to communicate the Renderables it will be using to render the system to a visitor.
Implements Ogre::ParticleSystemRenderer.
|
protected |
The billboard set that's doing the rendering.
Definition at line 56 of file OgreBillboardParticleRenderer.h.
|
staticprotected |
Definition at line 242 of file OgreBillboardParticleRenderer.h.
|
staticprotected |
Definition at line 237 of file OgreBillboardParticleRenderer.h.
|
staticprotected |
Definition at line 238 of file OgreBillboardParticleRenderer.h.
|
staticprotected |
Definition at line 236 of file OgreBillboardParticleRenderer.h.
|
staticprotected |
Definition at line 239 of file OgreBillboardParticleRenderer.h.
|
staticprotected |
Definition at line 240 of file OgreBillboardParticleRenderer.h.
|
staticprotected |
Definition at line 241 of file OgreBillboardParticleRenderer.h.