Urho3D::ParticleEffect2D Class Reference

2D particle effect resource. More...

#include <Urho3D/Urho2D/ParticleEffect2D.h>

Inheritance diagram for Urho3D::ParticleEffect2D:

Public Member Functions
	ParticleEffect2D (Context *context)
	Construct.
	~ParticleEffect2D () override
	Destruct.
bool	BeginLoad (Deserializer &source) override
	Load resource from stream. May be called from a worker thread. Return true if successful.
bool	EndLoad () override
	Finish resource loading. Always called from the main thread. Return true if successful.
bool	Save (Serializer &dest) const override
	Save resource. Return true if successful.
void	SetSprite (Sprite2D *sprite)
	Set sprite.
void	SetSourcePositionVariance (const Vector2 &sourcePositionVariance)
	Set source position variance.
void	SetSpeed (float speed)
	Set speed.
void	SetSpeedVariance (float speedVariance)
	Set speed variance.
void	SetParticleLifeSpan (float particleLifeSpan)
	Set particle lifespan.
void	SetParticleLifespanVariance (float particleLifespanVariance)
	Set particle lifespan variance.
void	SetAngle (float angle)
	Set angle.
void	SetAngleVariance (float angleVariance)
	Set angle variance.
void	SetGravity (const Vector2 &gravity)
	Set gravity.
void	SetRadialAcceleration (float radialAcceleration)
	Set radial acceleration.
void	SetTangentialAcceleration (float tangentialAcceleration)
	Set tangential acceleration.
void	SetRadialAccelVariance (float radialAccelVariance)
	Set radial acceleration variance.
void	SetTangentialAccelVariance (float tangentialAccelVariance)
	Set tangential acceleration variance.
void	SetStartColor (const Color &startColor)
	Set start color.
void	SetStartColorVariance (const Color &startColorVariance)
	Set start color variance.
void	SetFinishColor (const Color &finishColor)
	Set finish color.
void	SetFinishColorVariance (const Color &finishColorVariance)
	Set finish color variance.
void	SetMaxParticles (int maxParticles)
	Set max particles.
void	SetStartParticleSize (float startParticleSize)
	Set start particle size.
void	SetStartParticleSizeVariance (float startParticleSizeVariance)
	Set start particle size variance.
void	SetFinishParticleSize (float finishParticleSize)
	Set finish particle size.
void	SetFinishParticleSizeVariance (float finishParticleSizeVariance)
	Set finish particle size variance.
void	SetDuration (float duration)
	Set duration.
void	SetEmitterType (EmitterType2D emitterType)
	Set emitter type.
void	SetMaxRadius (float maxRadius)
	Set max radius.
void	SetMaxRadiusVariance (float maxRadiusVariance)
	Set max radius variance.
void	SetMinRadius (float minRadius)
	Set min radius.
void	SetMinRadiusVariance (float minRadiusVariance)
	Set min radius variance.
void	SetRotatePerSecond (float rotatePerSecond)
	Set rotate per second.
void	SetRotatePerSecondVariance (float rotatePerSecondVariance)
	Set rotate per second variance.
void	SetBlendMode (BlendMode blendMode)
	Set blend mode.
void	SetRotationStart (float rotationStart)
	Set rotation start.
void	SetRotationStartVariance (float rotationStartVariance)
	Set rotation start variance.
void	SetRotationEnd (float rotationEnd)
	Set rotation end.
void	SetRotationEndVariance (float rotationEndVariance)
	Set rotation end variance.
SharedPtr< ParticleEffect2D >	Clone (const ea::string &cloneName=EMPTY_STRING) const
	Clone the 2D particle effect. More...
Sprite2D *	GetSprite () const
	Return sprite.
const Vector2 &	GetSourcePositionVariance () const
	Return source position variance.
float	GetSpeed () const
	Return speed.
float	GetSpeedVariance () const
	Return speed variance.
float	GetParticleLifeSpan () const
	Return particle lifespan.
float	GetParticleLifespanVariance () const
	Return particle lifespan variance.
float	GetAngle () const
	Return angle.
float	GetAngleVariance () const
	Return angle variance.
const Vector2 &	GetGravity () const
	Return gravity.
float	GetRadialAcceleration () const
	Return radial acceleration.
float	GetTangentialAcceleration () const
	Return tangential acceleration.
float	GetRadialAccelVariance () const
	Return radial acceleration variance.
float	GetTangentialAccelVariance () const
	Return tangential acceleration variance.
const Color &	GetStartColor () const
	Return start color.
const Color &	GetStartColorVariance () const
	Return start color variance.
const Color &	GetFinishColor () const
	Return finish color.
const Color &	GetFinishColorVariance () const
	Return finish color variance.
int	GetMaxParticles () const
	Return max particles.
float	GetStartParticleSize () const
	Return start particle size.
float	GetStartParticleSizeVariance () const
	Return start particle size variance.
float	GetFinishParticleSize () const
	Return finish particle size.
float	GetFinishParticleSizeVariance () const
	Return finish particle size variance.
float	GetDuration () const
	Return duration.
EmitterType2D	GetEmitterType () const
	Return emitter type.
float	GetMaxRadius () const
	Return max radius.
float	GetMaxRadiusVariance () const
	Return max radius variance.
float	GetMinRadius () const
	Return min radius.
float	GetMinRadiusVariance () const
	Return min radius variance.
float	GetRotatePerSecond () const
	Return rotate per second.
float	GetRotatePerSecondVariance () const
	Return rotate per second variance.
BlendMode	GetBlendMode () const
	Return blend mode.
float	GetRotationStart () const
	Return rotation start.
float	GetRotationStartVariance () const
	Return rotation start variance.
float	GetRotationEnd () const
	Return rotation end.
float	GetRotationEndVariance () const
	Return rotation end variance.
Public Member Functions inherited from Urho3D::Resource
	Resource (Context *context)
	Construct.
bool	Load (Deserializer &source)
	Load resource synchronously. Call both BeginLoad() & EndLoad() and return true if both succeeded.
bool	LoadFile (const FileIdentifier &fileName)
	Load resource from file.
virtual bool	SaveFile (const FileIdentifier &fileName) const
	Save resource to file.
void	SetName (const ea::string &name)
void	SetMemoryUse (unsigned size)
	Set memory use in bytes, possibly approximate.
void	ResetUseTimer ()
	Reset last used timer.
void	SetAsyncLoadState (AsyncLoadState newState)
	Set the asynchronous loading state. Called by ResourceCache. Resources in the middle of asynchronous loading are not normally returned to user.
void	SetAbsoluteFileName (const ea::string &fileName)
	Set absolute file name.
const ea::string &	GetName () const
StringHash	GetNameHash () const
	Return name hash.
unsigned	GetMemoryUse () const
unsigned	GetUseTimer ()
AsyncLoadState	GetAsyncLoadState () const
	Return the asynchronous loading state.
const ea::string &	GetAbsoluteFileName () const
	Return absolute file name.
Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.
	~Object () override
	Destruct. Clean up self from event sender & receiver structures.
virtual StringHash	GetType () const =0
virtual const ea::string &	GetTypeName () const =0
virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
virtual void	SerializeInBlock (Archive &archive)
	Serialize content from/to archive. May throw ArchiveException.
bool	IsInstanceOf (StringHash type) const
	Check current instance is type of specified type.
bool	IsInstanceOf (const TypeInfo *typeInfo) const
	Check current instance is type of specified type.
template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.
template<typename T >
T *	Cast ()
	Cast the object to specified most derived class.
template<typename T >
const T *	Cast () const
	Cast the object to specified most derived class.
void	SubscribeToEventManual (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler)
	Subscribe to a specific sender's event.
template<class T >
void	SubscribeToEvent (StringHash eventType, T handler)
	Subscribe to an event that can be sent by any sender.
template<class T >
void	SubscribeToEvent (Object *sender, StringHash eventType, T 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 ea::vector< StringHash > &exceptions)
	Unsubscribe from all events except those listed.
void	UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
	Unsubscribe from all events except those with listed senders.
void	SendEvent (StringHash eventType)
	Send event to all subscribers.
void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers.
VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
template<typename... Args>
void	SendEvent (StringHash eventType, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
Context *	GetContext () const
	Return execution context.
const Variant &	GetGlobalVar (StringHash key) const
const VariantMap &	GetGlobalVars () const
void	SetGlobalVar (StringHash key, const Variant &value)
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 ea::string &	GetCategory () const
void	SendEvent (StringHash eventType, const VariantMap &eventData)
	Send event with parameters to all subscribers.
void	SetBlockEvents (bool block)
	Block object from sending and receiving events.
bool	GetBlockEvents () const
	Return sending and receiving events blocking status.
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.
	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.
RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.
int	AddRef ()
int	ReleaseRef ()
int	Refs () const
int	WeakRefs () const
RefCount *	RefCountPtr () const
	Return pointer to the reference count structure.
bool	HasScriptObject () const
	Return true if script runtime object wrapping this native object exists.
bool	IsScriptStrongRef () const
	Return true if script reference is strong.

Static Public Member Functions
static void	RegisterObject (Context *context)
Static Public Member Functions inherited from Urho3D::Resource
static Resource *	LoadFromCache (Context *context, StringHash type, const ea::string &name)
	Load resource by reference.
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Private Member Functions
	URHO3D_OBJECT (ParticleEffect2D, Resource)
int	ReadInt (const XMLElement &element, const ea::string &name) const
	Read integer.
float	ReadFloat (const XMLElement &element, const ea::string &name) const
	Read float.
Color	ReadColor (const XMLElement &element, const ea::string &name) const
	Read Color.
Vector2	ReadVector2 (const XMLElement &element, const ea::string &name) const
	Read Vector2.
void	WriteInt (XMLElement &element, const ea::string &name, int value) const
	Write integer.
void	WriteFloat (XMLElement &element, const ea::string &name, float value) const
	Write float.
void	WriteColor (XMLElement &element, const ea::string &name, const Color &color) const
	Write Color.
void	WriteVector2 (XMLElement &element, const ea::string &name, const Vector2 &value) const
	Write Vector2.

Private Attributes
SharedPtr< Sprite2D >	sprite_
	Sprite.
Vector2	sourcePositionVariance_
	Source position variance.
float	speed_
	Speed.
float	speedVariance_
	Speed variance.
float	particleLifeSpan_
	Particle lifespan.
float	particleLifespanVariance_
	Particle lifespan variance.
float	angle_
	Angle.
float	angleVariance_
	Angle variance.
Vector2	gravity_
	Gravity.
float	radialAcceleration_
	Radial acceleration.
float	tangentialAcceleration_
	Tangential acceleration.
float	radialAccelVariance_
	Radial acceleration variance.
float	tangentialAccelVariance_
	Tangential acceleration variance.
Color	startColor_
	Start color.
Color	startColorVariance_
	Start color variance.
Color	finishColor_
	Finish color.
Color	finishColorVariance_
	Finish color variance.
int	maxParticles_
	Max particles.
float	startParticleSize_
	Start particle size.
float	startParticleSizeVariance_
	Start particle size variance.
float	finishParticleSize_
	Finish particle size.
float	finishParticleSizeVariance_
	Finish particle size variance.
float	duration_
	Duration.
EmitterType2D	emitterType_
	Emitter type.
float	maxRadius_
	Max radius.
float	maxRadiusVariance_
	Max radius variance.
float	minRadius_
	Min radius.
float	minRadiusVariance_
	Min radius variance.
float	rotatePerSecond_
	Rotate per second.
float	rotatePerSecondVariance_
	Rotate per second variance.
BlendMode	blendMode_
	Blend mode.
float	rotationStart_
	Rotation start.
float	rotationStartVariance_
	Rotation start variance.
float	rotationEnd_
	Rotation end.
float	rotationEndVariance_
	Rotation end variance.
ea::string	loadSpriteName_
	Sprite name acquired during BeginLoad().

Additional Inherited Members
Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Detailed Description

2D particle effect resource.

Member Function Documentation

Clone()

SharedPtr< ParticleEffect2D > Urho3D::ParticleEffect2D::Clone

(

const ea::string &

cloneName = EMPTY_STRING

)

const

Clone the 2D particle effect.

RegisterObject()

void Urho3D::ParticleEffect2D::RegisterObject ( Context *  context )

static

Register object factory. Drawable2D must be registered first.

---

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

• Urho3D/Urho2D/ParticleEffect2D.h
• Urho3D/Urho2D/ParticleEffect2D.cpp