#include <OgreBillboardParticleRenderer.h>
Public Member Functions | ||||
BillboardParticleRenderer () | ||||
~BillboardParticleRenderer () | ||||
void | setBillboardType (BillboardType bbt) | |||
Sets the type of billboard to render. | ||||
BillboardType | getBillboardType (void) const | |||
Returns the billboard type in use. | ||||
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.
| ||||
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. | ||||
void | setBillboardOrigin (BillboardOrigin origin) | |||
Sets the point which acts as the origin point for all billboards in this set. | ||||
BillboardOrigin | getBillboardOrigin (void) const | |||
Gets the point which acts as the origin point for all billboards in this set. | ||||
void | setBillboardRotationType (BillboardRotationType rotationType) | |||
Sets billboard rotation type. | ||||
BillboardRotationType | getBillboardRotationType (void) const | |||
Sets billboard rotation type. | ||||
void | setCommonDirection (const Vector3 &vec) | |||
Use this to specify the common direction given to billboards of type BBT_ORIENTED_COMMON. | ||||
const Vector3 & | getCommonDirection (void) const | |||
Gets the common direction for all billboards (BBT_ORIENTED_COMMON). | ||||
void | setCommonUpVector (const Vector3 &vec) | |||
Use this to specify the common up-vector given to billboards of type BBT_PERPENDICULAR_SELF. | ||||
const Vector3 & | getCommonUpVector (void) const | |||
Gets the common up-vector for all billboards (BBT_PERPENDICULAR_SELF). | ||||
void | setPointRenderingEnabled (bool enabled) | |||
Set whether or not the BillboardSet will use point rendering rather than manually generated quads.
| ||||
bool | isPointRenderingEnabled (void) const | |||
Returns whether point rendering is enabled. | ||||
const String & | getType (void) const | |||
Gets the type of this renderer - must be implemented by subclasses. | ||||
void | _updateRenderQueue (RenderQueue *queue, std::list< Particle * > ¤tParticles, bool cullIndividually) | |||
Delegated to by ParticleSystem::_updateRenderQueue.
| ||||
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.
| ||||
void | _setMaterial (MaterialPtr &mat) | |||
Sets the material this renderer must use; called by ParticleSystem. | ||||
void | _notifyCurrentCamera (Camera *cam) | |||
Delegated to by ParticleSystem::_notifyCurrentCamera. | ||||
void | _notifyParticleRotated (void) | |||
Optional callback notified when particles are rotated. | ||||
void | _notifyParticleResized (void) | |||
Optional callback notified when particles are resized individually. | ||||
void | _notifyParticleQuota (size_t quota) | |||
Tells the renderer that the particle quota has changed. | ||||
void | _notifyAttached (Node *parent, bool isTagPoint=false) | |||
Delegated to by ParticleSystem::_notifyAttached. | ||||
void | _notifyDefaultDimensions (Real width, Real height) | |||
Tells the renderer that the particle default size has changed. | ||||
void | setRenderQueueGroup (uint8 queueID) | |||
Sets which render queue group this renderer should target with it's output. | ||||
void | setKeepParticlesInLocalSpace (bool keepLocal) | |||
Setting carried over from ParticleSystem. | ||||
SortMode | _getSortMode (void) const | |||
Gets the desired particles sort mode of this renderer. | ||||
BillboardSet * | getBillboardSet (void) const | |||
Access BillboardSet in use. | ||||
virtual void | _notifyParticleEmitted (Particle *particle) | |||
Optional callback notified when particle emitted. | ||||
virtual void | _notifyParticleExpired (Particle *particle) | |||
Optional callback notified when particle expired. | ||||
virtual void | _notifyParticleMoved (std::list< Particle * > ¤tParticles) | |||
Optional callback notified when particles moved. | ||||
virtual void | _notifyParticleCleared (std::list< Particle * > ¤tParticles) | |||
Optional callback notified when particles cleared. | ||||
virtual ParticleVisualData * | _createVisualData (void) | |||
Create a new ParticleVisualData instance for attachment to a particle. | ||||
virtual void | _destroyVisualData (ParticleVisualData *vis) | |||
Destroy a ParticleVisualData instance. | ||||
ParamDictionary * | getParamDictionary (void) | |||
Retrieves the parameter dictionary for this class. | ||||
const ParamDictionary * | getParamDictionary (void) const | |||
const ParameterList & | getParameters (void) const | |||
Retrieves a list of parameters valid for this object. | ||||
virtual bool | setParameter (const String &name, const String &value) | |||
Generic parameter setting method. | ||||
virtual void | setParameterList (const NameValuePairList ¶mList) | |||
Generic multiple parameter setting method. | ||||
virtual String | getParameter (const String &name) const | |||
Generic parameter retrieval method. | ||||
virtual void | copyParametersTo (StringInterface *dest) const | |||
Method for copying this object's parameters to another object. | ||||
void * | operator new (size_t sz, const char *file, int line, const char *func) | |||
operator new, with debug line info | ||||
void * | operator new (size_t sz) | |||
void * | operator new (size_t sz, void *ptr) | |||
placement operator new | ||||
void * | operator new[] (size_t sz, const char *file, int line, const char *func) | |||
array operator new, with debug line info | ||||
void * | operator new[] (size_t sz) | |||
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 *) | |||
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. | ||||
Protected Member Functions | ||||
bool | createParamDictionary (const String &className) | |||
Internal method for creating a parameter dictionary for the class, if it does not already exist. | ||||
Protected Attributes | ||||
BillboardSet * | mBillboardSet | |||
The billboard set that's doing the rendering. | ||||
Static Protected Attributes | ||||
static CmdBillboardType | msBillboardTypeCmd | |||
static CmdBillboardOrigin | msBillboardOriginCmd | |||
static CmdBillboardRotationType | msBillboardRotationTypeCmd | |||
static CmdCommonDirection | msCommonDirectionCmd | |||
static CmdCommonUpVector | msCommonUpVectorCmd | |||
static CmdPointRendering | msPointRenderingCmd | |||
static CmdAccurateFacing | msAccurateFacingCmd | |||
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... |
Definition at line 45 of file OgreBillboardParticleRenderer.h.
Ogre::BillboardParticleRenderer::BillboardParticleRenderer | ( | ) |
Ogre::BillboardParticleRenderer::~BillboardParticleRenderer | ( | ) |
void Ogre::BillboardParticleRenderer::setBillboardType | ( | BillboardType | bbt | ) |
Sets the type of billboard to render.
bbt | The type of billboard to render |
BillboardType Ogre::BillboardParticleRenderer::getBillboardType | ( | void | ) | const |
Returns the billboard type in use.
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. |
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.
void Ogre::BillboardParticleRenderer::setBillboardOrigin | ( | BillboardOrigin | origin | ) |
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 135 of file OgreBillboardParticleRenderer.h.
BillboardOrigin Ogre::BillboardParticleRenderer::getBillboardOrigin | ( | void | ) | const |
Gets the point which acts as the origin point for all billboards in this set.
Definition at line 141 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. |
BillboardRotationType Ogre::BillboardParticleRenderer::getBillboardRotationType | ( | void | ) | const |
Sets billboard rotation type.
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. |
const Vector3& Ogre::BillboardParticleRenderer::getCommonDirection | ( | void | ) | const |
Gets the common direction for all billboards (BBT_ORIENTED_COMMON).
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. |
const Vector3& Ogre::BillboardParticleRenderer::getCommonUpVector | ( | void | ) | const |
Gets the common up-vector for all billboards (BBT_PERPENDICULAR_SELF).
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 |
bool Ogre::BillboardParticleRenderer::isPointRenderingEnabled | ( | void | ) | const |
Returns whether point rendering is enabled.
const String& Ogre::BillboardParticleRenderer::getType | ( | void | ) | const [virtual] |
Gets the type of this renderer - must be implemented by subclasses.
Implements Ogre::ParticleSystemRenderer.
void Ogre::BillboardParticleRenderer::_updateRenderQueue | ( | RenderQueue * | queue, | |
std::list< Particle * > & | currentParticles, | |||
bool | cullIndividually | |||
) | [virtual] |
Delegated to by ParticleSystem::_updateRenderQueue.
Implements Ogre::ParticleSystemRenderer.
void Ogre::BillboardParticleRenderer::visitRenderables | ( | Renderable::Visitor * | visitor, | |
bool | debugRenderables = 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.
void Ogre::BillboardParticleRenderer::_setMaterial | ( | MaterialPtr & | mat | ) | [virtual] |
Sets the material this renderer must use; called by ParticleSystem.
Implements Ogre::ParticleSystemRenderer.
void Ogre::BillboardParticleRenderer::_notifyCurrentCamera | ( | Camera * | cam | ) | [virtual] |
void Ogre::BillboardParticleRenderer::_notifyParticleRotated | ( | void | ) | [virtual] |
Optional callback notified when particles are rotated.
Reimplemented from Ogre::ParticleSystemRenderer.
void Ogre::BillboardParticleRenderer::_notifyParticleResized | ( | void | ) | [virtual] |
Optional callback notified when particles are resized individually.
Reimplemented from Ogre::ParticleSystemRenderer.
void Ogre::BillboardParticleRenderer::_notifyParticleQuota | ( | size_t | quota | ) | [virtual] |
void Ogre::BillboardParticleRenderer::_notifyAttached | ( | Node * | parent, | |
bool | isTagPoint = false | |||
) | [virtual] |
void Ogre::BillboardParticleRenderer::_notifyDefaultDimensions | ( | Real | width, | |
Real | height | |||
) | [virtual] |
Tells the renderer that the particle default size has changed.
Implements Ogre::ParticleSystemRenderer.
void Ogre::BillboardParticleRenderer::setRenderQueueGroup | ( | uint8 | queueID | ) | [virtual] |
Sets which render queue group this renderer should target with it's output.
Implements Ogre::ParticleSystemRenderer.
void Ogre::BillboardParticleRenderer::setKeepParticlesInLocalSpace | ( | bool | keepLocal | ) | [virtual] |
SortMode Ogre::BillboardParticleRenderer::_getSortMode | ( | void | ) | const [virtual] |
BillboardSet* Ogre::BillboardParticleRenderer::getBillboardSet | ( | void | ) | const |
virtual void Ogre::ParticleSystemRenderer::_notifyParticleEmitted | ( | Particle * | particle | ) | [virtual, inherited] |
Optional callback notified when particle emitted.
Definition at line 78 of file OgreParticleSystemRenderer.h.
virtual void Ogre::ParticleSystemRenderer::_notifyParticleExpired | ( | Particle * | particle | ) | [virtual, inherited] |
Optional callback notified when particle expired.
Definition at line 80 of file OgreParticleSystemRenderer.h.
virtual void Ogre::ParticleSystemRenderer::_notifyParticleMoved | ( | std::list< Particle * > & | currentParticles | ) | [virtual, inherited] |
Optional callback notified when particles moved.
Definition at line 82 of file OgreParticleSystemRenderer.h.
virtual void Ogre::ParticleSystemRenderer::_notifyParticleCleared | ( | std::list< Particle * > & | currentParticles | ) | [virtual, inherited] |
Optional callback notified when particles cleared.
Definition at line 84 of file OgreParticleSystemRenderer.h.
virtual ParticleVisualData* Ogre::ParticleSystemRenderer::_createVisualData | ( | void | ) | [virtual, inherited] |
Create a new ParticleVisualData instance for attachment to a particle.
Definition at line 92 of file OgreParticleSystemRenderer.h.
virtual void Ogre::ParticleSystemRenderer::_destroyVisualData | ( | ParticleVisualData * | vis | ) | [virtual, inherited] |
Destroy a ParticleVisualData instance.
Definition at line 100 of file OgreParticleSystemRenderer.h.
bool Ogre::StringInterface::createParamDictionary | ( | const String & | className | ) | [protected, inherited] |
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 179 of file OgreStringInterface.h.
References OGRE_LOCK_MUTEX.
ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void | ) | [inherited] |
Retrieves the parameter dictionary for this class.
Definition at line 212 of file OgreStringInterface.h.
const ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void | ) | const [inherited] |
Definition at line 217 of file OgreStringInterface.h.
const ParameterList& Ogre::StringInterface::getParameters | ( | void | ) | const [inherited] |
Retrieves a list of parameters valid for this object.
virtual bool Ogre::StringInterface::setParameter | ( | const String & | name, | |
const String & | value | |||
) | [virtual, inherited] |
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().
virtual void Ogre::StringInterface::setParameterList | ( | const NameValuePairList & | paramList | ) | [virtual, inherited] |
Generic multiple parameter setting method.
paramList | Name/value pair list |
virtual String Ogre::StringInterface::getParameter | ( | const String & | name | ) | const [virtual, inherited] |
Generic parameter retrieval method.
name | The name of the parameter to get |
Definition at line 265 of file OgreStringInterface.h.
References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().
virtual void Ogre::StringInterface::copyParametersTo | ( | StringInterface * | dest | ) | const [virtual, inherited] |
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 296 of file OgreStringInterface.h.
References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().
static void Ogre::StringInterface::cleanupDictionary | ( | ) | [static, inherited] |
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.
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz, | |
const char * | file, | |||
int | line, | |||
const char * | func | |||
) | [inherited] |
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) | [inherited] |
Definition at line 67 of file OgreMemoryAllocatedObject.h.
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz, | |
void * | ptr | |||
) | [inherited] |
void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz, | |
const char * | file, | |||
int | line, | |||
const char * | func | |||
) | [inherited] |
void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) | [inherited] |
Definition at line 84 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) | [inherited] |
Definition at line 89 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, | |
void * | ||||
) | [inherited] |
Definition at line 95 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, | |
const char * | , | |||
int | , | |||
const char * | ||||
) | [inherited] |
Definition at line 101 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) | [inherited] |
Definition at line 106 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr, | |
const char * | , | |||
int | , | |||
const char * | ||||
) | [inherited] |
Definition at line 112 of file OgreMemoryAllocatedObject.h.
The billboard set that's doing the rendering.
Definition at line 49 of file OgreBillboardParticleRenderer.h.
CmdBillboardType Ogre::BillboardParticleRenderer::msBillboardTypeCmd [static, protected] |
Definition at line 227 of file OgreBillboardParticleRenderer.h.
CmdBillboardOrigin Ogre::BillboardParticleRenderer::msBillboardOriginCmd [static, protected] |
Definition at line 228 of file OgreBillboardParticleRenderer.h.
CmdBillboardRotationType Ogre::BillboardParticleRenderer::msBillboardRotationTypeCmd [static, protected] |
Definition at line 229 of file OgreBillboardParticleRenderer.h.
CmdCommonDirection Ogre::BillboardParticleRenderer::msCommonDirectionCmd [static, protected] |
Definition at line 230 of file OgreBillboardParticleRenderer.h.
CmdCommonUpVector Ogre::BillboardParticleRenderer::msCommonUpVectorCmd [static, protected] |
Definition at line 231 of file OgreBillboardParticleRenderer.h.
CmdPointRendering Ogre::BillboardParticleRenderer::msPointRenderingCmd [static, protected] |
Definition at line 232 of file OgreBillboardParticleRenderer.h.
CmdAccurateFacing Ogre::BillboardParticleRenderer::msAccurateFacingCmd [static, protected] |
Definition at line 233 of file OgreBillboardParticleRenderer.h.
Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Sep 27 22:02:53 2009