OGRE-Next
2.3
Object-Oriented Graphics Rendering Engine
|
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 (IdType id, ObjectMemoryManager *objectMemoryManager, SceneManager *sceneManager) | |
~BillboardParticleRenderer () | |
virtual ParticleVisualData * | _createVisualData () |
Create a new ParticleVisualData instance for attachment to a particle. More... | |
virtual void | _destroyVisualData (ParticleVisualData *vis) |
Destroy a ParticleVisualData instance. More... | |
SortMode | _getSortMode () const override |
Gets the desired particles sort mode of this renderer. More... | |
void | _notifyAttached (Node *parent) override |
Delegated to by ParticleSystem::_notifyAttached. More... | |
void | _notifyCurrentCamera (const Camera *camera, const Camera *lodCamera) override |
Delegated to by ParticleSystem::_notifyCurrentCamera. More... | |
void | _notifyDefaultDimensions (Real width, Real height) override |
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) override |
Tells the renderer that the particle quota has changed. More... | |
void | _notifyParticleResized () override |
Optional callback notified when particles are resized individually. More... | |
void | _notifyParticleRotated () override |
Optional callback notified when particles are rotated. More... | |
void | _setDatablock (HlmsDatablock *datablock) override |
Sets the HLMS material this renderer must use; called by ParticleSystem. More... | |
void | _setMaterialName (const String &matName, const String &resourceGroup) override |
Sets the material this renderer must use; called by ParticleSystem. More... | |
void | _updateRenderQueue (RenderQueue *queue, Camera *camera, const Camera *lodCamera, list< Particle * >::type ¤tParticles, bool cullIndividually, RenderableArray &outRenderables) override |
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 () const |
Gets the point which acts as the origin point for all billboards in this set. More... | |
BillboardRotationType | getBillboardRotationType () const |
Gets billboard rotation type. More... | |
BillboardSet * | getBillboardSet () const |
Access BillboardSet in use. More... | |
BillboardType | getBillboardType () const |
Returns the billboard type in use. More... | |
const Vector3 & | getCommonDirection () const |
Gets the common direction for all billboards (BBT_ORIENTED_COMMON) More... | |
const Vector3 & | getCommonUpVector () const |
Gets the common up-vector for all billboards (BBT_PERPENDICULAR_SELF) More... | |
ParamDictionary * | getParamDictionary () |
Retrieves the parameter dictionary for this class. More... | |
const ParamDictionary * | getParamDictionary () const |
virtual String | getParameter (const String &name) const |
Generic parameter retrieval method. More... | |
const ParameterList & | getParameters () const |
Retrieves a list of parameters valid for this object. More... | |
const String & | getType () const override |
Gets the type of this renderer - must be implemented by subclasses. More... | |
bool | getUseAccurateFacing () 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 () const |
Returns whether point rendering is enabled. More... | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete (void *ptr, void *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz) |
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 *ptr) |
placement operator new More... | |
void * | operator new[] (size_t sz) |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info More... | |
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) override |
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) override |
Sets which render queue group this renderer should target with it's output. More... | |
void | setRenderQueueSubGroup (uint8 subGroup) override |
Sets the render queue sub group. 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... | |
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... | |
Specialisation of ParticleSystemRenderer to render particles using a BillboardSet.
Ogre::v1::BillboardParticleRenderer::BillboardParticleRenderer | ( | IdType | id, |
ObjectMemoryManager * | objectMemoryManager, | ||
SceneManager * | sceneManager | ||
) |
Ogre::v1::BillboardParticleRenderer::~BillboardParticleRenderer | ( | ) |
|
inlinevirtualinherited |
Create a new ParticleVisualData instance for attachment to a particle.
|
inlinevirtualinherited |
Destroy a ParticleVisualData instance.
|
overridevirtual |
Gets the desired particles sort mode of this renderer.
Implements Ogre::ParticleSystemRenderer.
|
overridevirtual |
Delegated to by ParticleSystem::_notifyAttached.
Implements Ogre::ParticleSystemRenderer.
|
overridevirtual |
Delegated to by ParticleSystem::_notifyCurrentCamera.
Implements Ogre::ParticleSystemRenderer.
|
overridevirtual |
Tells the renderer that the particle default size has changed.
Implements Ogre::ParticleSystemRenderer.
|
inlinevirtualinherited |
Optional callback notified when particles cleared.
|
inlinevirtualinherited |
Optional callback notified when particle emitted.
|
inlinevirtualinherited |
Optional callback notified when particle expired.
|
inlinevirtualinherited |
Optional callback notified when particles moved.
|
overridevirtual |
Tells the renderer that the particle quota has changed.
Implements Ogre::ParticleSystemRenderer.
|
overridevirtual |
Optional callback notified when particles are resized individually.
Reimplemented from Ogre::ParticleSystemRenderer.
|
overridevirtual |
Optional callback notified when particles are rotated.
Reimplemented from Ogre::ParticleSystemRenderer.
|
overridevirtual |
Sets the HLMS material this renderer must use; called by ParticleSystem.
Implements Ogre::ParticleSystemRenderer.
|
overridevirtual |
Sets the material this renderer must use; called by ParticleSystem.
Implements Ogre::ParticleSystemRenderer.
|
overridevirtual |
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. |
References Ogre::StringInterface::setParameter().
|
inline |
Gets the point which acts as the origin point for all billboards in this set.
References Ogre::v1::BillboardSet::getBillboardOrigin().
BillboardRotationType Ogre::v1::BillboardParticleRenderer::getBillboardRotationType | ( | ) | const |
Gets billboard rotation type.
|
inline |
Access BillboardSet in use.
BillboardType Ogre::v1::BillboardParticleRenderer::getBillboardType | ( | ) | const |
Returns the billboard type in use.
const Vector3& Ogre::v1::BillboardParticleRenderer::getCommonDirection | ( | ) | const |
Gets the common direction for all billboards (BBT_ORIENTED_COMMON)
const Vector3& Ogre::v1::BillboardParticleRenderer::getCommonUpVector | ( | ) | const |
Gets the common up-vector for all billboards (BBT_PERPENDICULAR_SELF)
|
inlineinherited |
Retrieves the parameter dictionary for this class.
|
inlineinherited |
|
inlinevirtualinherited |
Generic parameter retrieval method.
name | The name of the parameter to get |
References Ogre::ParamCommand::doGet().
|
inherited |
Retrieves a list of parameters valid for this object.
|
overridevirtual |
Gets the type of this renderer - must be implemented by subclasses.
Implements Ogre::ParticleSystemRenderer.
bool Ogre::v1::BillboardParticleRenderer::getUseAccurateFacing | ( | ) | 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::v1::BillboardParticleRenderer::isPointRenderingEnabled | ( | ) | const |
Returns whether point rendering is enabled.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
operator new, with debug line info
|
inlineinherited |
placement operator new
|
inlineinherited |
|
inlineinherited |
array operator new, with debug line info
|
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. |
References Ogre::v1::BillboardSet::setBillboardOrigin().
void Ogre::v1::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::v1::BillboardParticleRenderer::setBillboardType | ( | BillboardType | bbt | ) |
Sets the type of billboard to render.
bbt | The type of billboard to render |
void Ogre::v1::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::v1::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. |
|
overridevirtual |
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::v1::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 |
|
overridevirtual |
Sets which render queue group this renderer should target with it's output.
Implements Ogre::ParticleSystemRenderer.
|
overridevirtual |
Sets the render queue sub group.
subGroup | The sub group. This value can't exceed OGRE_MAKE_MASK( SubRqIdBits ) @See RenderQueue |
Implements Ogre::ParticleSystemRenderer.
void Ogre::v1::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. |