OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::ParticleSystem Class Reference

Class defining particle system based special effects. More...

#include <OgreParticleSystem.h>

+ Inheritance diagram for Ogre::ParticleSystem:
+ Collaboration diagram for Ogre::ParticleSystem:

Classes

class  CmdCull
 Command object for cull_each (see ParamCommand). More...
 
class  CmdEmittedEmitterQuota
 Command object for emittedEmitterQuota (see ParamCommand). More...
 
class  CmdHeight
 Command object for particle_height (see ParamCommand). More...
 
class  CmdIterationInterval
 Command object for iteration interval(see ParamCommand). More...
 
class  CmdLocalSpace
 Command object for local space (see ParamCommand). More...
 
class  CmdMaterial
 Command object for material (see ParamCommand). More...
 
class  CmdNonvisibleTimeout
 Command object for nonvisible timeout (see ParamCommand). More...
 
class  CmdQuota
 Command object for quota (see ParamCommand). More...
 
class  CmdRenderer
 Command object for renderer (see ParamCommand). More...
 
class  CmdSorted
 Command object for sorting (see ParamCommand). More...
 
class  CmdWidth
 Command object for particle_width (see ParamCommand). More...
 
struct  SortByDirectionFunctor
 Sort by direction functor. More...
 
struct  SortByDistanceFunctor
 Sort by distance functor. More...
 

Public Types

typedef FastArray
< MovableObject * > 
MovableObjectArray
 SceneManager::cullFrustum More...
 

Public Member Functions

 ParticleSystem (IdType id, ObjectMemoryManager *objectMemoryManager, const String &resourceGroupName)
 Creates a particle system with no emitters or affectors. More...
 
virtual ~ParticleSystem ()
 
ParticleIterator _getIterator (void)
 Returns an iterator for stepping through all particles in this system. More...
 
LightList_getLightList ()
 Returns a pointer to the current list of lights for this object. More...
 
SceneManager_getManager (void) const
 Get the manager of this object, if any (internal use only) More...
 
ObjectData_getObjectData ()
 Returns a direct access to the ObjectData state. More...
 
const Matrix4_getParentNodeFullTransform (void) const
 Returns the full transformation of the parent sceneNode or the attachingPoint node. More...
 
void _notifyAttached (Node *parent)
 Overridden from MovableObject. More...
 
void _notifyManager (SceneManager *man)
 Notify the object of it's manager (internal use only) More...
 
void _notifyOrigin (const String &origin)
 Notify this particle system of it's origin. More...
 
virtual void _notifyParentNodeMemoryChanged (void)
 Node::_callMemoryChangeListeners More...
 
virtual void _notifyParticleResized (void)
 Internal callback used by Particles to notify their parent that they have been resized. More...
 
virtual void _notifyParticleRotated (void)
 Internal callback used by Particles to notify their parent that they have been rotated. More...
 
virtual void _notifyStaticDirty (void) const
 Called by SceneManager when it is telling we're a static MovableObject being dirty Don't call this directly. More...
 
void _setCachedAabbOutOfDate (void)
 
void _update (Real timeElapsed)
 Updates the particles in the system based on time elapsed. More...
 
void _updateBounds (void)
 Internal method for updating the bounds of the particle system. More...
 
virtual void _updateRenderQueue (RenderQueue *queue, Camera *camera, const Camera *lodCamera)
 Overridden from MovableObject. More...
 
ParticleAffectoraddAffector (const String &affectorType)
 Adds an affector to this particle system. More...
 
ParticleEmitteraddEmitter (const String &emitterType)
 Adds an emitter to this particle system. More...
 
void addQueryFlags (uint32 flags)
 As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
 
void addVisibilityFlags (uint32 flags)
 As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
 
void clear ()
 Empties this set of all particles. More...
 
virtual void copyParametersTo (StringInterface *dest) const
 Method for copying this object's parameters to another object. More...
 
virtual AnimableValuePtr createAnimableValue (const String &valueName)
 Create a reference-counted AnimableValuePtr for the named value. More...
 
ParticlecreateEmitterParticle (const String &emitterName)
 Manually add an emitter particle to the system. More...
 
ParticlecreateParticle (void)
 Manually add a particle to the system. More...
 
void detachFromParent (void)
 Detaches an object from a parent SceneNode if attached. More...
 
void fastForward (Real time, Real interval=0.1)
 Fast-forwards this system by the required number of seconds. More...
 
ParticleAffectorgetAffector (unsigned short index) const
 Retrieves an affector by it's index (zero-based). More...
 
const StringVectorgetAnimableValueNames (void) const
 Gets a list of animable value names for this object. More...
 
bool getCastShadows (void) const
 Returns whether shadow casting is enabled for this object. More...
 
virtual bool getCullIndividually (void) const
 Returns whether or not particles in this are tested individually for culling. More...
 
const FastArray< unsigned char > & getCurrentMaterialLod (void) const
 
virtual Real getDefaultHeight (void) const
 See setDefaultDimensions - this gets 1 component individually. More...
 
virtual Real getDefaultWidth (void) const
 See setDefaultDimensions - this gets 1 component individually. More...
 
size_t getEmittedEmitterQuota (void) const
 Returns the maximum number of emitted emitters this system is allowed to have active at once. More...
 
ParticleEmittergetEmitter (unsigned short index) const
 Retrieves an emitter by it's index (zero-based). More...
 
bool getEmitting () const
 Returns true if the particle system emitting flag is turned on. More...
 
IdType getId () const
 Get the unique id of this object. More...
 
Real getIterationInterval (void) const
 Gets a 'iteration interval' on this particle system. More...
 
bool getKeepParticlesInLocalSpace (void) const
 Gets whether particles (and any affector effects) remain relative to the node the particle system is attached to. More...
 
uint32 getLightMask () const
 Get a bitwise mask which will filter the lights affecting this object. More...
 
ListenergetListener (void) const
 Gets the current listener for this object. More...
 
Aabb getLocalAabb (void) const
 Retrieves the local axis-aligned bounding box for this object. More...
 
virtual const StringgetMaterialName (void) const
 Sets the name of the material to be used for this billboard set. More...
 
const StringgetMovableType (void) const
 Overridden from MovableObject. More...
 
const StringgetName (void) const
 Returns the name of this object. More...
 
Real getNonVisibleUpdateTimeout (void) const
 Gets when the particle system should stop updating after it hasn't been visible for a while. More...
 
unsigned short getNumAffectors (void) const
 Returns the number of affectors for this particle system. More...
 
unsigned short getNumEmitters (void) const
 Returns the number of emitters for this particle system. More...
 
size_t getNumParticles (void) const
 Gets the number of individual particles in the system right now. More...
 
const StringgetOrigin (void) const
 Get the origin of this particle system, e.g. More...
 
ParamDictionarygetParamDictionary (void)
 Retrieves the parameter dictionary for this class. More...
 
const ParamDictionarygetParamDictionary (void) const
 
virtual String getParameter (const String &name) const
 Generic parameter retrieval method. More...
 
const ParameterListgetParameters (void) const
 Retrieves a list of parameters valid for this object. More...
 
NodegetParentNode (void) const
 Returns the node to which this object is attached. More...
 
SceneNodegetParentSceneNode (void) const
 
ParticlegetParticle (size_t index)
 Retrieve a particle from the system for manual tweaking. More...
 
size_t getParticleQuota (void) const
 Returns the maximum number of particles this system is allowed to have active at once. More...
 
uint32 getQueryFlags (void) const
 Returns the query flags relevant for this object. More...
 
bool getReceivesShadows ()
 Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows. More...
 
ParticleSystemRenderergetRenderer (void) const
 Gets the ParticleRenderer to be used to render this particle system. More...
 
const StringgetRendererName (void) const
 Gets the name of the ParticleRenderer to be used to render this particle system. More...
 
Real getRenderingDistance (void) const
 Gets the distance at which batches are no longer rendered. More...
 
Real getRenderingMinPixelSize () const
 Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...
 
uint8 getRenderQueueGroup (void) const
 Gets the queue group for this entity, see setRenderQueueGroup for full details. More...
 
virtual const StringgetResourceGroupName (void) const
 Return the resource group to be used to load dependent resources. More...
 
bool getSortingEnabled (void) const
 Gets whether particles are sorted relative to the camera. More...
 
Real getSpeedFactor (void) const
 Gets the 'speed factor' on this particle system. More...
 
UserObjectBindingsgetUserObjectBindings ()
 Return an instance of user objects binding associated with this class. More...
 
const UserObjectBindingsgetUserObjectBindings () const
 Return an instance of user objects binding associated with this class. More...
 
uint32 getVisibilityFlags (void) const
 Returns the visibility flags relevant for this object. More...
 
bool getVisible (void) const
 Gets this object whether to be visible or not, if it has a renderable component. More...
 
Aabb getWorldAabb () const
 Gets the axis aligned box in world space. More...
 
Aabb getWorldAabbUpdated ()
 Gets the axis aligned box in world space. More...
 
float getWorldRadius () const
 Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ). More...
 
float getWorldRadiusUpdated ()
 Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ). More...
 
virtual void instanceBatchCullFrustumThreaded (const Frustum *frustum, const Camera *lodCamera, uint32 combinedVisibilityFlags)
 InstancingTheadedCullingMethod, More...
 
bool isAttached (void) const
 Returns true if this object is attached to a Node. More...
 
bool isCachedAabbOutOfDate () const
 
virtual bool isDebugDisplayEnabled (void) const
 Gets whether debug display of this object is enabled. More...
 
bool isStatic () const
 Checks whether this MovableObject is static. setStatic. More...
 
bool isVisible (void) const
 Returns whether or not this object is supposed to be visible or not. 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)
 
bool operator() (const IdObject *left, const IdObject *right)
 
bool operator() (const IdObject &left, const IdObject &right)
 
ParticleSystemoperator= (const ParticleSystem &rhs)
 Assignment operator for copying. More...
 
const LightListqueryLights (void) const
 Gets a list of lights, ordered relative to how close they are to this movable object. More...
 
void removeAffector (unsigned short index)
 Removes an affector from the system. More...
 
void removeAllAffectors (void)
 Removes all the affectors from this system. More...
 
void removeAllEmitters (void)
 Removes all the emitters from this system. More...
 
void removeEmitter (unsigned short index)
 Removes an emitter from the system. More...
 
void removeQueryFlags (uint32 flags)
 As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object. More...
 
void removeVisibilityFlags (uint32 flags)
 As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object. More...
 
void setBoundsAutoUpdated (bool autoUpdate, Real stopIn=0.0f)
 Sets whether the bounds will be automatically updated for the life of the particle system. More...
 
void setCastShadows (bool enabled)
 Sets whether or not this object will cast shadows. More...
 
virtual void setCullIndividually (bool cullIndividual)
 Sets whether culling tests particles in this individually as well as in a group. More...
 
virtual void setDebugDisplayEnabled (bool enabled)
 Sets whether or not the debug display of this object is enabled. More...
 
virtual void setDefaultDimensions (Real width, Real height)
 Sets the default dimensions of the particles in this set. More...
 
virtual void setDefaultHeight (Real height)
 See setDefaultDimensions - this sets 1 component individually. More...
 
virtual void setDefaultWidth (Real width)
 See setDefaultDimensions - this sets 1 component individually. More...
 
void setEmittedEmitterQuota (size_t quota)
 Sets the maximum number of emitted emitters this system is allowed to have active at once. More...
 
void setEmitting (bool v)
 This is used to turn on or off particle emission for this system. More...
 
void setIterationInterval (Real iterationInterval)
 Sets a 'iteration interval' on this particle system. More...
 
void setKeepParticlesInLocalSpace (bool keepLocal)
 Sets whether particles (and any affector effects) remain relative to the node the particle system is attached to. More...
 
void setLightMask (uint32 lightMask)
 Set a bitwise mask which will filter the lights affecting this object. More...
 
void setListener (Listener *listener)
 Sets a listener for this object. More...
 
void setLocalAabb (const Aabb box)
 Sets the local axis-aligned bounding box for this object. More...
 
virtual void setMaterialName (const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
 Sets the name of the material to be used for this billboard set. More...
 
void setName (const String &name)
 Sets a custom name for this node. More...
 
void setNonVisibleUpdateTimeout (Real timeout)
 Sets when the particle system should stop updating after it hasn't been visible for a while. More...
 
virtual bool setParameter (const String &name, const String &value)
 Generic parameter setting method. More...
 
virtual void setParameterList (const NameValuePairList &paramList)
 Generic multiple parameter setting method. More...
 
void setParticleQuota (size_t quota)
 Sets the maximum number of particles this system is allowed to have active at once. More...
 
void setQueryFlags (uint32 flags)
 Sets the query flags for this object. More...
 
void setRenderer (const String &typeName)
 Sets the ParticleRenderer to be used to render this particle system. More...
 
void setRenderingDistance (Real dist)
 Sets the distance at which the object is no longer rendered. More...
 
void setRenderingMinPixelSize (Real pixelSize)
 Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...
 
void setRenderQueueGroup (uint8 queueID)
 Sets the render queue group this entity will be rendered through. More...
 
void setRenderQueueGroupAndPriority (uint8 queueID, ushort priority)
 Sets the render queue group and group priority this entity will be rendered through. More...
 
void setSortingEnabled (bool enabled)
 Set whether or not particles are sorted according to the camera. More...
 
void setSpeedFactor (Real speedFactor)
 Sets a 'speed factor' on this particle system, which means it scales the elapsed real time which has passed by this factor before passing it to the emitters, affectors, and the particle life calculation. More...
 
bool setStatic (bool bStatic)
 Turns this Node into static or dynamic. More...
 
void setVisibilityFlags (uint32 flags)
 Sets the visibility flags for this object. More...
 
void setVisible (bool visible)
 Tells this object whether to be visible or not, if it has a renderable component. More...
 
void visitRenderables (Renderable::Visitor *visitor, bool debugRenderables=false)
 Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject will add to the render queue when asked, if any. More...
 

Static Public Member Functions

static void buildLightList (const size_t numNodes, ObjectData t, const LightListInfo &globalLightList)
 SceneManager::buildLightList More...
 
static void calculateCastersBox (const size_t numNodes, ObjectData t, uint32 sceneVisibilityFlags, AxisAlignedBox *outBox)
 
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...
 
static void cullFrustum (const size_t numNodes, ObjectData t, const Frustum *frustum, uint32 sceneVisibilityFlags, MovableObjectArray &outCulledObjects, const Camera *lodCamera)
 
static void cullLights (const size_t numNodes, ObjectData t, LightListInfo &outGlobalLightList, const FrustumVec &frustums, const FrustumVec &cubemapFrustums)
 SceneManager::cullLights & More...
 
static Real getDefaultIterationInterval (void)
 Get the default iteration interval for all ParticleSystem instances. More...
 
static Real getDefaultNonVisibleUpdateTimeout (void)
 Get the default nonvisible timeout for all ParticleSystem instances. More...
 
static uint32 getDefaultQueryFlags ()
 Get the default query flags for all future MovableObject instances. More...
 
static uint32 getDefaultVisibilityFlags ()
 Get the default visibility flags for all future MovableObject instances. More...
 
static void setDefaultIterationInterval (Real iterationInterval)
 Set the default iteration interval for all ParticleSystem instances. More...
 
static void setDefaultNonVisibleUpdateTimeout (Real timeout)
 Set the default nonvisible timeout for all ParticleSystem instances. More...
 
static void setDefaultQueryFlags (uint32 flags)
 Set the default query flags for all future MovableObject instances. More...
 
static void setDefaultVisibilityFlags (uint32 flags)
 Set the default visibility flags for all future MovableObject instances. More...
 
static void updateAllBounds (const size_t numNodes, ObjectData t)
 SceneManager::updateAllBounds More...
 

Public Attributes

const FastArray< Realc_DefaultLodMesh
 
size_t mGlobalIndex
 Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks). More...
 
size_t mParentIndex
 Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks). More...
 

Protected Types

typedef list< ParticleEmitter * >
::type 
ActiveEmittedEmitterList
 
typedef list< Particle * >::type ActiveParticleList
 
typedef map< String,
StringVector >::type 
AnimableDictionaryMap
 
typedef vector
< ParticleEmitter * >::type 
EmittedEmitterList
 
typedef map< String,
EmittedEmitterList >::type 
EmittedEmitterPool
 
typedef list< ParticleEmitter * >
::type 
FreeEmittedEmitterList
 
typedef map< String,
FreeEmittedEmitterList >::type 
FreeEmittedEmitterMap
 
typedef list< Particle * >::type FreeParticleList
 
typedef vector
< ParticleAffector * >::type 
ParticleAffectorList
 
typedef vector
< ParticleEmitter * >::type 
ParticleEmitterList
 
typedef vector< Particle * >::type ParticlePool
 

Protected Member Functions

void _applyMotion (Real timeElapsed)
 Updates existing particle based on their momentum. More...
 
void _executeTriggerEmitters (ParticleEmitter *emitter, unsigned requested, Real timeElapsed)
 Helper function that actually performs the emission of particles. More...
 
void _expire (Real timeElapsed)
 Internal method used to expire dead particles. More...
 
StringVector_getAnimableValueNames (void)
 Get an updateable reference to animable value list. More...
 
void _notifyReorganiseEmittedEmitterData (void)
 This function clears all data structures that are used in combination with emitted emitters and sets the flag to indicate that the emitted emitter pool must be initialised again. More...
 
void _setId (IdType newId)
 In the rare case our derived class wants to override our Id (normally we don't want that, that's why it's private). More...
 
void _sortParticles (Camera *cam)
 Sort the particles in the system. More...
 
void _triggerAffectors (Real timeElapsed)
 Applies the effects of affectors. More...
 
void _triggerEmitters (Real timeElapsed)
 Spawn new particles based on free quota and emitter requirements. More...
 
void addActiveEmittedEmittersToFreeList (void)
 Moves all emitted emitters from the active list to the free list. More...
 
void addFreeEmittedEmitters (void)
 Add emitters from the pool to the free emitted emitter queue. More...
 
void configureRenderer (void)
 Internal method to configure the renderer. More...
 
void createAnimableDictionary (void) const
 Internal method for creating a dictionary of animable value names for the class, if it does not already exist. More...
 
bool createParamDictionary (const String &className)
 Internal method for creating a parameter dictionary for the class, if it does not already exist. More...
 
void createVisualParticles (size_t poolstart, size_t poolend)
 Internal method for creating ParticleVisualData instances for the pool. More...
 
void destroyVisualParticles (size_t poolstart, size_t poolend)
 Internal method for destroying ParticleVisualData instances for the pool. More...
 
FreeEmittedEmitterListfindFreeEmittedEmitter (const String &name)
 Find the list with free emitted emitters. More...
 
virtual const StringgetAnimableDictionaryName (void) const
 Get the name of the animable dictionary for this class. More...
 
void increaseEmittedEmitterPool (size_t size)
 Resize the internal pool of emitted emitters. More...
 
void increasePool (size_t size)
 Resize the internal pool of particles. More...
 
virtual void initialiseAnimableDictionary (StringVector &) const
 Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters. More...
 
void initialiseEmittedEmitterPool (void)
 Determine which emitters in the Particle Systems main emitter become a template for creating an pool of emitters that can be emitted. More...
 
void initialiseEmittedEmitters (void)
 Create a pool of emitted emitters and assign them to the free emitter list. More...
 
void initParameters (void)
 Internal method for initialising string interface. More...
 
void removeAllEmittedEmitters (void)
 Removes all emitted emitters from this system. More...
 
void removeFromActiveEmittedEmitters (ParticleEmitter *emitter)
 Removes an emitter from the active emitted emitter list. More...
 
Aabb updateSingleWorldAabb ()
 
float updateSingleWorldRadius ()
 

Protected Attributes

ActiveEmittedEmitterList mActiveEmittedEmitters
 Active emitted emitter list. More...
 
ActiveParticleList mActiveParticles
 Active particle list. More...
 
ParticleAffectorList mAffectors
 List of particle affectors, ie modifiers of particles. More...
 
bool mBoundsAutoUpdate
 
Real mBoundsUpdateTime
 
bool mCachedAabbOutOfDate
 
bool mCullIndividual
 Do we cull each particle individually? More...
 
FastArray< unsigned char > mCurrentMaterialLod
 
unsigned char mCurrentMeshLod
 
bool mDebugDisplay
 Is debug display enabled? More...
 
Real mDefaultHeight
 Default height of each particle. More...
 
Real mDefaultWidth
 Default width of each particle. More...
 
EmittedEmitterPool mEmittedEmitterPool
 Pool of emitted emitters for use and reuse in the active emitted emitter list. More...
 
bool mEmittedEmitterPoolInitialised
 Indication whether the emitted emitter pool (= pool with particle emitters that are emitted) is initialised. More...
 
size_t mEmittedEmitterPoolSize
 The number of emitted emitters in the pool. More...
 
ParticleEmitterList mEmitters
 List of particle emitters, ie sources of particles. More...
 
FreeEmittedEmitterMap mFreeEmittedEmitters
 Free emitted emitter list. More...
 
FreeParticleList mFreeParticles
 Free particle queue. More...
 
bool mIsEmitting
 Used to control if the particle system should emit particles or not. More...
 
bool mIsRendererConfigured
 Have we set the material etc on the renderer? More...
 
Real mIterationInterval
 Iteration interval. More...
 
bool mIterationIntervalSet
 Iteration interval set? Otherwise track default. More...
 
unsigned long mLastVisibleFrame
 Last frame in which known to be visible. More...
 
LightList mLightList
 List of lights for this object. More...
 
ListenermListener
 MovableObject listener - only one allowed (no list) for size & performance reasons. More...
 
bool mLocalSpace
 Particles in local space? More...
 
FastArray< FastArray< Real >
const * > 
mLodMaterial
 
FastArray< Real > const * mLodMesh
 
SceneManagermManager
 SceneManager holding this object (if applicable) More...
 
MaterialPtr mMaterial
 Pointer to the material to use. More...
 
String mMaterialName
 Name of the material to use. More...
 
Real mMinPixelSize
 Minimum pixel size to still render. More...
 
String mName
 Friendly name of this object, can be empty. More...
 
Real mNonvisibleTimeout
 Update timeout when nonvisible (0 for no timeout) More...
 
bool mNonvisibleTimeoutSet
 Update timeout when nonvisible set? Otherwise track default. More...
 
ObjectData mObjectData
 All the object data needed in SoA form. More...
 
ObjectMemoryManagermObjectMemoryManager
 The memory manager used to allocate the ObjectData. More...
 
String mOrigin
 Optional origin of this particle system (eg script name) More...
 
NodemParentNode
 Node to which this object is attached. More...
 
ParticlePool mParticlePool
 Pool of particle instances for use and reuse in the active particle list. More...
 
size_t mPoolSize
 The number of particles in the pool. More...
 
ParticleSystemRenderermRenderer
 The renderer used to render this particle system. More...
 
String mRendererType
 The name of the type of renderer used to render this system. More...
 
uint8 mRenderQueueID
 The render queue to use when rendering this object. More...
 
ushort mRenderQueuePriority
 The render queue group to use when rendering this object. More...
 
String mResourceGroupName
 Name of the resource group to use to load materials. More...
 
bool mSorted
 Particles sorted according to camera? More...
 
Real mSpeedFactor
 Speed factor. More...
 
Controller< Real > * mTimeController
 Controller for time update. More...
 
Real mTimeSinceLastVisible
 Amount of time non-visible so far. More...
 
Real mUpdateRemainTime
 
UserObjectBindings mUserObjectBindings
 User objects binding. More...
 

Static Protected Attributes

static RadixSort
< ActiveParticleList, Particle
*, float > 
mRadixSorter
 
static AnimableDictionaryMap msAnimableDictionary
 Static map of class name to list of animable value names. More...
 
static CmdCull msCullCmd
 Command objects. More...
 
static Real msDefaultIterationInterval
 Default iteration interval. More...
 
static Real msDefaultNonvisibleTimeout
 Default nonvisible update timeout. More...
 
static uint32 msDefaultQueryFlags
 Default query flags. More...
 
static uint32 msDefaultVisibilityFlags
 Default visibility flags. More...
 
static CmdEmittedEmitterQuota msEmittedEmitterQuotaCmd
 
static CmdHeight msHeightCmd
 
static CmdIterationInterval msIterationIntervalCmd
 
static CmdLocalSpace msLocalSpaceCmd
 
static CmdMaterial msMaterialCmd
 
static CmdNonvisibleTimeout msNonvisibleTimeoutCmd
 
static CmdQuota msQuotaCmd
 
static CmdRenderer msRendererCmd
 
static CmdSorted msSortedCmd
 
static CmdWidth msWidthCmd
 

Detailed Description

Class defining particle system based special effects.

Remarks
Particle systems are special effects generators which are based on a number of moving points to create the impression of things like like sparkles, smoke, blood spurts, dust etc.
This class simply manages a single collection of particles in world space with a shared local origin for emission. The visual aspect of the particles is handled by a ParticleSystemRenderer instance.
Particle systems are created using the SceneManager, never directly. In addition, like all subclasses of MovableObject, the ParticleSystem will only be considered for rendering once it has been attached to a SceneNode.

Definition at line 65 of file OgreParticleSystem.h.

Member Typedef Documentation

Definition at line 721 of file OgreParticleSystem.h.

Definition at line 666 of file OgreParticleSystem.h.

Definition at line 237 of file OgreAnimable.h.

Definition at line 722 of file OgreParticleSystem.h.

Definition at line 724 of file OgreParticleSystem.h.

Definition at line 720 of file OgreParticleSystem.h.

Definition at line 667 of file OgreParticleSystem.h.

SceneManager::cullFrustum

Remarks
We don't pass by reference on purpose (avoid implicit aliasing) We perform frustum culling AND test visibility mask at the same time
Parameters
frustumFrustum to clip against
sceneVisibilityFlagsCombined scene's visibility flags (i.e. viewport | scene). Set LAYER_SHADOW_CASTER bit if you want to exclude non-shadow casters.
outCulledObjectsOut. List of objects that are (fully or partially) inside the frustum and should be rendered
lodCameraCamera in which lod levels calculations are based (i.e. during shadow pass renders) Note however, we only use this camera to calulate if should be visible according to mUpperDistance

Definition at line 244 of file OgreMovableObject.h.

Definition at line 750 of file OgreParticleSystem.h.

Definition at line 749 of file OgreParticleSystem.h.

Definition at line 668 of file OgreParticleSystem.h.

Constructor & Destructor Documentation

Ogre::ParticleSystem::ParticleSystem ( IdType  id,
ObjectMemoryManager objectMemoryManager,
const String resourceGroupName 
)

Creates a particle system with no emitters or affectors.

Remarks
You should use the ParticleSystemManager to create particle systems rather than creating them directly.
virtual Ogre::ParticleSystem::~ParticleSystem ( )
virtual

Member Function Documentation

void Ogre::ParticleSystem::_applyMotion ( Real  timeElapsed)
protected

Updates existing particle based on their momentum.

void Ogre::ParticleSystem::_executeTriggerEmitters ( ParticleEmitter emitter,
unsigned  requested,
Real  timeElapsed 
)
protected

Helper function that actually performs the emission of particles.

void Ogre::ParticleSystem::_expire ( Real  timeElapsed)
protected

Internal method used to expire dead particles.

StringVector& Ogre::AnimableObject::_getAnimableValueNames ( void  )
inlineprotectedinherited

Get an updateable reference to animable value list.

Definition at line 263 of file OgreAnimable.h.

References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.

ParticleIterator Ogre::ParticleSystem::_getIterator ( void  )

Returns an iterator for stepping through all particles in this system.

Remarks
This method is designed to be used by people providing new ParticleAffector subclasses, this is the easiest way to step through all the particles in a system and apply the changes the affector wants to make.
LightList* Ogre::MovableObject::_getLightList ( )
inlineinherited

Returns a pointer to the current list of lights for this object.

Remarks
You should not modify this list outside of MovableObject::Listener::objectQueryLights (say if you want to use it to implement this method, and use the pointer as a return value) and for reading it's only accurate as at the last frame.

Definition at line 534 of file OgreMovableObject.h.

SceneManager* Ogre::MovableObject::_getManager ( void  ) const
inlineinherited

Get the manager of this object, if any (internal use only)

Definition at line 160 of file OgreMovableObject.h.

ObjectData& Ogre::MovableObject::_getObjectData ( )
inlineinherited

Returns a direct access to the ObjectData state.

Definition at line 387 of file OgreMovableObject.h.

const Matrix4& Ogre::MovableObject::_getParentNodeFullTransform ( void  ) const
inherited

Returns the full transformation of the parent sceneNode or the attachingPoint node.

void Ogre::ParticleSystem::_notifyAttached ( Node parent)
virtual

Overridden from MovableObject.

See also
MovableObject

Reimplemented from Ogre::MovableObject.

void Ogre::MovableObject::_notifyManager ( SceneManager man)
inlineinherited

Notify the object of it's manager (internal use only)

Definition at line 158 of file OgreMovableObject.h.

void Ogre::ParticleSystem::_notifyOrigin ( const String origin)
inline

Notify this particle system of it's origin.

Definition at line 527 of file OgreParticleSystem.h.

virtual void Ogre::MovableObject::_notifyParentNodeMemoryChanged ( void  )
inlinevirtualinherited

Node::_callMemoryChangeListeners

Reimplemented in Ogre::InstancedEntity.

Definition at line 187 of file OgreMovableObject.h.

virtual void Ogre::ParticleSystem::_notifyParticleResized ( void  )
virtual

Internal callback used by Particles to notify their parent that they have been resized.

virtual void Ogre::ParticleSystem::_notifyParticleRotated ( void  )
virtual

Internal callback used by Particles to notify their parent that they have been rotated.

void Ogre::ParticleSystem::_notifyReorganiseEmittedEmitterData ( void  )
protected

This function clears all data structures that are used in combination with emitted emitters and sets the flag to indicate that the emitted emitter pool must be initialised again.

Remarks
This function should be called if new emitters are added to a ParticleSystem or deleted from a ParticleSystem. The emitted emitter data structures become out of sync and need to be build up again. The data structures are not reorganised in this function, but by setting a flag, they are rebuild in the regular process flow.
virtual void Ogre::MovableObject::_notifyStaticDirty ( void  ) const
inlinevirtualinherited

Called by SceneManager when it is telling we're a static MovableObject being dirty Don't call this directly.

See also
SceneManager::notifyStaticDirty

Reimplemented in Ogre::InstancedEntity.

Definition at line 212 of file OgreMovableObject.h.

void Ogre::MovableObject::_setCachedAabbOutOfDate ( void  )
inlineinherited

Definition at line 586 of file OgreMovableObject.h.

void Ogre::IdObject::_setId ( IdType  newId)
inlineprotectedinherited

In the rare case our derived class wants to override our Id (normally we don't want that, that's why it's private).

Definition at line 63 of file OgreId.h.

void Ogre::ParticleSystem::_sortParticles ( Camera cam)
protected

Sort the particles in the system.

void Ogre::ParticleSystem::_triggerAffectors ( Real  timeElapsed)
protected

Applies the effects of affectors.

void Ogre::ParticleSystem::_triggerEmitters ( Real  timeElapsed)
protected

Spawn new particles based on free quota and emitter requirements.

void Ogre::ParticleSystem::_update ( Real  timeElapsed)

Updates the particles in the system based on time elapsed.

Remarks
This is called automatically every frame by OGRE.
Parameters
timeElapsedThe amount of time, in seconds, since the last frame.
void Ogre::ParticleSystem::_updateBounds ( void  )

Internal method for updating the bounds of the particle system.

Remarks
This is called automatically for a period of time after the system's creation (10 seconds by default, settable by setBoundsAutoUpdated) to increase (and only increase) the bounds of the system according to the emitted and affected particles. After this period, the system is assumed to achieved its maximum size, and the bounds are no longer computed for efficiency. You can tweak the behaviour by either setting the bounds manually (setBounds, preferred), or changing the time over which the bounds are updated (performance cost). You can also call this method manually if you need to update the bounds on an ad-hoc basis.
virtual void Ogre::ParticleSystem::_updateRenderQueue ( RenderQueue queue,
Camera camera,
const Camera lodCamera 
)
virtual

Overridden from MovableObject.

See also
MovableObject

Implements Ogre::MovableObject.

void Ogre::ParticleSystem::addActiveEmittedEmittersToFreeList ( void  )
protected

Moves all emitted emitters from the active list to the free list.

Remarks
The active emitted emitter list will not be cleared and still keeps references to the emitters!
ParticleAffector* Ogre::ParticleSystem::addAffector ( const String affectorType)

Adds an affector to this particle system.

Remarks
Particles are modified over time in a particle system by affectors - see the ParticleAffector class for more details.
Parameters
affectorTypeString identifying the affector type to create. Affector types are defined by registering new factories with the manager - see ParticleAffectorFactory for more details. Affector types can be extended by OGRE, plugin authors or application developers.
ParticleEmitter* Ogre::ParticleSystem::addEmitter ( const String emitterType)

Adds an emitter to this particle system.

Remarks
Particles are created in a particle system by emitters - see the ParticleEmitter class for more details.
Parameters
emitterTypeString identifying the emitter type to create. Emitter types are defined by registering new factories with the manager - see ParticleEmitterFactory for more details. Emitter types can be extended by OGRE, plugin authors or application developers.
void Ogre::ParticleSystem::addFreeEmittedEmitters ( void  )
protected

Add emitters from the pool to the free emitted emitter queue.

void Ogre::MovableObject::addQueryFlags ( uint32  flags)
inlineinherited

As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.

void Ogre::MovableObject::addVisibilityFlags ( uint32  flags)
inlineinherited

As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object.

static void Ogre::MovableObject::buildLightList ( const size_t  numNodes,
ObjectData  t,
const LightListInfo globalLightList 
)
staticinherited

SceneManager::buildLightList

Remarks
We don't pass by reference on purpose (avoid implicit aliasing)
Parameters
globalLightListList of lights already culled against all possible frustums and reorganized contiguously for SoA
static void Ogre::MovableObject::calculateCastersBox ( const size_t  numNodes,
ObjectData  t,
uint32  sceneVisibilityFlags,
AxisAlignedBox outBox 
)
staticinherited
static void Ogre::StringInterface::cleanupDictionary ( )
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.

void Ogre::ParticleSystem::clear ( )

Empties this set of all particles.

void Ogre::ParticleSystem::configureRenderer ( void  )
protected

Internal method to configure the renderer.

virtual void Ogre::StringInterface::copyParametersTo ( StringInterface dest) const
inlinevirtualinherited

Method for copying this object's parameters to another object.

Remarks
This method takes the values of all the object's parameters and tries to set the same values on the destination object. This provides a completely type independent way to copy parameters to other objects. Note that because of the String manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop.
Any unrecognised parameters will be ignored as with setParameter method.
Parameters
destPointer to object to have it's parameters set the same as this object.

Definition at line 302 of file OgreStringInterface.h.

References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().

void Ogre::AnimableObject::createAnimableDictionary ( void  ) const
inlineprotectedinherited

Internal method for creating a dictionary of animable value names for the class, if it does not already exist.

Definition at line 250 of file OgreAnimable.h.

virtual AnimableValuePtr Ogre::AnimableObject::createAnimableValue ( const String valueName)
inlinevirtualinherited

Create a reference-counted AnimableValuePtr for the named value.

Remarks
You can use the returned object to animate a value on this object, using AnimationTrack. Subclasses must override this if they wish to support animation of their values.

Reimplemented in Ogre::Light.

Definition at line 316 of file OgreAnimable.h.

References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.

Particle* Ogre::ParticleSystem::createEmitterParticle ( const String emitterName)

Manually add an emitter particle to the system.

Remarks
The purpose of a particle emitter is to emit particles. Besides visual particles, also other other particle types can be emitted, other emitters for example. The emitted emitters have a double role; they behave as particles and can be influenced by affectors, but they are still emitters and capable to emit other particles (or emitters). It is possible to create a chain of emitters - emitters emitting other emitters, which also emit emitters.
Parameters
emitterNameThe name of a particle emitter that must be emitted.
bool Ogre::StringInterface::createParamDictionary ( const String className)
inlineprotectedinherited

Internal method for creating a parameter dictionary for the class, if it does not already exist.

Remarks
This method will check to see if a parameter dictionary exist for this class yet, and if not will create one. NB you must supply the name of the class (RTTI is not used or performance).
Parameters
classNamethe name of the class using the dictionary
Returns
true if a new dictionary was created, false if it was already there

Definition at line 185 of file OgreStringInterface.h.

References OGRE_LOCK_MUTEX.

Particle* Ogre::ParticleSystem::createParticle ( void  )

Manually add a particle to the system.

Remarks
Instead of using an emitter, you can manually add a particle to the system. You must initialise the returned particle instance immediately with the 'emission' state.
Note
There is no corresponding 'destroyParticle' method - if you want to dispose of a particle manually (say, if you've used setSpeedFactor(0) to make particles live forever) you should use getParticle() and modify it's timeToLive to zero, meaning that it will get cleaned up in the next update.
void Ogre::ParticleSystem::createVisualParticles ( size_t  poolstart,
size_t  poolend 
)
protected

Internal method for creating ParticleVisualData instances for the pool.

static void Ogre::MovableObject::cullFrustum ( const size_t  numNodes,
ObjectData  t,
const Frustum frustum,
uint32  sceneVisibilityFlags,
MovableObjectArray outCulledObjects,
const Camera lodCamera 
)
staticinherited
static void Ogre::MovableObject::cullLights ( const size_t  numNodes,
ObjectData  t,
LightListInfo outGlobalLightList,
const FrustumVec frustums,
const FrustumVec cubemapFrustums 
)
staticinherited

SceneManager::cullLights &

See also
MovableObject::cullFrustum Produces the global list of visible lights that is needed in buildLightList
Remarks
We don't pass ObjectData by reference on purpose (avoid implicit aliasing) It's declared here because all affected elements are from MovableObject IMPORTANT: It is assumed that all objects in ObjectData are Lights.
Parameters
outGlobalLightListOutput, a list of lights, contiguously placed
frustumsAn array of all frustums we need to check against
cubemapFrustumsAn array of all frustums that are used at least once as cubemaps ( SceneManager::createCamera)
void Ogre::ParticleSystem::destroyVisualParticles ( size_t  poolstart,
size_t  poolend 
)
protected

Internal method for destroying ParticleVisualData instances for the pool.

void Ogre::MovableObject::detachFromParent ( void  )
inherited

Detaches an object from a parent SceneNode if attached.

void Ogre::ParticleSystem::fastForward ( Real  time,
Real  interval = 0.1 
)

Fast-forwards this system by the required number of seconds.

Remarks
This method allows you to fast-forward a system so that it effectively looks like it has already been running for the time you specify. This is useful to avoid the 'startup sequence' of a system, when you want the system to be fully populated right from the start.
Parameters
timeThe number of seconds to fast-forward by.
intervalThe sampling interval used to generate particles, apply affectors etc. The lower this is the more realistic the fast-forward, but it takes more iterations to do it.
FreeEmittedEmitterList* Ogre::ParticleSystem::findFreeEmittedEmitter ( const String name)
protected

Find the list with free emitted emitters.

Parameters
nameThe name that identifies the list with free emitted emitters.
ParticleAffector* Ogre::ParticleSystem::getAffector ( unsigned short  index) const

Retrieves an affector by it's index (zero-based).

Remarks
Used to retrieve a pointer to an affector for a particle system to procedurally change affector parameters etc. You should check how many affectors are registered against this system before calling this method with an arbitrary index using getNumAffectors.
Parameters
indexZero-based index of the affector to retrieve.
virtual const String& Ogre::AnimableObject::getAnimableDictionaryName ( void  ) const
inlineprotectedvirtualinherited

Get the name of the animable dictionary for this class.

Remarks
Subclasses must override this if they want to support animation of their values.

Definition at line 245 of file OgreAnimable.h.

References Ogre::BLANKSTRING.

const StringVector& Ogre::AnimableObject::getAnimableValueNames ( void  ) const
inlineinherited

Gets a list of animable value names for this object.

Definition at line 291 of file OgreAnimable.h.

References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.

bool Ogre::MovableObject::getCastShadows ( void  ) const
inlineinherited

Returns whether shadow casting is enabled for this object.

virtual bool Ogre::ParticleSystem::getCullIndividually ( void  ) const
virtual

Returns whether or not particles in this are tested individually for culling.

const FastArray<unsigned char>& Ogre::MovableObject::getCurrentMaterialLod ( void  ) const
inlineinherited

Definition at line 536 of file OgreMovableObject.h.

virtual Real Ogre::ParticleSystem::getDefaultHeight ( void  ) const
virtual

See setDefaultDimensions - this gets 1 component individually.

static Real Ogre::ParticleSystem::getDefaultIterationInterval ( void  )
inlinestatic

Get the default iteration interval for all ParticleSystem instances.

Definition at line 432 of file OgreParticleSystem.h.

static Real Ogre::ParticleSystem::getDefaultNonVisibleUpdateTimeout ( void  )
inlinestatic

Get the default nonvisible timeout for all ParticleSystem instances.

Definition at line 461 of file OgreParticleSystem.h.

static uint32 Ogre::MovableObject::getDefaultQueryFlags ( )
inlinestaticinherited

Get the default query flags for all future MovableObject instances.

Definition at line 464 of file OgreMovableObject.h.

static uint32 Ogre::MovableObject::getDefaultVisibilityFlags ( )
inlinestaticinherited

Get the default visibility flags for all future MovableObject instances.

Definition at line 495 of file OgreMovableObject.h.

virtual Real Ogre::ParticleSystem::getDefaultWidth ( void  ) const
virtual

See setDefaultDimensions - this gets 1 component individually.

size_t Ogre::ParticleSystem::getEmittedEmitterQuota ( void  ) const

Returns the maximum number of emitted emitters this system is allowed to have active at once.

Remarks
See ParticleSystem::setEmittedEmitterQuota for more info.
ParticleEmitter* Ogre::ParticleSystem::getEmitter ( unsigned short  index) const

Retrieves an emitter by it's index (zero-based).

Remarks
Used to retrieve a pointer to an emitter for a particle system to procedurally change emission parameters etc. You should check how many emitters are registered against this system before calling this method with an arbitrary index using getNumEmitters.
Parameters
indexZero-based index of the emitter to retrieve.
bool Ogre::ParticleSystem::getEmitting ( ) const

Returns true if the particle system emitting flag is turned on.

Remarks
This function will not actually return whether the particles are being emitted. It only returns the value of emitting flag.
IdType Ogre::IdObject::getId ( ) const
inlineinherited

Get the unique id of this object.

Definition at line 74 of file OgreId.h.

Real Ogre::ParticleSystem::getIterationInterval ( void  ) const
inline

Gets a 'iteration interval' on this particle system.

Definition at line 424 of file OgreParticleSystem.h.

bool Ogre::ParticleSystem::getKeepParticlesInLocalSpace ( void  ) const
inline

Gets whether particles (and any affector effects) remain relative to the node the particle system is attached to.

Definition at line 576 of file OgreParticleSystem.h.

uint32 Ogre::MovableObject::getLightMask ( ) const
inlineinherited

Get a bitwise mask which will filter the lights affecting this object.

Remarks
By default, this mask is fully set meaning all lights will affect this object
Listener* Ogre::MovableObject::getListener ( void  ) const
inlineinherited

Gets the current listener for this object.

Definition at line 506 of file OgreMovableObject.h.

Aabb Ogre::MovableObject::getLocalAabb ( void  ) const
inherited

Retrieves the local axis-aligned bounding box for this object.

Remarks
This bounding box is in local coordinates.
virtual const String& Ogre::ParticleSystem::getMaterialName ( void  ) const
virtual

Sets the name of the material to be used for this billboard set.

Returns
The name of the material that is used for this set.
const String& Ogre::ParticleSystem::getMovableType ( void  ) const
virtual

Overridden from MovableObject.

Implements Ogre::MovableObject.

const String& Ogre::MovableObject::getName ( void  ) const
inlineinherited

Returns the name of this object.

Definition at line 166 of file OgreMovableObject.h.

Real Ogre::ParticleSystem::getNonVisibleUpdateTimeout ( void  ) const
inline

Gets when the particle system should stop updating after it hasn't been visible for a while.

Definition at line 452 of file OgreParticleSystem.h.

unsigned short Ogre::ParticleSystem::getNumAffectors ( void  ) const

Returns the number of affectors for this particle system.

unsigned short Ogre::ParticleSystem::getNumEmitters ( void  ) const

Returns the number of emitters for this particle system.

size_t Ogre::ParticleSystem::getNumParticles ( void  ) const

Gets the number of individual particles in the system right now.

Remarks
The number of particles active in a system at a point in time depends on the number of emitters, their emission rates, the time-to-live (TTL) each particle is given on emission (and whether any affectors modify that TTL) and the maximum number of particles allowed in this system at once (particle quota).
const String& Ogre::ParticleSystem::getOrigin ( void  ) const
inline

Get the origin of this particle system, e.g.

a script file name.

Remarks
This property will only contain something if the creator of this particle system chose to populate it. Script loaders are advised to populate it.

Definition at line 525 of file OgreParticleSystem.h.

ParamDictionary* Ogre::StringInterface::getParamDictionary ( void  )
inlineinherited

Retrieves the parameter dictionary for this class.

Remarks
Only valid to call this after createParamDictionary.
Returns
Pointer to ParamDictionary shared by all instances of this class which you can add parameters to, retrieve parameters etc.

Definition at line 218 of file OgreStringInterface.h.

const ParamDictionary* Ogre::StringInterface::getParamDictionary ( void  ) const
inlineinherited

Definition at line 223 of file OgreStringInterface.h.

virtual String Ogre::StringInterface::getParameter ( const String name) const
inlinevirtualinherited

Generic parameter retrieval method.

Remarks
Call this method with the name of a parameter to retrieve a string-format value of the parameter in question. If in doubt, check the parameter definition in the list returned from getParameters for the type of this parameter. If you like you can use StringConverter to convert this string back into a native type.
Parameters
nameThe name of the parameter to get
Returns
String value of parameter, blank if not found

Definition at line 271 of file OgreStringInterface.h.

References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().

const ParameterList& Ogre::StringInterface::getParameters ( void  ) const
inherited

Retrieves a list of parameters valid for this object.

Returns
A reference to a static list of ParameterDef objects.
Node* Ogre::MovableObject::getParentNode ( void  ) const
inlineinherited

Returns the node to which this object is attached.

Definition at line 172 of file OgreMovableObject.h.

SceneNode* Ogre::MovableObject::getParentSceneNode ( void  ) const
inlineinherited
Particle* Ogre::ParticleSystem::getParticle ( size_t  index)

Retrieve a particle from the system for manual tweaking.

Remarks
Normally you use an affector to alter particles in flight, but for small manually controlled particle systems you might want to use this method.
size_t Ogre::ParticleSystem::getParticleQuota ( void  ) const

Returns the maximum number of particles this system is allowed to have active at once.

Remarks
See ParticleSystem::setParticleQuota for more info.
uint32 Ogre::MovableObject::getQueryFlags ( void  ) const
inlineinherited

Returns the query flags relevant for this object.

bool Ogre::MovableObject::getReceivesShadows ( )
inherited

Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows.

ParticleSystemRenderer* Ogre::ParticleSystem::getRenderer ( void  ) const

Gets the ParticleRenderer to be used to render this particle system.

const String& Ogre::ParticleSystem::getRendererName ( void  ) const

Gets the name of the ParticleRenderer to be used to render this particle system.

Real Ogre::MovableObject::getRenderingDistance ( void  ) const
inlineinherited

Gets the distance at which batches are no longer rendered.

Real Ogre::MovableObject::getRenderingMinPixelSize ( ) const
inlineinherited

Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered.

Definition at line 338 of file OgreMovableObject.h.

uint8 Ogre::MovableObject::getRenderQueueGroup ( void  ) const
inherited

Gets the queue group for this entity, see setRenderQueueGroup for full details.

virtual const String& Ogre::ParticleSystem::getResourceGroupName ( void  ) const
inlinevirtual

Return the resource group to be used to load dependent resources.

Definition at line 518 of file OgreParticleSystem.h.

bool Ogre::ParticleSystem::getSortingEnabled ( void  ) const
inline

Gets whether particles are sorted relative to the camera.

Definition at line 542 of file OgreParticleSystem.h.

Real Ogre::ParticleSystem::getSpeedFactor ( void  ) const
inline

Gets the 'speed factor' on this particle system.

Definition at line 403 of file OgreParticleSystem.h.

UserObjectBindings& Ogre::MovableObject::getUserObjectBindings ( )
inlineinherited

Return an instance of user objects binding associated with this class.

You can use it to associate one or more custom objects with this class instance.

See also
UserObjectBindings::setUserAny.

Definition at line 344 of file OgreMovableObject.h.

const UserObjectBindings& Ogre::MovableObject::getUserObjectBindings ( ) const
inlineinherited

Return an instance of user objects binding associated with this class.

You can use it to associate one or more custom objects with this class instance.

See also
UserObjectBindings::setUserAny.

Definition at line 350 of file OgreMovableObject.h.

uint32 Ogre::MovableObject::getVisibilityFlags ( void  ) const
inlineinherited

Returns the visibility flags relevant for this object.

Reserved visibility flags are not returned.

bool Ogre::MovableObject::getVisible ( void  ) const
inlineinherited

Gets this object whether to be visible or not, if it has a renderable component.

Remarks
Returns the value set by MovableObject::setVisible only.
Aabb Ogre::MovableObject::getWorldAabb ( ) const
inherited

Gets the axis aligned box in world space.

Remarks
Assumes the caches are already updated. Will trigger an assert otherwise. getWorldAabbUpdated if you need the update process to be guaranteed
Aabb Ogre::MovableObject::getWorldAabbUpdated ( )
inherited

Gets the axis aligned box in world space.

Remarks
Unlike getWorldAabb, this function guarantees the cache stays up to date. It is STRONGLY advised against calling this function for a large number of MovableObject. Refactor your queries so that they happen after SceneManager::updateAllBounds() has been called
float Ogre::MovableObject::getWorldRadius ( ) const
inherited

Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ).

Remarks
Assumes the caches are already updated. Will trigger an assert otherwise. getWorldRadiusUpdated if you need the update process to be guaranteed
float Ogre::MovableObject::getWorldRadiusUpdated ( )
inherited

Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ).

Remarks
Unlike getWorldRadius, this function guarantees the cache stays up to date. It is STRONGLY advised against calling this function for a large number of MovableObject. Refactor your queries so that they happen after SceneManager::updateAllBounds() has been called
void Ogre::ParticleSystem::increaseEmittedEmitterPool ( size_t  size)
protected

Resize the internal pool of emitted emitters.

Remarks
The pool consists of multiple vectors containing pointers to particle emitters. Increasing the pool with size implies that the vectors are equally increased. The quota of emitted emitters is defined on a particle system level and not on a particle emitter level. This is to prevent that the number of created emitters becomes too high; the quota is shared amongst the emitted emitters.
void Ogre::ParticleSystem::increasePool ( size_t  size)
protected

Resize the internal pool of particles.

virtual void Ogre::AnimableObject::initialiseAnimableDictionary ( StringVector ) const
inlineprotectedvirtualinherited

Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters.

Definition at line 283 of file OgreAnimable.h.

void Ogre::ParticleSystem::initialiseEmittedEmitterPool ( void  )
protected

Determine which emitters in the Particle Systems main emitter become a template for creating an pool of emitters that can be emitted.

void Ogre::ParticleSystem::initialiseEmittedEmitters ( void  )
protected

Create a pool of emitted emitters and assign them to the free emitter list.

Remarks
The emitters in the pool are grouped by name. This name is the name of the base emitter in the main list with particle emitters, which forms the template of the created emitted emitters.
void Ogre::ParticleSystem::initParameters ( void  )
protected

Internal method for initialising string interface.

virtual void Ogre::MovableObject::instanceBatchCullFrustumThreaded ( const Frustum frustum,
const Camera lodCamera,
uint32  combinedVisibilityFlags 
)
inlinevirtualinherited

InstancingTheadedCullingMethod,

See also
InstanceBatch::instanceBatchCullFrustumThreaded

Reimplemented in Ogre::InstanceBatchHW_VTF, and Ogre::InstanceBatchHW.

Definition at line 250 of file OgreMovableObject.h.

bool Ogre::MovableObject::isAttached ( void  ) const
inlineinherited

Returns true if this object is attached to a Node.

Definition at line 181 of file OgreMovableObject.h.

bool Ogre::MovableObject::isCachedAabbOutOfDate ( ) const
inlineinherited

Definition at line 587 of file OgreMovableObject.h.

virtual bool Ogre::MovableObject::isDebugDisplayEnabled ( void  ) const
inlinevirtualinherited

Gets whether debug display of this object is enabled.

Definition at line 582 of file OgreMovableObject.h.

bool Ogre::MovableObject::isStatic ( ) const
inherited

Checks whether this MovableObject is static. setStatic.

bool Ogre::MovableObject::isVisible ( void  ) const
inherited

Returns whether or not this object is supposed to be visible or not.

Remarks
Takes into account visibility flags and the setVisible, but not rendering distance.
template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

bool Ogre::IdObject::operator() ( const IdObject left,
const IdObject right 
)
inlineinherited

Definition at line 76 of file OgreId.h.

References Ogre::IdObject::mId.

bool Ogre::IdObject::operator() ( const IdObject left,
const IdObject right 
)
inlineinherited

Definition at line 81 of file OgreId.h.

References Ogre::IdObject::mId.

ParticleSystem& Ogre::ParticleSystem::operator= ( const ParticleSystem rhs)

Assignment operator for copying.

Remarks
This operator deep copies all particle emitters and effectors, but not particles. The system's name is also not copied.
const LightList& Ogre::MovableObject::queryLights ( void  ) const
inlineinherited

Gets a list of lights, ordered relative to how close they are to this movable object.

Remarks
The lights are filled in
See also
buildLightList
Returns
The list of lights use to lighting this object.

Definition at line 513 of file OgreMovableObject.h.

void Ogre::ParticleSystem::removeAffector ( unsigned short  index)

Removes an affector from the system.

Remarks
Drops the affector with the index specified from this system. You should check how many affectors are registered against this system before calling this method with an arbitrary index using getNumAffectors.
Parameters
indexZero-based index of the affector to retrieve.
void Ogre::ParticleSystem::removeAllAffectors ( void  )

Removes all the affectors from this system.

void Ogre::ParticleSystem::removeAllEmittedEmitters ( void  )
protected

Removes all emitted emitters from this system.

void Ogre::ParticleSystem::removeAllEmitters ( void  )

Removes all the emitters from this system.

void Ogre::ParticleSystem::removeEmitter ( unsigned short  index)

Removes an emitter from the system.

Remarks
Drops the emitter with the index specified from this system. You should check how many emitters are registered against this system before calling this method with an arbitrary index using getNumEmitters.
Parameters
indexZero-based index of the emitter to retrieve.
void Ogre::ParticleSystem::removeFromActiveEmittedEmitters ( ParticleEmitter emitter)
protected

Removes an emitter from the active emitted emitter list.

Remarks
The emitter will not be destroyed!
Parameters
emitterPointer to a particle emitter.
void Ogre::MovableObject::removeQueryFlags ( uint32  flags)
inlineinherited

As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.

void Ogre::MovableObject::removeVisibilityFlags ( uint32  flags)
inlineinherited

As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object.

void Ogre::ParticleSystem::setBoundsAutoUpdated ( bool  autoUpdate,
Real  stopIn = 0.0f 
)

Sets whether the bounds will be automatically updated for the life of the particle system.

Remarks
If you have a stationary particle system, it would be a good idea to call this method and set the value to 'false', since the maximum bounds of the particle system will eventually be static. If you do this, you can either set the bounds manually using the setBounds() method, or set the second parameter of this method to a positive number of seconds, so that the bounds are calculated for a few seconds and then frozen.
Parameters
autoUpdateIf true (the default), the particle system will update it's bounds every frame. If false, the bounds update will cease after the 'stopIn' number of seconds have passed.
stopInOnly applicable if the first parameter is true, this is the number of seconds after which the automatic update will cease.
void Ogre::MovableObject::setCastShadows ( bool  enabled)
inlineinherited

Sets whether or not this object will cast shadows.

Remarks
This setting simply allows you to turn on/off shadows for a given object. An object will not cast shadows unless the scene supports it in any case (see SceneManager::setShadowTechnique), and also the material which is in use must also have shadow casting enabled. By default all entities cast shadows. If, however, for some reason you wish to disable this for a single object then you can do so using this method.
Note
This method normally refers to objects which block the light, but since Light is also a subclass of MovableObject, in that context it means whether the light causes shadows itself.
virtual void Ogre::ParticleSystem::setCullIndividually ( bool  cullIndividual)
virtual

Sets whether culling tests particles in this individually as well as in a group.

Remarks
Particle sets are always culled as a whole group, based on a bounding box which encloses all particles in the set. For fairly localised sets, this is enough. However, you can optionally tell the set to also cull individual particles in the set, i.e. to test each individual particle before rendering. The default is not to do this.
This is useful when you have a large, fairly distributed set of particles, like maybe trees on a landscape. You probably still want to group them into more than one set (maybe one set per section of landscape), which will be culled coarsely, but you also want to cull the particles individually because they are spread out. Whilst you could have lots of single-tree sets which are culled separately, this would be inefficient to render because each tree would be issued as it's own rendering operation.
By calling this method with a parameter of true, you can have large particle sets which are spaced out and so get the benefit of batch rendering and coarse culling, but also have fine-grained culling so unnecessary rendering is avoided.
Parameters
cullIndividualIf true, each particle is tested before being sent to the pipeline as well as the whole set having to pass the coarse group bounding test.
virtual void Ogre::MovableObject::setDebugDisplayEnabled ( bool  enabled)
inlinevirtualinherited

Sets whether or not the debug display of this object is enabled.

Remarks
Some objects aren't visible themselves but it can be useful to display a debug representation of them. Or, objects may have an additional debug display on top of their regular display. This option enables / disables that debug display. Objects that are not visible never display debug geometry regardless of this setting.

Definition at line 580 of file OgreMovableObject.h.

virtual void Ogre::ParticleSystem::setDefaultDimensions ( Real  width,
Real  height 
)
virtual

Sets the default dimensions of the particles in this set.

Remarks
All particles in a set are created with these default dimensions. The set will render most efficiently if all the particles in the set are the default size. It is possible to alter the size of individual particles at the expense of extra calculation. See the Particle class for more info.
Parameters
widthThe new default width for the particles in this set.
heightThe new default height for the particles in this set.
virtual void Ogre::ParticleSystem::setDefaultHeight ( Real  height)
virtual

See setDefaultDimensions - this sets 1 component individually.

static void Ogre::ParticleSystem::setDefaultIterationInterval ( Real  iterationInterval)
inlinestatic

Set the default iteration interval for all ParticleSystem instances.

Definition at line 428 of file OgreParticleSystem.h.

static void Ogre::ParticleSystem::setDefaultNonVisibleUpdateTimeout ( Real  timeout)
inlinestatic

Set the default nonvisible timeout for all ParticleSystem instances.

Definition at line 456 of file OgreParticleSystem.h.

static void Ogre::MovableObject::setDefaultQueryFlags ( uint32  flags)
inlinestaticinherited

Set the default query flags for all future MovableObject instances.

Definition at line 460 of file OgreMovableObject.h.

static void Ogre::MovableObject::setDefaultVisibilityFlags ( uint32  flags)
inlinestaticinherited

Set the default visibility flags for all future MovableObject instances.

virtual void Ogre::ParticleSystem::setDefaultWidth ( Real  width)
virtual

See setDefaultDimensions - this sets 1 component individually.

void Ogre::ParticleSystem::setEmittedEmitterQuota ( size_t  quota)

Sets the maximum number of emitted emitters this system is allowed to have active at once.

Remarks
Particle systems can have - besides a particle quota - also an emitted emitter quota.
Parameters
quotaThe maximum number of emitted emitters this system is allowed to have.
void Ogre::ParticleSystem::setEmitting ( bool  v)

This is used to turn on or off particle emission for this system.

Remarks
By default particle system is always emitting particles (if a emitters exists) and this can be used to stop the emission for all emitters. To turn it on again, call it passing true.

Note that this does not detach the particle system from the scene node, it will still use some CPU.

void Ogre::ParticleSystem::setIterationInterval ( Real  iterationInterval)

Sets a 'iteration interval' on this particle system.

Remarks
The default Particle system update interval, based on elapsed frame time, will cause different behavior between low frame-rate and high frame-rate. By using this option, you can make the particle system update at a fixed interval, keeping the behavior the same no matter what frame-rate is.
When iteration interval is set to zero, it means the update occurs based on an elapsed frame time, otherwise each iteration will take place at the given interval, repeating until it has used up all the elapsed frame time.
Parameters
iterationIntervalThe iteration interval, default to zero.
void Ogre::ParticleSystem::setKeepParticlesInLocalSpace ( bool  keepLocal)

Sets whether particles (and any affector effects) remain relative to the node the particle system is attached to.

Remarks
By default particles are in world space once emitted, so they are not affected by movement in the parent node of the particle system. This makes the most sense when dealing with completely independent particles, but if you want to constrain them to follow local motion too, you can set this to true.
void Ogre::MovableObject::setLightMask ( uint32  lightMask)
inlineinherited

Set a bitwise mask which will filter the lights affecting this object.

Remarks
This mask will be compared against the mask held against Light to determine if a light should affect a given object. By default, this mask is fully set meaning all lights will affect this object
void Ogre::MovableObject::setListener ( Listener listener)
inlineinherited

Sets a listener for this object.

Remarks
Note for size and performance reasons only one listener per object is allowed.

Definition at line 502 of file OgreMovableObject.h.

void Ogre::MovableObject::setLocalAabb ( const Aabb  box)
inherited

Sets the local axis-aligned bounding box for this object.

Remarks
This bounding box is in local coordinates.
virtual void Ogre::ParticleSystem::setMaterialName ( const String name,
const String groupName = ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME 
)
virtual

Sets the name of the material to be used for this billboard set.

Parameters
nameThe new name of the material to use for this set.
void Ogre::MovableObject::setName ( const String name)
inlineinherited

Sets a custom name for this node.

Doesn't have to be unique

Definition at line 163 of file OgreMovableObject.h.

void Ogre::ParticleSystem::setNonVisibleUpdateTimeout ( Real  timeout)

Sets when the particle system should stop updating after it hasn't been visible for a while.

Remarks
By default, visible particle systems update all the time, even when not in view. This means that they are guaranteed to be consistent when they do enter view. However, this comes at a cost, updating particle systems can be expensive, especially if they are perpetual.
This option lets you set a 'timeout' on the particle system, so that if it isn't visible for this amount of time, it will stop updating until it is next visible.
Parameters
timeoutThe time after which the particle system will be disabled if it is no longer visible. 0 to disable the timeout and always update.
virtual bool Ogre::StringInterface::setParameter ( const String name,
const String value 
)
virtualinherited

Generic parameter setting method.

Remarks
Call this method with the name of a parameter and a string version of the value to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.
Parameters
nameThe name of the parameter to set
valueString value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information.
Returns
true if set was successful, false otherwise (NB no exceptions thrown - tolerant method)

Referenced by Ogre::StringInterface::copyParametersTo().

virtual void Ogre::StringInterface::setParameterList ( const NameValuePairList paramList)
virtualinherited

Generic multiple parameter setting method.

Remarks
Call this method with a list of name / value pairs to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.
Parameters
paramListName/value pair list
void Ogre::ParticleSystem::setParticleQuota ( size_t  quota)

Sets the maximum number of particles this system is allowed to have active at once.

Remarks
Particle systems all have a particle quota, i.e. a maximum number of particles they are allowed to have active at a time. This allows the application to set a keep particle systems under control should they be affected by complex parameters which alter their emission rates etc. If a particle system reaches it's particle quota, none of the emitters will be able to emit any more particles. As existing particles die, the spare capacity will be allocated equally across all emitters to be as consistent to the original particle system style as possible. The quota can be increased but not decreased after the system has been created.
Parameters
quotaThe maximum number of particles this system is allowed to have.
void Ogre::MovableObject::setQueryFlags ( uint32  flags)
inlineinherited

Sets the query flags for this object.

Remarks
When performing a scene query, this object will be included or excluded according to flags on the object and flags on the query. This is a bitwise value, so only when a bit on these flags is set, will it be included in a query asking for that flag. The meaning of the bits is application-specific.
void Ogre::ParticleSystem::setRenderer ( const String typeName)

Sets the ParticleRenderer to be used to render this particle system.

Remarks
The main ParticleSystem just manages the creation and movement of particles; they are rendered using functions in ParticleRenderer and the ParticleVisual instances they create.
Parameters
typeNameString identifying the type of renderer to use; a new instance of this type will be created; a factory must have been registered with ParticleSystemManager.
void Ogre::MovableObject::setRenderingDistance ( Real  dist)
inlineinherited

Sets the distance at which the object is no longer rendered.

Parameters
distDistance beyond which the object will not be rendered (the default is FLT_MAX, which means objects are always rendered). Values equal or below zero will be ignored, and cause an assertion in debug mode.
void Ogre::MovableObject::setRenderingMinPixelSize ( Real  pixelSize)
inlineinherited

Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered.

Note
Camera::setUseMinPixelSize() needs to be called for this parameter to be used.
Parameters
pixelSizeNumber of minimum pixels (the default is 0, which means objects are always rendered).

Definition at line 331 of file OgreMovableObject.h.

void Ogre::ParticleSystem::setRenderQueueGroup ( uint8  queueID)
virtual

Sets the render queue group this entity will be rendered through.

Remarks
Render queues are grouped to allow you to more tightly control the ordering of rendered objects. If you do not call this method, all Entity objects default to the default queue (RenderQueue::getDefaultQueueGroup), which is fine for most objects. You may want to alter this if you want this entity to always appear in front of other objects, e.g. for a 3D menu system or such.
See RenderQueue for more details.
Parameters
queueIDEnumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here.

Reimplemented from Ogre::MovableObject.

void Ogre::ParticleSystem::setRenderQueueGroupAndPriority ( uint8  queueID,
ushort  priority 
)
virtual

Sets the render queue group and group priority this entity will be rendered through.

Remarks
Render queues are grouped to allow you to more tightly control the ordering of rendered objects. Within a single render group there another type of grouping called priority which allows further control. If you do not call this method, all Entity objects default to the default queue and priority (RenderQueue::getDefaultQueueGroup, RenderQueue::getDefaultRenderablePriority), which is fine for most objects. You may want to alter this if you want this entity to always appear in front of other objects, e.g. for a 3D menu system or such.
See RenderQueue for more details.
Parameters
queueIDEnumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here.
priorityThe priority within a group to use.

Reimplemented from Ogre::MovableObject.

void Ogre::ParticleSystem::setSortingEnabled ( bool  enabled)
inline

Set whether or not particles are sorted according to the camera.

Remarks
Enabling sorting alters the order particles are sent to the renderer. When enabled, particles are sent to the renderer in order of furthest distance from the camera.

Definition at line 540 of file OgreParticleSystem.h.

void Ogre::ParticleSystem::setSpeedFactor ( Real  speedFactor)
inline

Sets a 'speed factor' on this particle system, which means it scales the elapsed real time which has passed by this factor before passing it to the emitters, affectors, and the particle life calculation.

Remarks
An interesting side effect - if you want to create a completely manual particle system where you control the emission and life of particles yourself, you can set the speed factor to 0.0f, thus disabling normal particle emission, alteration, and death.

Definition at line 399 of file OgreParticleSystem.h.

bool Ogre::MovableObject::setStatic ( bool  bStatic)
inherited

Turns this Node into static or dynamic.

Remarks
Switching between dynamic and static has some overhead and forces to update all static scene when converted to static. So don't do it frequently. Static objects are not updated every frame, only when requested explicitly. Use this feature if you plan to have this object unaltered for a very long times
Note all MovableObjects support switching between static & dynamic after they have been created (eg. InstancedEntity)
Changing this attribute will cause to switch the attribute to our parent node, and as a result, all of its other attached entities. Node::setStatic
Returns
True if setStatic made an actual change. False otherwise. Can fail because the object was already static/dynamic, or because switching is not supported
void Ogre::MovableObject::setVisibilityFlags ( uint32  flags)
inlineinherited

Sets the visibility flags for this object.

Remarks
As well as a simple true/false value for visibility (as seen in setVisible), you can also set visibility flags that is applied a binary 'and' with the SceneManager's mask and a compositor node pass. To exclude particular objects from rendering. Changes to reserved visibility flags are ignored (won't take effect).
void Ogre::MovableObject::setVisible ( bool  visible)
inlineinherited

Tells this object whether to be visible or not, if it has a renderable component.

Note
An alternative approach of making an object invisible is to detach it from it's SceneNode, or to remove the SceneNode entirely. Detaching a node means that structurally the scene graph changes. Once this change has taken place, the objects / nodes that have been removed have less overhead to the visibility detection pass than simply making the object invisible, so if you do this and leave the objects out of the tree for a long time, it's faster. However, the act of detaching / reattaching nodes is in itself more expensive than setting an object visibility flag, since in the latter case structural changes are not made. Therefore, small or frequent visibility changes are best done using this method; large or more longer term changes are best done by detaching.
static void Ogre::MovableObject::updateAllBounds ( const size_t  numNodes,
ObjectData  t 
)
staticinherited

SceneManager::updateAllBounds

Remarks
We don't pass by reference on purpose (avoid implicit aliasing)
Aabb Ogre::MovableObject::updateSingleWorldAabb ( )
protectedinherited
float Ogre::MovableObject::updateSingleWorldRadius ( )
protectedinherited
void Ogre::ParticleSystem::visitRenderables ( Renderable::Visitor visitor,
bool  debugRenderables = false 
)
virtual

Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject will add to the render queue when asked, if any.

Parameters
visitorPointer to a class implementing the Renderable::Visitor interface which will be called back for each Renderable which will be queued. Bear in mind that the state of the Renderable instances may not be finalised depending on when you call this.
debugRenderablesIf false, only regular renderables will be visited (those for normal display). If true, debug renderables will be included too.

Implements Ogre::MovableObject.

Member Data Documentation

const FastArray<Real> Ogre::MovableObject::c_DefaultLodMesh
inherited

Definition at line 65 of file OgreMovableObject.h.

ActiveEmittedEmitterList Ogre::ParticleSystem::mActiveEmittedEmitters
protected

Active emitted emitter list.

Remarks
This is a linked list of pointers to emitters in the emitted emitter pool. Emitters that are used are stored (their pointers) in both the list with active particles and in the list with active emitted emitters.

Definition at line 747 of file OgreParticleSystem.h.

ActiveParticleList Ogre::ParticleSystem::mActiveParticles
protected

Active particle list.

Remarks
This is a linked list of pointers to particles in the particle pool.
This allows very fast insertions and deletions from anywhere in the list to activate / deactivate particles as well as reuse of Particle instances in the pool without construction & destruction which avoids memory thrashing.

Definition at line 701 of file OgreParticleSystem.h.

ParticleAffectorList Ogre::ParticleSystem::mAffectors
protected

List of particle affectors, ie modifiers of particles.

Definition at line 755 of file OgreParticleSystem.h.

bool Ogre::ParticleSystem::mBoundsAutoUpdate
protected

Definition at line 625 of file OgreParticleSystem.h.

Real Ogre::ParticleSystem::mBoundsUpdateTime
protected

Definition at line 626 of file OgreParticleSystem.h.

bool Ogre::MovableObject::mCachedAabbOutOfDate
mutableprotectedinherited

Definition at line 117 of file OgreMovableObject.h.

bool Ogre::ParticleSystem::mCullIndividual
protected

Do we cull each particle individually?

Definition at line 761 of file OgreParticleSystem.h.

FastArray<unsigned char> Ogre::MovableObject::mCurrentMaterialLod
protectedinherited

Definition at line 97 of file OgreMovableObject.h.

unsigned char Ogre::MovableObject::mCurrentMeshLod
protectedinherited

Definition at line 96 of file OgreMovableObject.h.

bool Ogre::MovableObject::mDebugDisplay
protectedinherited

Is debug display enabled?

Definition at line 111 of file OgreMovableObject.h.

Real Ogre::ParticleSystem::mDefaultHeight
protected

Default height of each particle.

Definition at line 640 of file OgreParticleSystem.h.

Real Ogre::ParticleSystem::mDefaultWidth
protected

Default width of each particle.

Definition at line 638 of file OgreParticleSystem.h.

EmittedEmitterPool Ogre::ParticleSystem::mEmittedEmitterPool
protected

Pool of emitted emitters for use and reuse in the active emitted emitter list.

Remarks
The emitters in this pool act as particles and as emitters. The pool is a map containing lists of emitters, identified by their name.
The emitters in this pool are cloned using emitters that are kept in the main emitter list of the ParticleSystem.

Definition at line 734 of file OgreParticleSystem.h.

bool Ogre::ParticleSystem::mEmittedEmitterPoolInitialised
protected

Indication whether the emitted emitter pool (= pool with particle emitters that are emitted) is initialised.

Definition at line 662 of file OgreParticleSystem.h.

size_t Ogre::ParticleSystem::mEmittedEmitterPoolSize
protected

The number of emitted emitters in the pool.

Definition at line 770 of file OgreParticleSystem.h.

ParticleEmitterList Ogre::ParticleSystem::mEmitters
protected

List of particle emitters, ie sources of particles.

Definition at line 753 of file OgreParticleSystem.h.

FreeEmittedEmitterMap Ogre::ParticleSystem::mFreeEmittedEmitters
protected

Free emitted emitter list.

Remarks
This contains a list of the emitters free for use as new instances as required by the set.

Definition at line 740 of file OgreParticleSystem.h.

FreeParticleList Ogre::ParticleSystem::mFreeParticles
protected

Free particle queue.

Remarks
This contains a list of the particles free for use as new instances as required by the set. Particle instances are preconstructed up to the estimated size in the mParticlePool vector and are referenced on this deque at startup. As they get used this list reduces, as they get released back to to the set they get added back to the list.

Definition at line 712 of file OgreParticleSystem.h.

size_t Ogre::MovableObject::mGlobalIndex
inherited

Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks).

Used for O(1) removals.

Remarks
It is the parent (or our creator) the one that sets this value, not ourselves. Do NOT modify it manually.

Definition at line 140 of file OgreMovableObject.h.

bool Ogre::ParticleSystem::mIsEmitting
protected

Used to control if the particle system should emit particles or not.

Definition at line 664 of file OgreParticleSystem.h.

bool Ogre::ParticleSystem::mIsRendererConfigured
protected

Have we set the material etc on the renderer?

Definition at line 634 of file OgreParticleSystem.h.

Real Ogre::ParticleSystem::mIterationInterval
protected

Iteration interval.

Definition at line 644 of file OgreParticleSystem.h.

bool Ogre::ParticleSystem::mIterationIntervalSet
protected

Iteration interval set? Otherwise track default.

Definition at line 646 of file OgreParticleSystem.h.

unsigned long Ogre::ParticleSystem::mLastVisibleFrame
protected

Last frame in which known to be visible.

Definition at line 658 of file OgreParticleSystem.h.

LightList Ogre::MovableObject::mLightList
protectedinherited

List of lights for this object.

Definition at line 108 of file OgreMovableObject.h.

Listener* Ogre::MovableObject::mListener
protectedinherited

MovableObject listener - only one allowed (no list) for size & performance reasons.

Definition at line 105 of file OgreMovableObject.h.

bool Ogre::ParticleSystem::mLocalSpace
protected

Particles in local space?

Definition at line 650 of file OgreParticleSystem.h.

FastArray< FastArray<Real> const * > Ogre::MovableObject::mLodMaterial
protectedinherited

Definition at line 95 of file OgreMovableObject.h.

FastArray<Real> const* Ogre::MovableObject::mLodMesh
protectedinherited

Definition at line 94 of file OgreMovableObject.h.

SceneManager* Ogre::MovableObject::mManager
protectedinherited

SceneManager holding this object (if applicable)

Definition at line 91 of file OgreMovableObject.h.

MaterialPtr Ogre::ParticleSystem::mMaterial
protected

Pointer to the material to use.

Definition at line 636 of file OgreParticleSystem.h.

String Ogre::ParticleSystem::mMaterialName
protected

Name of the material to use.

Definition at line 632 of file OgreParticleSystem.h.

Real Ogre::MovableObject::mMinPixelSize
protectedinherited

Minimum pixel size to still render.

Definition at line 100 of file OgreMovableObject.h.

String Ogre::MovableObject::mName
protectedinherited

Friendly name of this object, can be empty.

Definition at line 121 of file OgreMovableObject.h.

Real Ogre::ParticleSystem::mNonvisibleTimeout
protected

Update timeout when nonvisible (0 for no timeout)

Definition at line 652 of file OgreParticleSystem.h.

bool Ogre::ParticleSystem::mNonvisibleTimeoutSet
protected

Update timeout when nonvisible set? Otherwise track default.

Definition at line 654 of file OgreParticleSystem.h.

ObjectData Ogre::MovableObject::mObjectData
protectedinherited

All the object data needed in SoA form.

Definition at line 89 of file OgreMovableObject.h.

ObjectMemoryManager* Ogre::MovableObject::mObjectMemoryManager
protectedinherited

The memory manager used to allocate the ObjectData.

Definition at line 114 of file OgreMovableObject.h.

String Ogre::ParticleSystem::mOrigin
protected

Optional origin of this particle system (eg script name)

Definition at line 773 of file OgreParticleSystem.h.

size_t Ogre::MovableObject::mParentIndex
inherited

Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks).

Used for O(1) removals.

Remarks
It is the parent (or our creator) the one that sets this value, not ourselves. Do NOT modify it manually.

Definition at line 142 of file OgreMovableObject.h.

Node* Ogre::MovableObject::mParentNode
protectedinherited

Node to which this object is attached.

Definition at line 83 of file OgreMovableObject.h.

ParticlePool Ogre::ParticleSystem::mParticlePool
protected

Pool of particle instances for use and reuse in the active particle list.

Remarks
This vector will be preallocated with the estimated size of the set,and will extend as required.

Definition at line 718 of file OgreParticleSystem.h.

size_t Ogre::ParticleSystem::mPoolSize
protected

The number of particles in the pool.

Definition at line 767 of file OgreParticleSystem.h.

RadixSort<ActiveParticleList, Particle*, float> Ogre::ParticleSystem::mRadixSorter
staticprotected

Definition at line 690 of file OgreParticleSystem.h.

ParticleSystemRenderer* Ogre::ParticleSystem::mRenderer
protected

The renderer used to render this particle system.

Definition at line 758 of file OgreParticleSystem.h.

String Ogre::ParticleSystem::mRendererType
protected

The name of the type of renderer used to render this system.

Definition at line 764 of file OgreParticleSystem.h.

uint8 Ogre::MovableObject::mRenderQueueID
protectedinherited

The render queue to use when rendering this object.

Definition at line 85 of file OgreMovableObject.h.

ushort Ogre::MovableObject::mRenderQueuePriority
protectedinherited

The render queue group to use when rendering this object.

Definition at line 87 of file OgreMovableObject.h.

String Ogre::ParticleSystem::mResourceGroupName
protected

Name of the resource group to use to load materials.

Definition at line 630 of file OgreParticleSystem.h.

AnimableDictionaryMap Ogre::AnimableObject::msAnimableDictionary
staticprotectedinherited

Static map of class name to list of animable value names.

Definition at line 239 of file OgreAnimable.h.

CmdCull Ogre::ParticleSystem::msCullCmd
staticprotected

Command objects.

Definition at line 613 of file OgreParticleSystem.h.

Real Ogre::ParticleSystem::msDefaultIterationInterval
staticprotected

Default iteration interval.

Definition at line 776 of file OgreParticleSystem.h.

Real Ogre::ParticleSystem::msDefaultNonvisibleTimeout
staticprotected

Default nonvisible update timeout.

Definition at line 778 of file OgreParticleSystem.h.

uint32 Ogre::MovableObject::msDefaultQueryFlags
staticprotectedinherited

Default query flags.

Definition at line 125 of file OgreMovableObject.h.

uint32 Ogre::MovableObject::msDefaultVisibilityFlags
staticprotectedinherited

Default visibility flags.

Definition at line 127 of file OgreMovableObject.h.

CmdEmittedEmitterQuota Ogre::ParticleSystem::msEmittedEmitterQuotaCmd
staticprotected

Definition at line 617 of file OgreParticleSystem.h.

CmdHeight Ogre::ParticleSystem::msHeightCmd
staticprotected

Definition at line 614 of file OgreParticleSystem.h.

CmdIterationInterval Ogre::ParticleSystem::msIterationIntervalCmd
staticprotected

Definition at line 622 of file OgreParticleSystem.h.

CmdLocalSpace Ogre::ParticleSystem::msLocalSpaceCmd
staticprotected

Definition at line 621 of file OgreParticleSystem.h.

CmdMaterial Ogre::ParticleSystem::msMaterialCmd
staticprotected

Definition at line 615 of file OgreParticleSystem.h.

CmdNonvisibleTimeout Ogre::ParticleSystem::msNonvisibleTimeoutCmd
staticprotected

Definition at line 623 of file OgreParticleSystem.h.

bool Ogre::ParticleSystem::mSorted
protected

Particles sorted according to camera?

Definition at line 648 of file OgreParticleSystem.h.

Real Ogre::ParticleSystem::mSpeedFactor
protected

Speed factor.

Definition at line 642 of file OgreParticleSystem.h.

CmdQuota Ogre::ParticleSystem::msQuotaCmd
staticprotected

Definition at line 616 of file OgreParticleSystem.h.

CmdRenderer Ogre::ParticleSystem::msRendererCmd
staticprotected

Definition at line 619 of file OgreParticleSystem.h.

CmdSorted Ogre::ParticleSystem::msSortedCmd
staticprotected

Definition at line 620 of file OgreParticleSystem.h.

CmdWidth Ogre::ParticleSystem::msWidthCmd
staticprotected

Definition at line 618 of file OgreParticleSystem.h.

Controller<Real>* Ogre::ParticleSystem::mTimeController
protected

Controller for time update.

Definition at line 660 of file OgreParticleSystem.h.

Real Ogre::ParticleSystem::mTimeSinceLastVisible
protected

Amount of time non-visible so far.

Definition at line 656 of file OgreParticleSystem.h.

Real Ogre::ParticleSystem::mUpdateRemainTime
protected

Definition at line 627 of file OgreParticleSystem.h.

UserObjectBindings Ogre::MovableObject::mUserObjectBindings
protectedinherited

User objects binding.

Definition at line 102 of file OgreMovableObject.h.


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