PUEmitter，the base class of pu emitter，inherit from Particle3DEmitter. More...

Inherits Particle3DEmitter.

Inherited by CCPUBoxEmitter, PUCircleEmitter, PULineEmitter, PUMeshSurfaceEmitter, PUPointEmitter, PUPositionEmitter, PUSlaveEmitter, and PUSphereSurfaceEmitter.

Public Member Functions
virtual void	notifyStart ()
	Perform activities when a emitter is started(internal method).

var	notifyStart ()
	Perform activities when a emitter is started(internal method).

local	notifyStart ()
	Perform activities when a emitter is started(internal method).

virtual void	notifyStop ()
	Perform activities when a emitter is stopped(internal method).

virtual void	notifyPause ()
	Perform activities when a emitter is paused(internal method).

virtual void	notifyResume ()
	Perform activities when a emitter is paused(internal method).

virtual void	notifyRescaled (const Vec3 &scale)
	Notify that the emitter is rescaled(internal method).

local	notifyRescaled ( local scale)
	Notify that the emitter is rescaled(internal method).

virtual void	prepare ()
	The function is automatically called during initialisation (prepare) activities of a ParticleSystem(internal method).

virtual void	unPrepare ()
	The function is automatically called when a ParticleSystem is expired(internal method).

local	unPrepare ()
	The function is automatically called when a ParticleSystem is expired(internal method).

virtual void	preUpdateEmitter (float deltaTime)
	This function is called before the ParticleSystem update-loop where all particles are traversed(internal method). More...

var	preUpdateEmitter ( var deltaTime)
	This function is called before the ParticleSystem update-loop where all particles are traversed(internal method). More...

local	preUpdateEmitter ( local deltaTime)
	This function is called before the ParticleSystem update-loop where all particles are traversed(internal method). More...

virtual void	updateEmitter (Particle3D *particle, float deltaTime) override
	This function is called when the ParticleSystem update-loop where all particles are traversed(internal method). More...

virtual void	postUpdateEmitter (float deltaTime)
	This function is called after the ParticleSystem update-loop where all particles are traversed(internal method). More...

local	postUpdateEmitter ( local deltaTime)
	This function is called after the ParticleSystem update-loop where all particles are traversed(internal method). More...

virtual unsigned short	calculateRequestedParticles (float timeElapsed)
	Calculate the number of particles that the emitter wants to emit. More...

local	calculateRequestedParticles ( local timeElapsed)
	Calculate the number of particles that the emitter wants to emit. More...

virtual void	emit (int count) override
	Overwrite function.

void	setLocalPosition (const Vec3 &pos)
	Set position of emitter. More...

const Vec3	getLocalPosition () const
	Get position of emitter. More...

const Vec3 &	getDerivedPosition ()
	Calculate the world position of the emitter. More...

void	setEnabled (bool enabled)
	Set the emitter enable or disable. More...

bool	isEnabled (void) const
	Get the emitter enabled. More...

bool	isEmitterDone () const
	Is the emitter emission done. More...

const std::string &	getEmitterType (void) const
	Get the emitter type. More...

void	setEmitterType (const std::string &emitterType)
	Set the emitter type. More...

const std::string &	getName (void) const
	Get the name of emitter. More...

void	setName (const std::string &name)
	Set the name of emitter. More...

PUDynamicAttribute *	getDynAngle (void) const
	Get the emission angle attribute. More...

void	setDynAngle (PUDynamicAttribute *dynAngle)
	Set the emission angle attribute. More...

PUDynamicAttribute *	getDynEmissionRate (void) const
	Get the emission rate attribute. More...

void	setDynEmissionRate (PUDynamicAttribute *dynEmissionRate)
	Set the emission rate attribute. More...

PUDynamicAttribute *	getDynTotalTimeToLive (void) const
	Get the time to live attribute. More...

void	setDynTotalTimeToLive (PUDynamicAttribute *dynTotalTimeToLive)
	Set the time to live attribute. More...

PUDynamicAttribute *	getDynParticleMass (void) const
	Get the mass of emission particle. More...

void	setDynParticleMass (PUDynamicAttribute *dynParticleMass)
	Set the mass of emission particle. More...

PUDynamicAttribute *	getDynVelocity (void) const
	Get the emission velocity. More...

void	setDynVelocity (PUDynamicAttribute *dynVelocity)
	Set the emission velocity. More...

PUDynamicAttribute *	getDynDuration (void) const
	Get the emission duration. More...

void	setDynDuration (PUDynamicAttribute *dynDuration)
	Set the emission duration. More...

void	setDynDurationSet (bool durationSet)
	Whether use duration(unused means infinite time). More...

var	setDynDurationSet ( var durationSet)
	Whether use duration(unused means infinite time). More...

local	setDynDurationSet ( local durationSet)
	Whether use duration(unused means infinite time). More...

PUDynamicAttribute *	getDynRepeatDelay (void) const
	Get the delay of repeat emission. More...

local	getDynRepeatDelay ()
	Get the delay of repeat emission. More...

void	setDynRepeatDelay (PUDynamicAttribute *dynRepeatDelay)
	Set the delay of repeat emission. More...

void	setDynRepeatDelaySet (bool repeatDelaySet)
	Whether use delay of repeat emission(unused means emit once). More...

PUDynamicAttribute *	getDynParticleAllDimensions (void) const
	Get the all dimensions attribute of particle. More...

local	getDynParticleAllDimensions ()
	Get the all dimensions attribute of particle. More...

void	setDynParticleAllDimensions (PUDynamicAttribute *dynParticleAllDimensions)
	Set the all dimensions attribute of particle. More...

void	setDynParticleAllDimensionsSet (bool particleAllDimensionsSet)
	Whether use all dimensions setting. More...

PUDynamicAttribute *	getDynParticleWidth (void) const
	Get the attribute of particle width. More...

void	setDynParticleWidth (PUDynamicAttribute *dynParticleWidth)
	Set the attribute of particle width. More...

void	setDynParticleWidthSet (bool particleWidthSet)
	Whether use the attribute of particle width. More...

PUDynamicAttribute *	getDynParticleHeight (void) const
	Get the attribute of particle height. More...

void	setDynParticleHeight (PUDynamicAttribute *dynParticleHeight)
	Set the attribute of particle height. More...

void	setDynParticleHeightSet (bool particleHeightSet)
	Whether use the attribute of particle height. More...

PUDynamicAttribute *	getDynParticleDepth (void) const
	Get the attribute of particle depth. More...

void	setDynParticleDepth (PUDynamicAttribute *dynParticleDepth)
	Set the attribute of particle depth. More...

void	setDynParticleDepthSet (bool particleDepthSet)
	Whether use the attribute of particle depth. More...

const std::string &	getEmitsName (void) const
	Todo. More...

void	setEmitsName (const std::string &emitsName)
	Set the name of emits. More...

PUParticle3D::ParticleType	getEmitsType () const
	Get the type of emits. More...

local	getEmitsType ()
	Get the type of emits. More...

void	setEmitsType (PUParticle3D::ParticleType type)
	Set the type of emits. More...

Ref *	getEmitsEntityPtr () const
	Get the pointer of emits(PUEmitter, PUParticleSystem3D, etc). More...

bool	isMarkedForEmission () const
	Whether this emitter marked for emission. More...

void	setMarkedForEmission (bool isMarked)
	Set this emitter marked for emission. More...

const Vec3 &	getParticleDirection (void)
	Returns the base direction of the particle that is going to be emitted. More...

const Vec3 &	getOriginalParticleDirection (void) const
	Returns the originally set particle direction. More...

const Quaternion &	getParticleOrientation (void) const
	Returns the base orientation of the particle that is going to be emitted. More...

void	setParticleOrientation (const Quaternion &orientation)
	Set the orientation of the particle. More...

const Quaternion &	getParticleOrientationRangeStart (void) const
	Returns the start orientation of the particle that is going to be emitted The start orientation.

void	setParticleOrientationRangeStart (const Quaternion &orientationRangeStart)
	Set start orientation of the particle that is going to be emitted. More...

const Quaternion &	getParticleOrientationRangeEnd (void) const
	Returns the end orientation of the particle that is going to be emitted. More...

local	getParticleOrientationRangeEnd ()
	Returns the end orientation of the particle that is going to be emitted. More...

void	setParticleOrientationRangeEnd (const Quaternion &orientationRangeEnd)
	Set end orientation of the particle that is going to be emitted. More...

void	setParticleDirection (const Vec3 &direction)
	Sets the direction of the particle that the emitter is emitting. More...

bool	isAutoDirection (void) const
	Whether use auto direction. More...

void	setAutoDirection (bool autoDirection)
	Set use auto direction. More...

bool	isForceEmission (void) const
	Whether force emission. More...

void	setForceEmission (bool forceEmission)
	Set force emission. More...

const Vec4 &	getParticleColor (void) const
	Get the color of a particle that will be emitted. More...

local	getParticleColor ()
	Get the color of a particle that will be emitted. More...

void	setParticleColor (const Vec4 &particleColour)
	Set the color of an emitted particle. More...

const Vec4 &	getParticleColorRangeStart (void) const
	Get the color range start of an emitted particle. More...

void	setParticleColorRangeStart (const Vec4 &particleColourRangeStart)
	Set the color range start of an emitted particle The color range start.

const Vec4 &	getParticleColorRangeEnd (void) const
	Get the color range end of an emitted particle. More...

var	getParticleColorRangeEnd ()
	Get the color range end of an emitted particle. More...

local	getParticleColorRangeEnd ()
	Get the color range end of an emitted particle. More...

void	setParticleColorRangeEnd (const Vec4 &particleColourRangeEnd)
	Set the color range end of an emitted particle The color range end.

const unsigned short &	getParticleTextureCoords (void) const
	Get the texture coords of an emitted particle. More...

void	setParticleTextureCoords (const unsigned short &particleTextureCoords)
	Set the texture coords of an emitted particle. More...

const unsigned short &	getParticleTextureCoordsRangeStart (void) const
	Get the texture coords range start of an emitted particle. More...

void	setParticleTextureCoordsRangeStart (const unsigned short &particleTextureCoordsRangeStart)
	Set the texture coords range start of an emitted particle. More...

const unsigned short &	getParticleTextureCoordsRangeEnd (void) const
	Get the texture coords range end of an emitted particle. More...

void	setParticleTextureCoordsRangeEnd (const unsigned short &particleTextureCoordsRangeEnd)
	Set the texture coords range end of an emitted particle. More...

bool	isKeepLocal (void) const
	Whether use local coordinate system. More...

void	setKeepLocal (bool keepLocal)
	Set use local coordinate system, If this attribute is set to 'true', the particles are emitted relative to the emitter. More...

bool	makeParticleLocal (PUParticle3D *particle)
	Transforms the particle position in a local position relative to the emitter The transformed particle.

virtual PUEmitter *	clone ()=0
	Clone this emitter.

virtual void	copyAttributesTo (PUEmitter *emitter)
	Copy attributes to another emitter(internal method). More...

local	copyAttributesTo ( local emitter)
	Copy attributes to another emitter(internal method). More...

Public Member Functions inherited from Particle3DEmitter
void	setEnabled (bool enabled)
	Set the emitter enable or disable. More...

bool	isEnabled (void) const
	Get the emitter enabled. More...

Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership. More...

local	retain ()
	Retains the ownership. More...

void	release ()
	Releases the ownership immediately. More...

Ref *	autorelease ()
	Releases the ownership sometime soon automatically. More...

unsigned int	getReferenceCount () const
	Returns the Ref's current reference count. More...

local	getReferenceCount ()
	Returns the Ref's current reference count. More...

virtual	~Ref ()
	Destructor.

Static Public Attributes
static const bool	DEFAULT_ENABLED
	Default enabled.

var	DEFAULT_ENABLED
	Default enabled.

local	DEFAULT_ENABLED
	Default enabled.

static const Vec3	DEFAULT_POSITION
	Default position.

var	DEFAULT_POSITION
	Default position.

local	DEFAULT_POSITION
	Default position.

static const bool	DEFAULT_KEEP_LOCAL
	Default whether use local coordinate system.

var	DEFAULT_KEEP_LOCAL
	Default whether use local coordinate system.

local	DEFAULT_KEEP_LOCAL
	Default whether use local coordinate system.

static const Vec3	DEFAULT_DIRECTION
	Default emitted direction.

var	DEFAULT_DIRECTION
	Default emitted direction.

local	DEFAULT_DIRECTION
	Default emitted direction.

static const Quaternion	DEFAULT_ORIENTATION
	Default emitted orientation.

var	DEFAULT_ORIENTATION
	Default emitted orientation.

local	DEFAULT_ORIENTATION
	Default emitted orientation.

static const Quaternion	DEFAULT_ORIENTATION_RANGE_START
	Default emitted starting orientation.

var	DEFAULT_ORIENTATION_RANGE_START
	Default emitted starting orientation.

local	DEFAULT_ORIENTATION_RANGE_START
	Default emitted starting orientation.

static const Quaternion	DEFAULT_ORIENTATION_RANGE_END
	Default emitted ending orientation.

static const unsigned short	DEFAULT_START_TEXTURE_COORDS
	Default texture starting coords.

static const unsigned short	DEFAULT_END_TEXTURE_COORDS
	Default texture ending coords.

static const unsigned short	DEFAULT_TEXTURE_COORDS
	Default texture coords.

static const Vec4	DEFAULT_START_COLOUR_RANGE
	Default color starting range.

static const Vec4	DEFAULT_END_COLOUR_RANGE
	Default color ending range.

var	DEFAULT_END_COLOUR_RANGE
	Default color ending range.

local	DEFAULT_END_COLOUR_RANGE
	Default color ending range.

static const Vec4	DEFAULT_COLOUR
	Default color.

local	DEFAULT_COLOUR
	Default color.

static const bool	DEFAULT_AUTO_DIRECTION
	Default whether use auto direction.

static const bool	DEFAULT_FORCE_EMISSION
	Default whether force emission.

var	DEFAULT_FORCE_EMISSION
	Default whether force emission.

local	DEFAULT_FORCE_EMISSION
	Default whether force emission.

static const float	DEFAULT_EMISSION_RATE
	Default emission rate.

var	DEFAULT_EMISSION_RATE
	Default emission rate.

local	DEFAULT_EMISSION_RATE
	Default emission rate.

static const float	DEFAULT_TIME_TO_LIVE
	Default particle time to live.

var	DEFAULT_TIME_TO_LIVE
	Default particle time to live.

local	DEFAULT_TIME_TO_LIVE
	Default particle time to live.

static const float	DEFAULT_MASS
	Default particle mass.

static const float	DEFAULT_VELOCITY
	Default particle velocity.

static const float	DEFAULT_DURATION
	Default emitted duration.

var	DEFAULT_DURATION
	Default emitted duration.

local	DEFAULT_DURATION
	Default emitted duration.

static const float	DEFAULT_REPEAT_DELAY
	Default emitted repeat delay.

var	DEFAULT_REPEAT_DELAY
	Default emitted repeat delay.

local	DEFAULT_REPEAT_DELAY
	Default emitted repeat delay.

static const float	DEFAULT_ANGLE
	Default emitted angle.

static const float	DEFAULT_DIMENSIONS
	Default emitted particle dimensions.

var	DEFAULT_DIMENSIONS
	Default emitted particle dimensions.

local	DEFAULT_DIMENSIONS
	Default emitted particle dimensions.

static const float	DEFAULT_WIDTH
	Default emitted particle width.

static const float	DEFAULT_HEIGHT
	Default emitted particle height.

var	DEFAULT_HEIGHT
	Default emitted particle height.

local	DEFAULT_HEIGHT
	Default emitted particle height.

static const float	DEFAULT_DEPTH
	Default emitted particle depth.

var	DEFAULT_DEPTH
	Default emitted particle depth.

local	DEFAULT_DEPTH
	Default emitted particle depth.

Additional Inherited Members
Public Attributes inherited from Ref
unsigned int	_ID
	object id, ScriptSupport need public _ID

local	_ID
	object id, ScriptSupport need public _ID

int	_luaID
	Lua reference id.

local	_luaID
	Lua reference id.

void *	_scriptObject
	scriptObject, support for swift

local	_scriptObject
	scriptObject, support for swift

bool	_rooted
	When true, it means that the object was already rooted.

local	_rooted
	When true, it means that the object was already rooted.

bool	_scriptOwned
	The life of the object is scrolled by the scripting engine. More...

local	_scriptOwned
	The life of the object is scrolled by the scripting engine. More...

Detailed Description

PUEmitter，the base class of pu emitter，inherit from Particle3DEmitter.

Different emitters can have their own implementation.

Member Function Documentation

virtual void preUpdateEmitter ( float deltaTime )

virtual

This function is called before the ParticleSystem update-loop where all particles are traversed(internal method).

The delta time between two frames.

var preUpdateEmitter ( var deltaTime )

virtual

This function is called before the ParticleSystem update-loop where all particles are traversed(internal method).

The delta time between two frames.

local preUpdateEmitter ( local deltaTime )

virtual

This function is called before the ParticleSystem update-loop where all particles are traversed(internal method).

The delta time between two frames.

virtual void updateEmitter	(	Particle3D *	particle,
		float	deltaTime
	)

overridevirtual

This function is called when the ParticleSystem update-loop where all particles are traversed(internal method).

The current traversed particle. The delta time between two frames.

Reimplemented from Particle3DEmitter.

var updateEmitter	(	var	particle,
		var	deltaTime
	)

overridevirtual

This function is called when the ParticleSystem update-loop where all particles are traversed(internal method).

The current traversed particle. The delta time between two frames.

Reimplemented from Particle3DEmitter.

local updateEmitter	(	local	particle,
		local	deltaTime
	)

overridevirtual

This function is called when the ParticleSystem update-loop where all particles are traversed(internal method).

The current traversed particle. The delta time between two frames.

Reimplemented from Particle3DEmitter.

virtual void postUpdateEmitter ( float deltaTime )

virtual

This function is called after the ParticleSystem update-loop where all particles are traversed(internal method).

The delta time between two frames.

var postUpdateEmitter ( var deltaTime )

virtual

This function is called after the ParticleSystem update-loop where all particles are traversed(internal method).

The delta time between two frames.

local postUpdateEmitter ( local deltaTime )

virtual

This function is called after the ParticleSystem update-loop where all particles are traversed(internal method).

The delta time between two frames.

virtual unsigned short
calculateRequestedParticles ( float timeElapsed )

virtual

Calculate the number of particles that the emitter wants to emit.

The delta time between two frames.

Reimplemented in PUMeshSurfaceEmitter.

var calculateRequestedParticles ( var timeElapsed )

virtual

Calculate the number of particles that the emitter wants to emit.

The delta time between two frames.

Reimplemented in PUMeshSurfaceEmitter.

local calculateRequestedParticles ( local timeElapsed )

virtual

Calculate the number of particles that the emitter wants to emit.

The delta time between two frames.

Reimplemented in PUMeshSurfaceEmitter.

void setLocalPosition ( const Vec3 & pos )

inline

Set position of emitter.

The position in local coordinate system.

var setLocalPosition ( var pos )

inline

Set position of emitter.

The position in local coordinate system.

local setLocalPosition ( local pos )

inline

Set position of emitter.

The position in local coordinate system.

const Vec3 getLocalPosition ( ) const

inline

Get position of emitter.

The position in local coordinate system.

var getLocalPosition ( )

inline

Get position of emitter.

The position in local coordinate system.

local getLocalPosition ( )

inline

Get position of emitter.

The position in local coordinate system.

const Vec3& getDerivedPosition ( )

Calculate the world position of the emitter.

The position in world coordinate system.

var getDerivedPosition ( )

Calculate the world position of the emitter.

The position in world coordinate system.

local getDerivedPosition ( )

Calculate the world position of the emitter.

The position in world coordinate system.

void setEnabled ( bool enabled )

Set the emitter enable or disable.

Whether the emitter enabled.

var setEnabled ( var enabled )

Set the emitter enable or disable.

Whether the emitter enabled.

local setEnabled ( local enabled )

Set the emitter enable or disable.

Whether the emitter enabled.

bool isEnabled ( void ) const

Get the emitter enabled.

Whether the emitter enabled.

var isEnabled ( )

Get the emitter enabled.

Whether the emitter enabled.

local isEnabled ( )

Get the emitter enabled.

Whether the emitter enabled.

bool isEmitterDone ( ) const

Is the emitter emission done.

Whether the emission done.

var isEmitterDone ( )

Is the emitter emission done.

Whether the emission done.

local isEmitterDone ( )

Is the emitter emission done.

Whether the emission done.

const std::string& getEmitterType ( void ) const

inline

Get the emitter type.

The type.

var getEmitterType ( )

inline

Get the emitter type.

The type.

local getEmitterType ( )

inline

Get the emitter type.

The type.

void setEmitterType ( const std::string & emitterType )

inline

Set the emitter type.

The type.

var setEmitterType ( var emitterType )

inline

Set the emitter type.

The type.

local setEmitterType ( local emitterType )

inline

Set the emitter type.

The type.

const std::string& getName ( void ) const

inline

Get the name of emitter.

The name.

var getName ( )

inline

Get the name of emitter.

The name.

local getName ( )

inline

Get the name of emitter.

The name.

void setName ( const std::string & name )

inline

Set the name of emitter.

The name.

var setName ( var name )

inline

Set the name of emitter.

The name.

local setName ( local name )

inline

Set the name of emitter.

The name.

PUDynamicAttribute* getDynAngle ( void ) const

inline

Get the emission angle attribute.

The attribute.

var getDynAngle ( )

inline

Get the emission angle attribute.

The attribute.

local getDynAngle ( )

inline

Get the emission angle attribute.

The attribute.

void setDynAngle ( PUDynamicAttribute * dynAngle )

Set the emission angle attribute.

The attribute.

var setDynAngle ( var dynAngle )

Set the emission angle attribute.

The attribute.

local setDynAngle ( local dynAngle )

Set the emission angle attribute.

The attribute.

PUDynamicAttribute*
getDynEmissionRate ( void ) const

inline

Get the emission rate attribute.

The attribute.

var getDynEmissionRate ( )

inline

Get the emission rate attribute.

The attribute.

local getDynEmissionRate ( )

inline

Get the emission rate attribute.

The attribute.

void setDynEmissionRate ( PUDynamicAttribute * dynEmissionRate )

Set the emission rate attribute.

The attribute.

var setDynEmissionRate ( var dynEmissionRate )

Set the emission rate attribute.

The attribute.

local setDynEmissionRate ( local dynEmissionRate )

Set the emission rate attribute.

The attribute.

PUDynamicAttribute*
getDynTotalTimeToLive ( void ) const

inline

Get the time to live attribute.

The attribute.

var getDynTotalTimeToLive ( )

inline

Get the time to live attribute.

The attribute.

local getDynTotalTimeToLive ( )

inline

Get the time to live attribute.

The attribute.

void setDynTotalTimeToLive ( PUDynamicAttribute * dynTotalTimeToLive )

Set the time to live attribute.

The attribute.

var setDynTotalTimeToLive ( var dynTotalTimeToLive )

Set the time to live attribute.

The attribute.

local setDynTotalTimeToLive ( local dynTotalTimeToLive )

Set the time to live attribute.

The attribute.

PUDynamicAttribute*
getDynParticleMass ( void ) const

inline

Get the mass of emission particle.

The attribute.

var getDynParticleMass ( )

inline

Get the mass of emission particle.

The attribute.

local getDynParticleMass ( )

inline

Get the mass of emission particle.

The attribute.

void setDynParticleMass ( PUDynamicAttribute * dynParticleMass )

Set the mass of emission particle.

The attribute.

var setDynParticleMass ( var dynParticleMass )

Set the mass of emission particle.

The attribute.

local setDynParticleMass ( local dynParticleMass )

Set the mass of emission particle.

The attribute.

PUDynamicAttribute* getDynVelocity ( void ) const

inline

Get the emission velocity.

The attribute.

var getDynVelocity ( )

inline

Get the emission velocity.

The attribute.

local getDynVelocity ( )

inline

Get the emission velocity.

The attribute.

void setDynVelocity ( PUDynamicAttribute * dynVelocity )

Set the emission velocity.

The attribute.

var setDynVelocity ( var dynVelocity )

Set the emission velocity.

The attribute.

local setDynVelocity ( local dynVelocity )

Set the emission velocity.

The attribute.

PUDynamicAttribute* getDynDuration ( void ) const

inline

Get the emission duration.

The attribute.

var getDynDuration ( )

inline

Get the emission duration.

The attribute.

local getDynDuration ( )

inline

Get the emission duration.

The attribute.

void setDynDuration ( PUDynamicAttribute * dynDuration )

Set the emission duration.

The attribute.

var setDynDuration ( var dynDuration )

Set the emission duration.

The attribute.

local setDynDuration ( local dynDuration )

Set the emission duration.

The attribute.

void setDynDurationSet ( bool durationSet )

Whether use duration(unused means infinite time).

Whether use.

var setDynDurationSet ( var durationSet )

Whether use duration(unused means infinite time).

Whether use.

local setDynDurationSet ( local durationSet )

Whether use duration(unused means infinite time).

Whether use.

PUDynamicAttribute*
getDynRepeatDelay ( void ) const

inline

Get the delay of repeat emission.

The delay.

var getDynRepeatDelay ( )

inline

Get the delay of repeat emission.

The delay.

local getDynRepeatDelay ( )

inline

Get the delay of repeat emission.

The delay.

void setDynRepeatDelay ( PUDynamicAttribute * dynRepeatDelay )

Set the delay of repeat emission.

The delay.

var setDynRepeatDelay ( var dynRepeatDelay )

Set the delay of repeat emission.

The delay.

local setDynRepeatDelay ( local dynRepeatDelay )

Set the delay of repeat emission.

The delay.

void setDynRepeatDelaySet ( bool repeatDelaySet )

Whether use delay of repeat emission(unused means emit once).

Whether use.

var setDynRepeatDelaySet ( var repeatDelaySet )

Whether use delay of repeat emission(unused means emit once).

Whether use.

local setDynRepeatDelaySet ( local repeatDelaySet )

Whether use delay of repeat emission(unused means emit once).

Whether use.

PUDynamicAttribute*
getDynParticleAllDimensions ( void ) const

inline

Get the all dimensions attribute of particle.

The attribute.

var getDynParticleAllDimensions ( )

inline

Get the all dimensions attribute of particle.

The attribute.

local getDynParticleAllDimensions ( )

inline

Get the all dimensions attribute of particle.

The attribute.

void setDynParticleAllDimensions ( PUDynamicAttribute * dynParticleAllDimensions )

Set the all dimensions attribute of particle.

The attribute.

var setDynParticleAllDimensions ( var dynParticleAllDimensions )

Set the all dimensions attribute of particle.

The attribute.

local setDynParticleAllDimensions ( local dynParticleAllDimensions )

Set the all dimensions attribute of particle.

The attribute.

void setDynParticleAllDimensionsSet ( bool particleAllDimensionsSet )

Whether use all dimensions setting.

Whether use.

var setDynParticleAllDimensionsSet ( var particleAllDimensionsSet )

Whether use all dimensions setting.

Whether use.

local
setDynParticleAllDimensionsSet ( local particleAllDimensionsSet )

Whether use all dimensions setting.

Whether use.

PUDynamicAttribute*
getDynParticleWidth ( void ) const

inline

Get the attribute of particle width.

The attribute.

var getDynParticleWidth ( )

inline

Get the attribute of particle width.

The attribute.

local getDynParticleWidth ( )

inline

Get the attribute of particle width.

The attribute.

void setDynParticleWidth ( PUDynamicAttribute * dynParticleWidth )

Set the attribute of particle width.

The attribute.

var setDynParticleWidth ( var dynParticleWidth )

Set the attribute of particle width.

The attribute.

local setDynParticleWidth ( local dynParticleWidth )

Set the attribute of particle width.

The attribute.

void setDynParticleWidthSet ( bool particleWidthSet )

Whether use the attribute of particle width.

Whether use.

var setDynParticleWidthSet ( var particleWidthSet )

Whether use the attribute of particle width.

Whether use.

local setDynParticleWidthSet ( local particleWidthSet )

Whether use the attribute of particle width.

Whether use.

PUDynamicAttribute*
getDynParticleHeight ( void ) const

inline

Get the attribute of particle height.

The attribute.

var getDynParticleHeight ( )

inline

Get the attribute of particle height.

The attribute.

local getDynParticleHeight ( )

inline

Get the attribute of particle height.

The attribute.

void setDynParticleHeight ( PUDynamicAttribute * dynParticleHeight )

Set the attribute of particle height.

The attribute.

var setDynParticleHeight ( var dynParticleHeight )

Set the attribute of particle height.

The attribute.

local setDynParticleHeight ( local dynParticleHeight )

Set the attribute of particle height.

The attribute.

void setDynParticleHeightSet ( bool particleHeightSet )

Whether use the attribute of particle height.

Whether use.

var setDynParticleHeightSet ( var particleHeightSet )

Whether use the attribute of particle height.

Whether use.

local setDynParticleHeightSet ( local particleHeightSet )

Whether use the attribute of particle height.

Whether use.

PUDynamicAttribute*
getDynParticleDepth ( void ) const

inline

Get the attribute of particle depth.

The attribute.

var getDynParticleDepth ( )

inline

Get the attribute of particle depth.

The attribute.

local getDynParticleDepth ( )

inline

Get the attribute of particle depth.

The attribute.

void setDynParticleDepth ( PUDynamicAttribute * dynParticleDepth )

Set the attribute of particle depth.

The attribute.

var setDynParticleDepth ( var dynParticleDepth )

Set the attribute of particle depth.

The attribute.

local setDynParticleDepth ( local dynParticleDepth )

Set the attribute of particle depth.

The attribute.

void setDynParticleDepthSet ( bool particleDepthSet )

Whether use the attribute of particle depth.

Whether use.

var setDynParticleDepthSet ( var particleDepthSet )

Whether use the attribute of particle depth.

Whether use.

local setDynParticleDepthSet ( local particleDepthSet )

Whether use the attribute of particle depth.

Whether use.

const std::string& getEmitsName ( void ) const

inline

Todo.

Get the name of emits. The name.

var getEmitsName ( )

inline

Todo.

Get the name of emits. The name.

local getEmitsName ( )

inline

Todo.

Get the name of emits. The name.

void setEmitsName ( const std::string & emitsName )

Set the name of emits.

The name.

var setEmitsName ( var emitsName )

Set the name of emits.

The name.

local setEmitsName ( local emitsName )

Set the name of emits.

The name.

PUParticle3D::ParticleType
getEmitsType ( ) const

inline

Get the type of emits.

The type.

var getEmitsType ( )

inline

Get the type of emits.

The type.

local getEmitsType ( )

inline

Get the type of emits.

The type.

void setEmitsType ( PUParticle3D::ParticleType type )

inline

Set the type of emits.

The type.

var setEmitsType ( var type )

inline

Set the type of emits.

The type.

local setEmitsType ( local type )

inline

Set the type of emits.

The type.

Ref* getEmitsEntityPtr ( ) const

Get the pointer of emits(PUEmitter, PUParticleSystem3D, etc).

The pointer of emits.

var getEmitsEntityPtr ( )

Get the pointer of emits(PUEmitter, PUParticleSystem3D, etc).

The pointer of emits.

local getEmitsEntityPtr ( )

Get the pointer of emits(PUEmitter, PUParticleSystem3D, etc).

The pointer of emits.

bool isMarkedForEmission ( ) const

inline

Whether this emitter marked for emission.

The pointer of emits.

var isMarkedForEmission ( )

inline

Whether this emitter marked for emission.

The pointer of emits.

local isMarkedForEmission ( )

inline

Whether this emitter marked for emission.

The pointer of emits.

void setMarkedForEmission ( bool isMarked )

inline

Set this emitter marked for emission.

Whether marked.

var setMarkedForEmission ( var isMarked )

inline

Set this emitter marked for emission.

Whether marked.

local setMarkedForEmission ( local isMarked )

inline

Set this emitter marked for emission.

Whether marked.

const Vec3& getParticleDirection ( void )

Returns the base direction of the particle that is going to be emitted.

The base direction of the particle.

var getParticleDirection ( )

Returns the base direction of the particle that is going to be emitted.

The base direction of the particle.

local getParticleDirection ( )

Returns the base direction of the particle that is going to be emitted.

The base direction of the particle.

const Vec3&
getOriginalParticleDirection ( void ) const

Returns the originally set particle direction.

This value is not affected by affectors, angle, etc. The originally set particle direction.

var getOriginalParticleDirection ( )

Returns the originally set particle direction.

This value is not affected by affectors, angle, etc. The originally set particle direction.

local getOriginalParticleDirection ( )

Returns the originally set particle direction.

This value is not affected by affectors, angle, etc. The originally set particle direction.

const Quaternion&
getParticleOrientation ( void ) const

Returns the base orientation of the particle that is going to be emitted.

The base orientation of the particle.

var getParticleOrientation ( )

Returns the base orientation of the particle that is going to be emitted.

The base orientation of the particle.

local getParticleOrientation ( )

Returns the base orientation of the particle that is going to be emitted.

The base orientation of the particle.

void setParticleOrientation ( const Quaternion & orientation )

Set the orientation of the particle.

The orientation.

var setParticleOrientation ( var orientation )

Set the orientation of the particle.

The orientation.

local setParticleOrientation ( local orientation )

Set the orientation of the particle.

The orientation.

void
setParticleOrientationRangeStart ( const Quaternion & orientationRangeStart )

Set start orientation of the particle that is going to be emitted.

The start orientation.

var
setParticleOrientationRangeStart ( var orientationRangeStart )

Set start orientation of the particle that is going to be emitted.

The start orientation.

local
setParticleOrientationRangeStart ( local orientationRangeStart )

Set start orientation of the particle that is going to be emitted.

The start orientation.

const Quaternion&
getParticleOrientationRangeEnd ( void ) const

Returns the end orientation of the particle that is going to be emitted.

The end orientation.

var getParticleOrientationRangeEnd ( )

Returns the end orientation of the particle that is going to be emitted.

The end orientation.

local
getParticleOrientationRangeEnd ( )

Returns the end orientation of the particle that is going to be emitted.

The end orientation.

void setParticleOrientationRangeEnd ( const Quaternion & orientationRangeEnd )

Set end orientation of the particle that is going to be emitted.

The end orientation.

var setParticleOrientationRangeEnd ( var orientationRangeEnd )

Set end orientation of the particle that is going to be emitted.

The end orientation.

local
setParticleOrientationRangeEnd ( local orientationRangeEnd )

Set end orientation of the particle that is going to be emitted.

The end orientation.

void setParticleDirection ( const Vec3 & direction )

Sets the direction of the particle that the emitter is emitting.

The base direction of emitted particles.

var setParticleDirection ( var direction )

Sets the direction of the particle that the emitter is emitting.

The base direction of emitted particles.

local setParticleDirection ( local direction )

Sets the direction of the particle that the emitter is emitting.

The base direction of emitted particles.

bool isAutoDirection ( void ) const

Whether use auto direction.

Whether use.

var isAutoDirection ( )

Whether use auto direction.

Whether use.

local isAutoDirection ( )

Whether use auto direction.

Whether use.

void setAutoDirection ( bool autoDirection )

Set use auto direction.

Whether use.

var setAutoDirection ( var autoDirection )

Set use auto direction.

Whether use.

local setAutoDirection ( local autoDirection )

Set use auto direction.

Whether use.

bool isForceEmission ( void ) const

Whether force emission.

Whether force.

var isForceEmission ( )

Whether force emission.

Whether force.

local isForceEmission ( )

Whether force emission.

Whether force.

void setForceEmission ( bool forceEmission )

Set force emission.

Whether force.

var setForceEmission ( var forceEmission )

Set force emission.

Whether force.

local setForceEmission ( local forceEmission )

Set force emission.

Whether force.

const Vec4& getParticleColor ( void ) const

Get the color of a particle that will be emitted.

The color of a particle.

var getParticleColor ( )

Get the color of a particle that will be emitted.

The color of a particle.

local getParticleColor ( )

Get the color of a particle that will be emitted.

The color of a particle.

void setParticleColor ( const Vec4 & particleColour )

Set the color of an emitted particle.

The color of a particle.

var setParticleColor ( var particleColour )

Set the color of an emitted particle.

The color of a particle.

local setParticleColor ( local particleColour )

Set the color of an emitted particle.

The color of a particle.

const Vec4&
getParticleColorRangeStart ( void ) const

Get the color range start of an emitted particle.

The color range start.

var getParticleColorRangeStart ( )

Get the color range start of an emitted particle.

The color range start.

local getParticleColorRangeStart ( )

Get the color range start of an emitted particle.

The color range start.

const Vec4&
getParticleColorRangeEnd ( void ) const

Get the color range end of an emitted particle.

The color range end.

var getParticleColorRangeEnd ( )

Get the color range end of an emitted particle.

The color range end.

local getParticleColorRangeEnd ( )

Get the color range end of an emitted particle.

The color range end.

const unsigned short&
getParticleTextureCoords ( void ) const

Get the texture coords of an emitted particle.

The texture coords.

var getParticleTextureCoords ( )

Get the texture coords of an emitted particle.

The texture coords.

local getParticleTextureCoords ( )

Get the texture coords of an emitted particle.

The texture coords.

void setParticleTextureCoords ( const unsigned short & particleTextureCoords )

Set the texture coords of an emitted particle.

The texture coords.

var setParticleTextureCoords ( var particleTextureCoords )

Set the texture coords of an emitted particle.

The texture coords.

local setParticleTextureCoords ( local particleTextureCoords )

Set the texture coords of an emitted particle.

The texture coords.

const unsigned short&
getParticleTextureCoordsRangeStart ( void ) const

Get the texture coords range start of an emitted particle.

The texture coords range start.

var
getParticleTextureCoordsRangeStart ( )

Get the texture coords range start of an emitted particle.

The texture coords range start.

local
getParticleTextureCoordsRangeStart ( )

Get the texture coords range start of an emitted particle.

The texture coords range start.

void
setParticleTextureCoordsRangeStart ( const unsigned short & particleTextureCoordsRangeStart )

Set the texture coords range start of an emitted particle.

The texture coords range start.

var
setParticleTextureCoordsRangeStart ( var particleTextureCoordsRangeStart )

Set the texture coords range start of an emitted particle.

The texture coords range start.

local
setParticleTextureCoordsRangeStart ( local particleTextureCoordsRangeStart )

Set the texture coords range start of an emitted particle.

The texture coords range start.

const unsigned short&
getParticleTextureCoordsRangeEnd ( void ) const

Get the texture coords range end of an emitted particle.

The texture coords range end.

var
getParticleTextureCoordsRangeEnd ( )

Get the texture coords range end of an emitted particle.

The texture coords range end.

local
getParticleTextureCoordsRangeEnd ( )

Get the texture coords range end of an emitted particle.

The texture coords range end.

void
setParticleTextureCoordsRangeEnd ( const unsigned short & particleTextureCoordsRangeEnd )

Set the texture coords range end of an emitted particle.

The texture coords range end.

var
setParticleTextureCoordsRangeEnd ( var particleTextureCoordsRangeEnd )

Set the texture coords range end of an emitted particle.

The texture coords range end.

local
setParticleTextureCoordsRangeEnd ( local particleTextureCoordsRangeEnd )

Set the texture coords range end of an emitted particle.

The texture coords range end.

bool isKeepLocal ( void ) const

Whether use local coordinate system.

Whether use.

var isKeepLocal ( )

Whether use local coordinate system.

Whether use.

local isKeepLocal ( )

Whether use local coordinate system.

Whether use.

void setKeepLocal ( bool keepLocal )

Set use local coordinate system, If this attribute is set to 'true', the particles are emitted relative to the emitter.

Whether use.

var setKeepLocal ( var keepLocal )

Set use local coordinate system, If this attribute is set to 'true', the particles are emitted relative to the emitter.

Whether use.

local setKeepLocal ( local keepLocal )

Set use local coordinate system, If this attribute is set to 'true', the particles are emitted relative to the emitter.

Whether use.

virtual void copyAttributesTo ( PUEmitter * emitter )

virtual

Copy attributes to another emitter(internal method).

The emitter.

Reimplemented in PUMeshSurfaceEmitter.

var copyAttributesTo ( var emitter )

virtual

Copy attributes to another emitter(internal method).

The emitter.

Reimplemented in PUMeshSurfaceEmitter.

local copyAttributesTo ( local emitter )

virtual

Copy attributes to another emitter(internal method).

The emitter.

Reimplemented in PUMeshSurfaceEmitter.

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

CCPUEmitter.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation