Urho3D::ParticleEmitter Class Reference

Particle emitter component. More...

#include <ParticleEmitter.h>

Inheritance diagram for Urho3D::ParticleEmitter:

Collaboration diagram for Urho3D::ParticleEmitter:

Public Member Functions
	ParticleEmitter (Context *context)
	Construct.
virtual	~ParticleEmitter ()
	Destruct.
virtual void	OnSetEnabled ()
	Handle enabled/disabled state change.
virtual void	Update (const FrameInfo &frame)
	Update before octree reinsertion. Is called from a worker thread.
void	SetEffect (ParticleEffect *effect)
	Set particle effect.
void	SetNumParticles (unsigned num)
	Set maximum number of particles.
void	SetEmitting (bool enable)
	Set whether should be emitting. If the state was changed, also resets the emission period timer.
void	SetSerializeParticles (bool enable)
	Set whether particles should be serialized. Default true, set false to reduce scene file size.
void	ResetEmissionTimer ()
	Reset the emission period timer.
void	RemoveAllParticles ()
	Remove all current particles.
void	Reset ()
	Reset the particle emitter completely. Removes current particles, sets emitting state on, and resets the emission timer.
void	ApplyEffect ()
	Apply not continuously updated values such as the material, the number of particles and sorting mode from the particle effect. Call this if you change the effect programmatically.
ParticleEffect *	GetEffect () const
	Return particle effect.
unsigned	GetNumParticles () const
	Return maximum number of particles.
bool	IsEmitting () const
	Return whether is currently emitting.
bool	GetSerializeParticles () const
	Return whether particles are to be serialized.
void	SetEffectAttr (const ResourceRef &value)
	Set particles effect attribute.
ResourceRef	GetEffectAttr () const
	Set particles effect attribute.
void	SetParticlesAttr (const VariantVector &value)
	Set particles attribute.
VariantVector	GetParticlesAttr () const
	Return particles attribute. Returns particle amount only if particles are not to be serialized.
VariantVector	GetParticleBillboardsAttr () const
	Return billboards attribute. Returns billboard amount only if particles are not to be serialized.
Public Member Functions inherited from Urho3D::BillboardSet
	BillboardSet (Context *context)
	Construct.
virtual	~BillboardSet ()
	Destruct.
virtual void	ProcessRayQuery (const RayOctreeQuery &query, PODVector< RayQueryResult > &results)
	Process octree raycast. May be called from a worker thread.
virtual void	UpdateBatches (const FrameInfo &frame)
	Calculate distance and prepare batches for rendering. May be called from worker thread(s), possibly re-entrantly.
virtual void	UpdateGeometry (const FrameInfo &frame)
	Prepare geometry for rendering. Called from a worker thread if possible (no GPU update.)
virtual UpdateGeometryType	GetUpdateGeometryType ()
	Return whether a geometry update is necessary, and if it can happen in a worker thread.
void	SetMaterial (Material *material)
	Set material.
void	SetNumBillboards (unsigned num)
	Set number of billboards.
void	SetRelative (bool enable)
	Set whether billboards are relative to the scene node. Default true.
void	SetScaled (bool enable)
	Set whether scene node scale affects billboards' size. Default true.
void	SetSorted (bool enable)
	Set whether billboards are sorted by distance. Default false.
void	SetFaceCameraMode (FaceCameraMode mode)
	Set how the billboards should rotate in relation to the camera. Default is to follow camera rotation on all axes (FC_ROTATE_XYZ.)
void	SetAnimationLodBias (float bias)
	Set animation LOD bias.
void	Commit ()
	Mark for bounding box and vertex buffer update. Call after modifying the billboards.
Material *	GetMaterial () const
	Return material.
unsigned	GetNumBillboards () const
	Return number of billboards.
PODVector< Billboard > &	GetBillboards ()
	Return all billboards.
Billboard *	GetBillboard (unsigned index)
	Return billboard by index.
bool	IsRelative () const
	Return whether billboards are relative to the scene node.
bool	IsScaled () const
	Return whether scene node scale affects billboards' size.
bool	IsSorted () const
	Return whether billboards are sorted.
FaceCameraMode	GetFaceCameraMode () const
	Return how the billboards rotate in relation to the camera.
float	GetAnimationLodBias () const
	Return animation LOD bias.
void	SetMaterialAttr (const ResourceRef &value)
	Set material attribute.
void	SetBillboardsAttr (const VariantVector &value)
	Set billboards attribute.
void	SetNetBillboardsAttr (const PODVector< unsigned char > &value)
	Set billboards attribute for network replication.
ResourceRef	GetMaterialAttr () const
	Return material attribute.
VariantVector	GetBillboardsAttr () const
	Return billboards attribute.
const PODVector< unsigned char > &	GetNetBillboardsAttr () const
	Return billboards attribute for network replication.
Public Member Functions inherited from Urho3D::Drawable
	Drawable (Context *context, unsigned char drawableFlags)
	Construct.
virtual	~Drawable ()
	Destruct.
virtual Geometry *	GetLodGeometry (unsigned batchIndex, unsigned level)
	Return the geometry for a specific LOD level.
virtual unsigned	GetNumOccluderTriangles ()
	Return number of occlusion geometry triangles.
virtual bool	DrawOcclusion (OcclusionBuffer *buffer)
	Draw to occlusion buffer. Return true if did not run out of triangles.
virtual void	DrawDebugGeometry (DebugRenderer *debug, bool depthTest)
	Visualize the component as debug geometry.
void	SetDrawDistance (float distance)
	Set draw distance.
void	SetShadowDistance (float distance)
	Set shadow draw distance.
void	SetLodBias (float bias)
	Set LOD bias.
void	SetViewMask (unsigned mask)
	Set view mask. Is and'ed with camera's view mask to see if the object should be rendered.
void	SetLightMask (unsigned mask)
	Set light mask. Is and'ed with light's and zone's light mask to see if the object should be lit.
void	SetShadowMask (unsigned mask)
	Set shadow mask. Is and'ed with light's light mask and zone's shadow mask to see if the object should be rendered to a shadow map.
void	SetZoneMask (unsigned mask)
	Set zone mask. Is and'ed with zone's zone mask to see if the object should belong to the zone.
void	SetMaxLights (unsigned num)
	Set maximum number of per-pixel lights. Default 0 is unlimited.
void	SetCastShadows (bool enable)
	Set shadowcaster flag.
void	SetOccluder (bool enable)
	Set occlusion flag.
void	SetOccludee (bool enable)
	Set occludee flag.
void	MarkForUpdate ()
	Mark for update and octree reinsertion. Update is automatically queued when the drawable's scene node moves or changes scale.
const BoundingBox &	GetBoundingBox () const
	Return local space bounding box. May not be applicable or properly updated on all drawables.
const BoundingBox &	GetWorldBoundingBox ()
	Return world-space bounding box.
unsigned char	GetDrawableFlags () const
	Return drawable flags.
float	GetDrawDistance () const
	Return draw distance.
float	GetShadowDistance () const
	Return shadow draw distance.
float	GetLodBias () const
	Return LOD bias.
unsigned	GetViewMask () const
	Return view mask.
unsigned	GetLightMask () const
	Return light mask.
unsigned	GetShadowMask () const
	Return shadow mask.
unsigned	GetZoneMask () const
	Return zone mask.
unsigned	GetMaxLights () const
	Return maximum number of per-pixel lights.
bool	GetCastShadows () const
	Return shadowcaster flag.
bool	IsOccluder () const
	Return occluder flag.
bool	IsOccludee () const
	Return occludee flag.
bool	IsInView () const
	Return whether is in view this frame from any viewport camera. Excludes shadow map cameras.
bool	IsInView (Camera *camera) const
	Return whether is in view of a specific camera this frame. Pass in a null camera to allow any camera, including shadow map cameras.
const Vector< SourceBatch > &	GetBatches () const
	Return draw call source data.
void	SetZone (Zone *zone, bool temporary=false)
	Set new zone. Zone assignment may optionally be temporary, meaning it needs to be re-evaluated on the next frame.
void	SetSortValue (float value)
	Set sorting value.
void	SetMinMaxZ (float minZ, float maxZ)
	Set view-space depth bounds.
void	MarkInView (const FrameInfo &frame)
	Mark in view. Also clear the light list.
void	MarkInView (unsigned frameNumber)
	Mark in view without specifying a camera. Used for shadow casters.
void	LimitLights ()
	Sort and limit per-pixel lights to maximum allowed. Convert extra lights into vertex lights.
void	LimitVertexLights (bool removeConvertedLights)
	Sort and limit per-vertex lights to maximum allowed.
void	SetBasePass (unsigned batchIndex)
	Set base pass flag for a batch.
Octant *	GetOctant () const
	Return octree octant.
Zone *	GetZone () const
	Return current zone.
bool	IsZoneDirty () const
	Return whether current zone is inconclusive or dirty due to the drawable moving.
float	GetDistance () const
	Return distance from camera.
float	GetLodDistance () const
	Return LOD scaled distance from camera.
float	GetSortValue () const
	Return sorting value.
bool	IsInView (const FrameInfo &frame, bool anyCamera=false) const
	Return whether is in view on the current frame. Called by View.
bool	HasBasePass (unsigned batchIndex) const
	Return whether has a base pass.
const PODVector< Light * > &	GetLights () const
	Return per-pixel lights.
const PODVector< Light * > &	GetVertexLights () const
	Return per-vertex lights.
Light *	GetFirstLight () const
	Return the first added per-pixel light.
float	GetMinZ () const
	Return the minimum view-space depth.
float	GetMaxZ () const
	Return the maximum view-space depth.
void	AddLight (Light *light)
void	AddVertexLight (Light *light)
Public Member Functions inherited from Urho3D::Component
	Component (Context *context)
	Construct.
virtual	~Component ()
	Destruct.
virtual bool	Save (Serializer &dest) const
	Save as binary data. Return true if successful.
virtual bool	SaveXML (XMLElement &dest) const
	Save as XML data. Return true if successful.
virtual void	MarkNetworkUpdate ()
	Mark for attribute check on the next network update.
virtual void	GetDependencyNodes (PODVector< Node * > &dest)
	Return the depended on nodes to order network updates.
void	SetEnabled (bool enable)
	Set enabled/disabled state.
void	Remove ()
	Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.
unsigned	GetID () const
	Return ID.
Node *	GetNode () const
	Return scene node.
Scene *	GetScene () const
	Return the scene the node belongs to.
bool	IsEnabled () const
	Return whether is enabled.
bool	IsEnabledEffective () const
	Return whether is effectively enabled (node is also enabled.)
Component *	GetComponent (StringHash type) const
	Return component in the same scene node by type. If there are several, returns the first.
void	GetComponents (PODVector< Component * > &dest, StringHash type) const
	Return components in the same scene node by type.
template<class T >
T *	GetComponent () const
	Template version of returning a component in the same scene node by type.
template<class T >
void	GetComponents (PODVector< T * > &dest) const
	Template version of returning components in the same scene node by type.
void	AddReplicationState (ComponentReplicationState *state)
	Add a replication state that is tracking this component.
void	PrepareNetworkUpdate ()
	Prepare network update by comparing attributes and marking replication states dirty as necessary.
void	CleanupConnection (Connection *connection)
	Clean up all references to a network connection that is about to be removed.
Public Member Functions inherited from Urho3D::Animatable
	Animatable (Context *context)
	Construct.
virtual	~Animatable ()
	Destruct.
virtual bool	LoadXML (const XMLElement &source, bool setInstanceDefault=false)
	Load from XML data. When setInstanceDefault is set to true, after setting the attribute value, store the value as instance's default value. Return true if successful.
void	SetAnimationEnabled (bool enable)
	Set animation enabled.
void	SetObjectAnimation (ObjectAnimation *objectAnimation)
	Set object animation.
void	SetAttributeAnimation (const String &name, ValueAnimation *attributeAnimation, WrapMode wrapMode=WM_LOOP, float speed=1.0f)
	Set attribute animation.
void	SetAttributeAnimationWrapMode (const String &name, WrapMode wrapMode)
	Set attribute animation wrap mode.
void	SetAttributeAnimationSpeed (const String &name, float speed)
	Set attribute animation speed.
bool	GetAnimationEnabled () const
	Return animation enabled.
ObjectAnimation *	GetObjectAnimation () const
	Return object animation.
ValueAnimation *	GetAttributeAnimation (const String &name) const
	Return attribute animation.
WrapMode	GetAttributeAnimationWrapMode (const String &name) const
	Return attribute animation wrap mode.
float	GetAttributeAnimationSpeed (const String &name) const
	Return attribute animation speed.
void	SetObjectAnimationAttr (const ResourceRef &value)
	Set object animation attribute.
ResourceRef	GetObjectAnimationAttr () const
	Return object animation attribute.
Public Member Functions inherited from Urho3D::Serializable
	Serializable (Context *context)
	Construct.
virtual	~Serializable ()
	Destruct.
virtual void	OnSetAttribute (const AttributeInfo &attr, const Variant &src)
	Handle attribute write access. Default implementation writes to the variable at offset, or invokes the set accessor.
virtual void	OnGetAttribute (const AttributeInfo &attr, Variant &dest) const
	Handle attribute read access. Default implementation reads the variable at offset, or invokes the get accessor.
virtual const Vector < AttributeInfo > *	GetAttributes () const
	Return attribute descriptions, or null if none defined.
virtual const Vector < AttributeInfo > *	GetNetworkAttributes () const
	Return network replication attribute descriptions, or null if none defined.
virtual bool	Load (Deserializer &source, bool setInstanceDefault=false)
	Load from binary data. When setInstanceDefault is set to true, after setting the attribute value, store the value as instance's default value. Return true if successful.
virtual void	ApplyAttributes ()
	Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
virtual bool	SaveDefaultAttributes () const
	Return whether should save default-valued attributes into XML. Default false.
bool	SetAttribute (unsigned index, const Variant &value)
	Set attribute by index. Return true if successfully set.
bool	SetAttribute (const String &name, const Variant &value)
	Set attribute by name. Return true if successfully set.
void	ResetToDefault ()
	Reset all editable attributes to their default values.
void	RemoveInstanceDefault ()
	Remove instance's default values if they are set previously.
void	SetTemporary (bool enable)
	Set temporary flag. Temporary objects will not be saved.
void	SetInterceptNetworkUpdate (const String &attributeName, bool enable)
	Enable interception of an attribute from network updates. Intercepted attributes are sent as events instead of applying directly. This can be used to implement client side prediction.
void	AllocateNetworkState ()
	Allocate network attribute state.
void	WriteInitialDeltaUpdate (Serializer &dest, unsigned char timeStamp)
	Write initial delta network update.
void	WriteDeltaUpdate (Serializer &dest, const DirtyBits &attributeBits, unsigned char timeStamp)
	Write a delta network update according to dirty attribute bits.
void	WriteLatestDataUpdate (Serializer &dest, unsigned char timeStamp)
	Write a latest data network update.
bool	ReadDeltaUpdate (Deserializer &source)
	Read and apply a network delta update. Return true if attributes were changed.
bool	ReadLatestDataUpdate (Deserializer &source)
	Read and apply a network latest data update. Return true if attributes were changed.
Variant	GetAttribute (unsigned index) const
	Return attribute value by index. Return empty if illegal index.
Variant	GetAttribute (const String &name) const
	Return attribute value by name. Return empty if not found.
Variant	GetAttributeDefault (unsigned index) const
	Return attribute default value by index. Return empty if illegal index.
Variant	GetAttributeDefault (const String &name) const
	Return attribute default value by name. Return empty if not found.
unsigned	GetNumAttributes () const
	Return number of attributes.
unsigned	GetNumNetworkAttributes () const
	Return number of network replication attributes.
bool	IsTemporary () const
	Return whether is temporary.
bool	GetInterceptNetworkUpdate (const String &attributeName) const
	Return whether an attribute's network updates are being intercepted.
NetworkState *	GetNetworkState () const
	Return the network attribute state, if allocated.
Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.
virtual	~Object ()
	Destruct. Clean up self from event sender & receiver structures.
virtual Urho3D::StringHash	GetType () const =0
	Return type hash.
virtual Urho3D::StringHash	GetBaseType () const =0
	Return base class type hash.
virtual const Urho3D::String &	GetTypeName () const =0
	Return type name.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
void	SubscribeToEvent (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler)
	Subscribe to a specific sender's event.
void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.
void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.
void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.
void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.
void	UnsubscribeFromAllEventsExcept (const PODVector< StringHash > &exceptions, bool onlyUserData)
	Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events.)
void	SendEvent (StringHash eventType)
	Send event to all subscribers.
void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers. More...
VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
Context *	GetContext () const
	Return execution context.
Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.
Object *	GetEventSender () const
	Return active event sender. Null outside event handling.
EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.
bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.
bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.
bool	HasEventHandlers () const
	Return whether has subscribed to any event.
template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.
const String &	GetCategory () const
	Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.
virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
void	AddRef ()
	Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
void	ReleaseRef ()
	Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
int	Refs () const
	Return reference count.
int	WeakRefs () const
	Return weak reference count.
RefCount *	RefCountPtr ()
	Return pointer to the reference count structure.

Static Public Member Functions
static void	RegisterObject (Context *context)
	Register object factory.
Static Public Member Functions inherited from Urho3D::BillboardSet
static void	RegisterObject (Context *context)
	Register object factory.
Static Public Member Functions inherited from Urho3D::Drawable
static void	RegisterObject (Context *context)
	Register object attributes. Drawable must be registered first.

Protected Member Functions
virtual void	OnNodeSet (Node *node)
	Handle node being assigned.
bool	EmitNewParticle ()
	Create a new particle. Return true if there was room.
unsigned	GetFreeParticle () const
	Return a free particle index.
Protected Member Functions inherited from Urho3D::BillboardSet
virtual void	OnWorldBoundingBoxUpdate ()
	Recalculate the world-space bounding box.
void	MarkPositionsDirty ()
	Mark billboard vertex buffer to need an update.
Protected Member Functions inherited from Urho3D::Drawable
virtual void	OnMarkedDirty (Node *node)
	Handle node transform being dirtied.
virtual void	OnRemoveFromOctree ()
	Handle removal from octree.
void	AddToOctree ()
	Add to octree.
void	RemoveFromOctree ()
	Remove from octree.
void	SetOctant (Octant *octant)
	Move into another octree octant.
Protected Member Functions inherited from Urho3D::Component
virtual void	OnAttributeAnimationAdded ()
	Handle attribute animation added.
virtual void	OnAttributeAnimationRemoved ()
	Handle attribute animation removed.
virtual void	OnNodeSetEnabled (Node *node)
	Handle scene node enabled status changing.
void	SetID (unsigned id)
	Set ID. Called by Scene.
void	SetNode (Node *node)
	Set scene node. Called by Node when creating the component.
void	HandleAttributeAnimationUpdate (StringHash eventType, VariantMap &eventData)
	Handle scene attribute animation update event.
Protected Member Functions inherited from Urho3D::Animatable
virtual void	SetObjectAttributeAnimation (const String &name, ValueAnimation *attributeAnimation, WrapMode wrapMode, float speed)
	Set object attribute animation internal.
void	OnObjectAnimationAdded (ObjectAnimation *objectAnimation)
	Handle object animation added.
void	OnObjectAnimationRemoved (ObjectAnimation *objectAnimation)
	Handle object animation removed.
void	UpdateAttributeAnimations (float timeStep)
	Update attribute animations.
bool	IsAnimatedNetworkAttribute (const AttributeInfo &attrInfo) const
	Is animated network attribute.
AttributeAnimationInfo *	GetAttributeAnimationInfo (const String &name) const
	Return attribute animation info.
void	HandleAttributeAnimationAdded (StringHash eventType, VariantMap &eventData)
	Handle attribute animation added.
void	HandleAttributeAnimationRemoved (StringHash eventType, VariantMap &eventData)
	Handle attribute animation removed.

Private Member Functions
	OBJECT (ParticleEmitter)
void	HandleScenePostUpdate (StringHash eventType, VariantMap &eventData)
	Handle scene post-update event.
void	HandleEffectReloadFinished (StringHash eventType, VariantMap &eventData)
	Handle live reload of the particle effect.

Private Attributes
SharedPtr< ParticleEffect >	effect_
	Particle effect.
PODVector< Particle >	particles_
	Particles.
float	periodTimer_
	Active/inactive period timer.
float	emissionTimer_
	New particle emission timer.
float	lastTimeStep_
	Last scene timestep.
unsigned	lastUpdateFrameNumber_
	Rendering framenumber on which was last updated.
bool	emitting_
	Currently emitting flag.
bool	needUpdate_
	Need update flag.
bool	serializeParticles_
	Serialize particles flag.

Additional Inherited Members
Protected Attributes inherited from Urho3D::BillboardSet
PODVector< Billboard >	billboards_
	Billboards.
Vector3	faceCameraAxes_
	Coordinate axes on which camera facing is done.
float	animationLodBias_
	Animation LOD bias.
float	animationLodTimer_
	Animation LOD timer.
bool	relative_
	Billboards relative flag.
bool	scaled_
	Scale affects billboard scale flag.
bool	sorted_
	Billboards sorted flag.
FaceCameraMode	faceCameraMode_
	Billboard rotation mode in relation to the camera.

Detailed Description

Particle emitter component.

---

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

• /home/travis/build/urho3d/Urho3D/Source/Urho3D/Graphics/ParticleEmitter.h
• /home/travis/build/urho3d/Urho3D/Source/Urho3D/Graphics/ParticleEmitter.cpp