3d particle emitter More...

#include <CCPUEmitter.h>

Inheritance diagram for PUEmitter:

Public Member Functions
	PUEmitter ()
virtual	~PUEmitter ()
virtual void	notifyStart ()
virtual void	notifyStop ()
virtual void	notifyPause ()
virtual void	notifyResume ()
virtual void	notifyRescaled (const Vec3 &scale)
local	notifyRescaled ( local scale)
virtual void	prepare ()
virtual void	unPrepare ()
virtual void	preUpdateEmitter (float deltaTime)
local	preUpdateEmitter ( local deltaTime)
virtual void	updateEmitter (Particle3D *particle, float deltaTime) override
var	updateEmitter ( var particle, var deltaTime)
local	updateEmitter ( local particle, local deltaTime)
virtual void	postUpdateEmitter (float deltaTime)
local	postUpdateEmitter ( local deltaTime)
virtual unsigned short	calculateRequestedParticles (float timeElapsed)
var	calculateRequestedParticles ( var timeElapsed)
local	calculateRequestedParticles ( local timeElapsed)
virtual void	emit (int count) override
var	emit ( var count)
local	emit ( local count)
void	setLocalPosition (const Vec3 &pos)
const Vec3	getLocalPosition () const
const Vec3 &	getDerivedPosition ()
	Calculate the derived position of the affector. More...

var	getDerivedPosition ()
	Calculate the derived position of the affector. More...

local	getDerivedPosition ()
	Calculate the derived position of the affector. More...

void	setEnabled (bool enabled)
	Enables or disables the emitter. More...

bool	isEnabled (void) const
bool	isEmitterDone () const
const std::string &	getEmitterType (void) const
	Todo. More...

local	getEmitterType ()
	Todo. More...

void	setEmitterType (const std::string &emitterType)
const std::string &	getName (void) const
	Todo. More...

local	getName ()
	Todo. More...

void	setName (const std::string &name)
PUDynamicAttribute *	getDynAngle (void) const
	Todo. More...

local	getDynAngle ()
	Todo. More...

void	setDynAngle (PUDynamicAttribute *dynAngle)
PUDynamicAttribute *	getDynEmissionRate (void) const
	Todo. More...

void	setDynEmissionRate (PUDynamicAttribute *dynEmissionRate)
PUDynamicAttribute *	getDynTotalTimeToLive (void) const
	Todo. More...

local	getDynTotalTimeToLive ()
	Todo. More...

void	setDynTotalTimeToLive (PUDynamicAttribute *dynTotalTimeToLive)
PUDynamicAttribute *	getDynParticleMass (void) const
	Todo. More...

local	getDynParticleMass ()
	Todo. More...

void	setDynParticleMass (PUDynamicAttribute *dynParticleMass)
PUDynamicAttribute *	getDynVelocity (void) const
	Todo. More...

void	setDynVelocity (PUDynamicAttribute *dynVelocity)
PUDynamicAttribute *	getDynDuration (void) const
	Todo. More...

void	setDynDuration (PUDynamicAttribute *dynDuration)
void	setDynDurationSet (bool durationSet)
PUDynamicAttribute *	getDynRepeatDelay (void) const
	Todo. More...

void	setDynRepeatDelay (PUDynamicAttribute *dynRepeatDelay)
void	setDynRepeatDelaySet (bool repeatDelaySet)
PUDynamicAttribute *	getDynParticleAllDimensions (void) const
	Todo. More...

void	setDynParticleAllDimensions (PUDynamicAttribute *dynParticleAllDimensions)
void	setDynParticleAllDimensionsSet (bool particleAllDimensionsSet)
PUDynamicAttribute *	getDynParticleWidth (void) const
	Todo. More...

void	setDynParticleWidth (PUDynamicAttribute *dynParticleWidth)
void	setDynParticleWidthSet (bool particleWidthSet)
PUDynamicAttribute *	getDynParticleHeight (void) const
	Todo. More...

void	setDynParticleHeight (PUDynamicAttribute *dynParticleHeight)
void	setDynParticleHeightSet (bool particleHeightSet)
PUDynamicAttribute *	getDynParticleDepth (void) const
	Todo. More...

void	setDynParticleDepth (PUDynamicAttribute *dynParticleDepth)
void	setDynParticleDepthSet (bool particleDepthSet)
const std::string &	getEmitsName (void) const
	Todo. More...

void	setEmitsName (const std::string &emitsName)
PUParticle3D::ParticleType	getEmitsType () const
local	getEmitsType ()
void	setEmitsType (PUParticle3D::ParticleType type)
Ref *	getEmitsEntityPtr () const
bool	isMarkedForEmission () const
void	setMarkedForEmission (bool isMarked)
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...

local	getOriginalParticleDirection ()
	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. More...

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...

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
	Todo. More...

void	setAutoDirection (bool autoDirection)
	Todo. More...

var	setAutoDirection ( var autoDirection)
	Todo. More...

local	setAutoDirection ( local autoDirection)
	Todo. More...

bool	isForceEmission (void) const
	Todo. More...

void	setForceEmission (bool forceEmission)
	Todo. More...

var	setForceEmission ( var forceEmission)
	Todo. More...

local	setForceEmission ( local forceEmission)
	Todo. More...

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

var	getParticleColor ()
	Get the colour of a particle that will be emitted. More...

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

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

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

var	getParticleColorRangeStart ()
	Get the colour range start of an emitted particle. More...

local	getParticleColorRangeStart ()
	Get the colour range start of an emitted particle. More...

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

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

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

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...

local	getParticleTextureCoordsRangeStart ()
	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...

var	setParticleTextureCoordsRangeStart ( var particleTextureCoordsRangeStart)
	Set the texture coords range start of an emitted particle. More...

local	setParticleTextureCoordsRangeStart ( local 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...

var	setParticleTextureCoordsRangeEnd ( var particleTextureCoordsRangeEnd)
	Set the texture coords range end of an emitted particle. More...

local	setParticleTextureCoordsRangeEnd ( local particleTextureCoordsRangeEnd)
	Set the texture coords range end of an emitted particle. More...

bool	isKeepLocal (void) const
	Todo. More...

void	setKeepLocal (bool keepLocal)
	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. More...

virtual PUEmitter *	clone ()=0
local	clone ()
virtual void	copyAttributesTo (PUEmitter *emitter)
local	copyAttributesTo ( local emitter)
Public Member Functions inherited from Particle3DEmitter
void	setEnabled (bool enabled)
	Enables or disables the emitter. More...

bool	isEnabled (void) const
virtual	~Particle3DEmitter ()
Public Member Functions inherited from Ref
void	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...

virtual	~Ref ()
	Destructor. More...

Static Public Attributes
static const bool	DEFAULT_ENABLED
var	DEFAULT_ENABLED
local	DEFAULT_ENABLED
static const Vec3	DEFAULT_POSITION
var	DEFAULT_POSITION
local	DEFAULT_POSITION
static const bool	DEFAULT_KEEP_LOCAL
var	DEFAULT_KEEP_LOCAL
local	DEFAULT_KEEP_LOCAL
static const Vec3	DEFAULT_DIRECTION
var	DEFAULT_DIRECTION
local	DEFAULT_DIRECTION
static const Quaternion	DEFAULT_ORIENTATION
var	DEFAULT_ORIENTATION
local	DEFAULT_ORIENTATION
static const Quaternion	DEFAULT_ORIENTATION_RANGE_START
var	DEFAULT_ORIENTATION_RANGE_START
local	DEFAULT_ORIENTATION_RANGE_START
static const Quaternion	DEFAULT_ORIENTATION_RANGE_END
var	DEFAULT_ORIENTATION_RANGE_END
local	DEFAULT_ORIENTATION_RANGE_END
static const unsigned short	DEFAULT_START_TEXTURE_COORDS
var	DEFAULT_START_TEXTURE_COORDS
local	DEFAULT_START_TEXTURE_COORDS
static const unsigned short	DEFAULT_END_TEXTURE_COORDS
static const unsigned short	DEFAULT_TEXTURE_COORDS
var	DEFAULT_TEXTURE_COORDS
local	DEFAULT_TEXTURE_COORDS
static const Vec4	DEFAULT_START_COLOUR_RANGE
var	DEFAULT_START_COLOUR_RANGE
local	DEFAULT_START_COLOUR_RANGE
static const Vec4	DEFAULT_END_COLOUR_RANGE
var	DEFAULT_END_COLOUR_RANGE
local	DEFAULT_END_COLOUR_RANGE
static const Vec4	DEFAULT_COLOUR
static const bool	DEFAULT_AUTO_DIRECTION
static const bool	DEFAULT_FORCE_EMISSION
var	DEFAULT_FORCE_EMISSION
local	DEFAULT_FORCE_EMISSION
static const float	DEFAULT_EMISSION_RATE
var	DEFAULT_EMISSION_RATE
local	DEFAULT_EMISSION_RATE
static const float	DEFAULT_TIME_TO_LIVE
var	DEFAULT_TIME_TO_LIVE
local	DEFAULT_TIME_TO_LIVE
static const float	DEFAULT_MASS
static const float	DEFAULT_VELOCITY
static const float	DEFAULT_DURATION
var	DEFAULT_DURATION
local	DEFAULT_DURATION
static const float	DEFAULT_REPEAT_DELAY
var	DEFAULT_REPEAT_DELAY
local	DEFAULT_REPEAT_DELAY
static const float	DEFAULT_ANGLE
static const float	DEFAULT_DIMENSIONS
var	DEFAULT_DIMENSIONS
local	DEFAULT_DIMENSIONS
static const float	DEFAULT_WIDTH
local	DEFAULT_WIDTH
static const float	DEFAULT_HEIGHT
static const float	DEFAULT_DEPTH
var	DEFAULT_DEPTH
local	DEFAULT_DEPTH

Protected Member Functions
virtual void	initParticlePosition (PUParticle3D *particle)
	Todo. More...

local	initParticlePosition ( local particle)
	Todo. More...

virtual void	initParticleDirection (PUParticle3D *particle)
	Internal method for generating the particle direction. More...

var	initParticleDirection ( var particle)
	Internal method for generating the particle direction. More...

local	initParticleDirection ( local particle)
	Internal method for generating the particle direction. More...

virtual void	initParticleOrientation (PUParticle3D *particle)
	Internal method for generating the particle orientation. More...

var	initParticleOrientation ( var particle)
	Internal method for generating the particle orientation. More...

local	initParticleOrientation ( local particle)
	Internal method for generating the particle orientation. More...

virtual void	initParticleVelocity (PUParticle3D *particle)
virtual void	initParticleMass (PUParticle3D *particle)
var	initParticleMass ( var particle)
local	initParticleMass ( local particle)
virtual void	initParticleColor (PUParticle3D *particle)
virtual void	initParticleTextureCoords (PUParticle3D *particle)
virtual float	initParticleTimeToLive ()
virtual void	initParticleDimensions (PUParticle3D *particle)
local	initParticleDimensions ( local particle)
virtual void	initParticleForEmission (PUParticle3D *particle)
var	initParticleForEmission ( var particle)
local	initParticleForEmission ( local particle)
void	initTimeBased (void)
	Initialise some attributes that are time-based. More...

void	generateAngle (float &angle)
	Internal method for generating the angle. More...

Protected Member Functions inherited from Ref
	Ref ()
	Constructor. More...

	Ref ()
	Constructor. More...

Protected Attributes
Vec3	_position
Vec3	_latestPosition
Vec3	_latestPositionDiff
Vec3	_derivedPosition
Vec3	_emitterScale
	Although the scale is on a Particle System level, the emitter can also be scaled. More...

std::string	_emitterType
std::string	_name
Vec3	_particleDirection
	Direction (and speed) of the emitted particle. More...

var	_particleDirection
	Direction (and speed) of the emitted particle. More...

local	_particleDirection
	Direction (and speed) of the emitted particle. More...

Vec3	_originalParticleDirection
	The original direction of the emitted particle. More...

Quaternion	_particleOrientation
	Orientation of the particle as soon as it is emitted. More...

Quaternion	_particleOrientationRangeStart
	If set, the range generates a random orientation between start and end. More...

Quaternion	_particleOrientationRangeEnd
bool	_particleOrientationRangeSet
PUDynamicAttribute *	_dynAngle
PUDynamicAttribute *	_dynEmissionRate
std::string	_emitsName
PUDynamicAttribute *	_dynTotalTimeToLive
	Dynamic attribute used to generate the total time to live. More...

var	_dynTotalTimeToLive
	Dynamic attribute used to generate the total time to live. More...

local	_dynTotalTimeToLive
	Dynamic attribute used to generate the total time to live. More...

PUDynamicAttribute *	_dynParticleMass
	Dynamic attribute used to generate the mass of a particle. More...

var	_dynParticleMass
	Dynamic attribute used to generate the mass of a particle. More...

local	_dynParticleMass
	Dynamic attribute used to generate the mass of a particle. More...

PUDynamicAttribute *	_dynVelocity
	Dynamic attribute used to generate the velocity of a particle. More...

PUDynamicAttribute *	_dynDuration
	Dynamic attribute used to define the duration of the emitter. More...

var	_dynDuration
	Dynamic attribute used to define the duration of the emitter. More...

local	_dynDuration
	Dynamic attribute used to define the duration of the emitter. More...

PUDynamicAttribute *	_dynRepeatDelay
	Dynamic attribute used to define the repeat/delay of the emitter. More...

PUDynamicAttribute *	_dynParticleAllDimensions
	Dynamic attribute used to define the (own) dimensions of a particle. More...

var	_dynParticleAllDimensions
	Dynamic attribute used to define the (own) dimensions of a particle. More...

local	_dynParticleAllDimensions
	Dynamic attribute used to define the (own) dimensions of a particle. More...

bool	_dynParticleAllDimensionsSet
PUDynamicAttribute *	_dynParticleWidth
	Dynamic attribute used to define the (own) width of a particle. More...

bool	_dynParticleWidthSet
PUDynamicAttribute *	_dynParticleHeight
	Dynamic attribute used to define the (own) height of a particle. More...

bool	_dynParticleHeightSet
PUDynamicAttribute *	_dynParticleDepth
	Dynamic attribute used to define the (own) depth of a particle. More...

bool	_dynParticleDepthSet
Vec3	_upVector
	Notional up vector, just used to speed up generation of variant directions. More...

float	_remainder
	Particles that are left to be emitted from the previous time. More...

PUDynamicAttributeHelper	_dynamicAttributeHelper
	Helper factory. More...

var	_dynamicAttributeHelper
	Helper factory. More...

float	_durationRemain
	Duration remainder. More...

bool	_dynDurationSet
	Indication to determine whether duration is set. More...

float	_repeatDelayRemain
	Repeat/delay remainder. More...

bool	_dynRepeatDelaySet
	Indication to determine whether repeat/delay is set. More...

bool	_autoDirection
	Auto direction means that the direction of a particle is not determined by the direction vector that has been set, but the direction vector is generated based on the shape of the emitter. More...

bool	_forceEmission
	In normal cases, emission is regulated by time. More...

bool	_originalForceEmission
	Original value, used to set it back. More...

bool	_forceEmissionExecuted
	If mForceEmission has been set to true and if all particles are emitted, the mForceEmissionExecuted is also set to true, preventing any further 'forced emission'. More...

bool	_originalForceEmissionExecuted
	Original value, used to set it back. More...

Vec4	_particleColor
	Colour that is assigned to an emitted particle. More...

Vec4	_particleColorRangeStart
	Used to randomize the colour of an emitted particle. More...

Vec4	_particleColorRangeEnd
	Used to randomize the colour of an emitted particle. More...

bool	_particleColorRangeSet
	Used to determine whether the colour range has been set. More...

bool	_keepLocal
	Determines whether particle positions should be kept local in relation to the emitter. More...

unsigned short	_particleTextureCoords
	Texture coords that is assigned to an emitted particle (only works if the renderer uses it) More...

var	_particleTextureCoords
	Texture coords that is assigned to an emitted particle (only works if the renderer uses it) More...

local	_particleTextureCoords
	Texture coords that is assigned to an emitted particle (only works if the renderer uses it) More...

unsigned short	_particleTextureCoordsRangeStart
	Used to randomize the texture coords of an emitted particle. More...

unsigned short	_particleTextureCoordsRangeEnd
	Used to randomize the texture coords of an emitted particle. More...

bool	_particleTextureCoordsRangeSet
	Used to determine whether the texture coords range has been set. More...

bool	_originEnabled
bool	_originEnabledSet
PUParticle3D::ParticleType	_emitsType
var	_emitsType
local	_emitsType
Ref *	_emitsEntity
bool	_isMarkedForEmission
Protected Attributes inherited from Particle3DEmitter
ParticleSystem3D *	_particleSystem
int	_emitRate
bool	_isEnabled
Protected Attributes inherited from Ref
unsigned int	_referenceCount
	count of references More...

local	_referenceCount
	count of references More...

Friends
class	PUParticleSystem3D

Additional Inherited Members
Public Attributes inherited from Particle3DEmitter
CC_CONSTRUCTOR_ACCESS	__pad0__: Particle3DEmitter()
var	__pad0__: Particle3DEmitter()
local	__pad0__: Particle3DEmitter()

Detailed Description

3d particle emitter

Constructor & Destructor Documentation

PUEmitter ( )

var PUEmitter ( )

local PUEmitter ( )

virtual ~PUEmitter ( )

virtual

var ~PUEmitter ( )

virtual

local ~PUEmitter ( )

virtual

Member Function Documentation

virtual unsigned short
calculateRequestedParticles ( float timeElapsed )

virtual

Reimplemented in PUMeshSurfaceEmitter, PUPositionEmitter, and PULineEmitter.

var calculateRequestedParticles ( var timeElapsed )

virtual

Reimplemented in PUMeshSurfaceEmitter, PUPositionEmitter, and PULineEmitter.

local calculateRequestedParticles ( local timeElapsed )

virtual

Reimplemented in PUMeshSurfaceEmitter, PUPositionEmitter, and PULineEmitter.

virtual PUEmitter* clone ( )

pure virtual

Implemented in PUMeshSurfaceEmitter, PULineEmitter, PUSlaveEmitter, PUCircleEmitter, PUPositionEmitter, CCPUBoxEmitter, PUSphereSurfaceEmitter, and PUPointEmitter.

var clone ( )

pure virtual

Implemented in PUMeshSurfaceEmitter, PULineEmitter, PUSlaveEmitter, PUCircleEmitter, PUPositionEmitter, CCPUBoxEmitter, PUSphereSurfaceEmitter, and PUPointEmitter.

local clone ( )

pure virtual

Implemented in PUMeshSurfaceEmitter, PULineEmitter, PUSlaveEmitter, PUCircleEmitter, PUPositionEmitter, CCPUBoxEmitter, PUSphereSurfaceEmitter, and PUPointEmitter.

virtual void copyAttributesTo ( PUEmitter * emitter )

virtual

Reimplemented in PUMeshSurfaceEmitter, PULineEmitter, PUSlaveEmitter, PUCircleEmitter, PUPositionEmitter, CCPUBoxEmitter, PUSphereSurfaceEmitter, and PUPointEmitter.

var copyAttributesTo ( var emitter )

virtual

Reimplemented in PUMeshSurfaceEmitter, PULineEmitter, PUSlaveEmitter, PUCircleEmitter, PUPositionEmitter, CCPUBoxEmitter, PUSphereSurfaceEmitter, and PUPointEmitter.

local copyAttributesTo ( local emitter )

virtual

Reimplemented in PUMeshSurfaceEmitter, PULineEmitter, PUSlaveEmitter, PUCircleEmitter, PUPositionEmitter, CCPUBoxEmitter, PUSphereSurfaceEmitter, and PUPointEmitter.

virtual void emit ( int count )

overridevirtual

Reimplemented from Particle3DEmitter.

var emit ( var count )

overridevirtual

Reimplemented from Particle3DEmitter.

local emit ( local count )

overridevirtual

Reimplemented from Particle3DEmitter.

void generateAngle ( float & angle )

protected

Internal method for generating the angle.

var generateAngle ( var angle )

protected

Internal method for generating the angle.

local generateAngle ( local angle )

protected

Internal method for generating the angle.

const Vec3& getDerivedPosition ( )

Calculate the derived position of the affector.

Remarks: Note, that in script, the position is set as localspace, while if the affector is emitted, its position is automatically transformed. This function always returns the derived position.

var getDerivedPosition ( )

Calculate the derived position of the affector.

Remarks: Note, that in script, the position is set as localspace, while if the affector is emitted, its position is automatically transformed. This function always returns the derived position.

local getDerivedPosition ( )

Calculate the derived position of the affector.

Remarks: Note, that in script, the position is set as localspace, while if the affector is emitted, its position is automatically transformed. This function always returns the derived position.

PUDynamicAttribute* getDynAngle ( void ) const

inline

Todo.

var getDynAngle ( )

inline

Todo.

local getDynAngle ( )

inline

Todo.

PUDynamicAttribute* getDynDuration ( void ) const

inline

Todo.

var getDynDuration ( )

inline

Todo.

local getDynDuration ( )

inline

Todo.

PUDynamicAttribute*
getDynEmissionRate ( void ) const

inline

Todo.

var getDynEmissionRate ( )

inline

Todo.

local getDynEmissionRate ( )

inline

Todo.

PUDynamicAttribute*
getDynParticleAllDimensions ( void ) const

inline

Todo.

var getDynParticleAllDimensions ( )

inline

Todo.

local getDynParticleAllDimensions ( )

inline

Todo.

PUDynamicAttribute*
getDynParticleDepth ( void ) const

inline

Todo.

var getDynParticleDepth ( )

inline

Todo.

local getDynParticleDepth ( )

inline

Todo.

PUDynamicAttribute*
getDynParticleHeight ( void ) const

inline

Todo.

var getDynParticleHeight ( )

inline

Todo.

local getDynParticleHeight ( )

inline

Todo.

PUDynamicAttribute*
getDynParticleMass ( void ) const

inline

Todo.

var getDynParticleMass ( )

inline

Todo.

local getDynParticleMass ( )

inline

Todo.

PUDynamicAttribute*
getDynParticleWidth ( void ) const

inline

Todo.

var getDynParticleWidth ( )

inline

Todo.

local getDynParticleWidth ( )

inline

Todo.

PUDynamicAttribute*
getDynRepeatDelay ( void ) const

inline

Todo.

var getDynRepeatDelay ( )

inline

Todo.

local getDynRepeatDelay ( )

inline

Todo.

PUDynamicAttribute*
getDynTotalTimeToLive ( void ) const

inline

Todo.

var getDynTotalTimeToLive ( )

inline

Todo.

local getDynTotalTimeToLive ( )

inline

Todo.

PUDynamicAttribute* getDynVelocity ( void ) const

inline

Todo.

var getDynVelocity ( )

inline

Todo.

local getDynVelocity ( )

inline

Todo.

Ref* getEmitsEntityPtr ( ) const

var getEmitsEntityPtr ( )

local getEmitsEntityPtr ( )

const std::string& getEmitsName ( void ) const

inline

Todo.

Todo

var getEmitsName ( )

inline

Todo.

Todo

local getEmitsName ( )

inline

Todo.

Todo

PUParticle3D::ParticleType
getEmitsType ( ) const

inline

var getEmitsType ( )

inline

local getEmitsType ( )

inline

const std::string& getEmitterType ( void ) const

inline

Todo.

var getEmitterType ( )

inline

Todo.

local getEmitterType ( )

inline

Todo.

const Vec3 getLocalPosition ( ) const

inline

var getLocalPosition ( )

inline

local getLocalPosition ( )

inline

const std::string& getName ( void ) const

inline

Todo.

var getName ( )

inline

Todo.

local getName ( )

inline

Todo.

const Vec3&
getOriginalParticleDirection ( void ) const

Returns the originally set particle direction.

This value is not affected by affectors, angle, etc.

var getOriginalParticleDirection ( )

Returns the originally set particle direction.

This value is not affected by affectors, angle, etc.

local getOriginalParticleDirection ( )

Returns the originally set particle direction.

This value is not affected by affectors, angle, etc.

const Vec4& getParticleColor ( void ) const

Get the colour of a particle that will be emitted.

var getParticleColor ( )

Get the colour of a particle that will be emitted.

local getParticleColor ( )

Get the colour of a particle that will be emitted.

const Vec4&
getParticleColorRangeEnd ( void ) const

Get the colour range end of an emitted particle.

var getParticleColorRangeEnd ( )

Get the colour range end of an emitted particle.

local getParticleColorRangeEnd ( )

Get the colour range end of an emitted particle.

const Vec4&
getParticleColorRangeStart ( void ) const

Get the colour range start of an emitted particle.

var getParticleColorRangeStart ( )

Get the colour range start of an emitted particle.

local getParticleColorRangeStart ( )

Get the colour range start of an emitted particle.

const Vec3& getParticleDirection ( void )

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

var getParticleDirection ( )

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

local getParticleDirection ( )

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

const Quaternion&
getParticleOrientation ( void ) const

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

var getParticleOrientation ( )

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

local getParticleOrientation ( )

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

const Quaternion&
getParticleOrientationRangeEnd ( void ) const

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

Remarks: The orientation is generated random between mParticleOrientationRangeStart and mParticleOrientationRangeEnd.

var getParticleOrientationRangeEnd ( )

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

Remarks: The orientation is generated random between mParticleOrientationRangeStart and mParticleOrientationRangeEnd.

local
getParticleOrientationRangeEnd ( )

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

Remarks: The orientation is generated random between mParticleOrientationRangeStart and mParticleOrientationRangeEnd.

const Quaternion&
getParticleOrientationRangeStart ( void ) const

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

Remarks: The orientation is generated random between mParticleOrientationRangeStart and mParticleOrientationRangeEnd.

var
getParticleOrientationRangeStart ( )

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

Remarks: The orientation is generated random between mParticleOrientationRangeStart and mParticleOrientationRangeEnd.

local
getParticleOrientationRangeStart ( )

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

Remarks: The orientation is generated random between mParticleOrientationRangeStart and mParticleOrientationRangeEnd.

const unsigned short&
getParticleTextureCoords ( void ) const

Get the texture coords of an emitted particle.

var getParticleTextureCoords ( )

Get the texture coords of an emitted particle.

local getParticleTextureCoords ( )

Get the texture coords of an emitted particle.

const unsigned short&
getParticleTextureCoordsRangeEnd ( void ) const

Get the texture coords range end of an emitted particle.

var
getParticleTextureCoordsRangeEnd ( )

Get the texture coords range end of an emitted particle.

local
getParticleTextureCoordsRangeEnd ( )

Get the texture coords range end of an emitted particle.

const unsigned short&
getParticleTextureCoordsRangeStart ( void ) const

Get the texture coords range start of an emitted particle.

var
getParticleTextureCoordsRangeStart ( )

Get the texture coords range start of an emitted particle.

local
getParticleTextureCoordsRangeStart ( )

Get the texture coords range start of an emitted particle.

virtual void initParticleColor ( PUParticle3D * particle )

protectedvirtual

var initParticleColor ( var particle )

protectedvirtual

local initParticleColor ( local particle )

protectedvirtual

virtual void initParticleDimensions ( PUParticle3D * particle )

protectedvirtual

var initParticleDimensions ( var particle )

protectedvirtual

local initParticleDimensions ( local particle )

protectedvirtual

virtual void initParticleDirection ( PUParticle3D * particle )

protectedvirtual

Internal method for generating the particle direction.

Reimplemented in PUMeshSurfaceEmitter, PUCircleEmitter, PULineEmitter, PUSlaveEmitter, and PUSphereSurfaceEmitter.

var initParticleDirection ( var particle )

protectedvirtual

Internal method for generating the particle direction.

Reimplemented in PUMeshSurfaceEmitter, PUCircleEmitter, PULineEmitter, PUSlaveEmitter, and PUSphereSurfaceEmitter.

local initParticleDirection ( local particle )

protectedvirtual

Internal method for generating the particle direction.

Reimplemented in PUMeshSurfaceEmitter, PUCircleEmitter, PULineEmitter, PUSlaveEmitter, and PUSphereSurfaceEmitter.

virtual void
initParticleForEmission ( PUParticle3D * particle )

protectedvirtual

var initParticleForEmission ( var particle )

protectedvirtual

local initParticleForEmission ( local particle )

protectedvirtual

virtual void initParticleMass ( PUParticle3D * particle )

protectedvirtual

var initParticleMass ( var particle )

protectedvirtual

local initParticleMass ( local particle )

protectedvirtual

virtual void
initParticleOrientation ( PUParticle3D * particle )

protectedvirtual

Internal method for generating the particle orientation.

var initParticleOrientation ( var particle )

protectedvirtual

Internal method for generating the particle orientation.

local initParticleOrientation ( local particle )

protectedvirtual

Internal method for generating the particle orientation.

virtual void initParticlePosition ( PUParticle3D * particle )

protectedvirtual

Todo.

Reimplemented in PUMeshSurfaceEmitter, PUCircleEmitter, PULineEmitter, PUPositionEmitter, CCPUBoxEmitter, PUSlaveEmitter, and PUSphereSurfaceEmitter.

var initParticlePosition ( var particle )

protectedvirtual

Todo.

Reimplemented in PUMeshSurfaceEmitter, PUCircleEmitter, PULineEmitter, PUPositionEmitter, CCPUBoxEmitter, PUSlaveEmitter, and PUSphereSurfaceEmitter.

local initParticlePosition ( local particle )

protectedvirtual

Todo.

Reimplemented in PUMeshSurfaceEmitter, PUCircleEmitter, PULineEmitter, PUPositionEmitter, CCPUBoxEmitter, PUSlaveEmitter, and PUSphereSurfaceEmitter.

virtual void
initParticleTextureCoords ( PUParticle3D * particle )

protectedvirtual

var initParticleTextureCoords ( var particle )

protectedvirtual

local initParticleTextureCoords ( local particle )

protectedvirtual

virtual float
initParticleTimeToLive ( )

protectedvirtual

var initParticleTimeToLive ( )

protectedvirtual

local initParticleTimeToLive ( )

protectedvirtual

virtual void initParticleVelocity ( PUParticle3D * particle )

protectedvirtual

var initParticleVelocity ( var particle )

protectedvirtual

local initParticleVelocity ( local particle )

protectedvirtual

void initTimeBased ( void )

inlineprotected

Initialise some attributes that are time-based.

var initTimeBased ( )

inlineprotected

Initialise some attributes that are time-based.

local initTimeBased ( )

inlineprotected

Initialise some attributes that are time-based.

bool isAutoDirection ( void ) const

Todo.

var isAutoDirection ( )

Todo.

local isAutoDirection ( )

Todo.

bool isEmitterDone ( ) const

var isEmitterDone ( )

local isEmitterDone ( )

bool isEnabled ( void ) const

var isEnabled ( )

local isEnabled ( )

bool isForceEmission ( void ) const

Todo.

var isForceEmission ( )

Todo.

local isForceEmission ( )

Todo.

bool isKeepLocal ( void ) const

Todo.

var isKeepLocal ( )

Todo.

local isKeepLocal ( )

Todo.

bool isMarkedForEmission ( ) const

inline

var isMarkedForEmission ( )

inline

local isMarkedForEmission ( )

inline

bool makeParticleLocal ( PUParticle3D * particle )

Transforms the particle position in a local position relative to the emitter.

var makeParticleLocal ( var particle )

Transforms the particle position in a local position relative to the emitter.

local makeParticleLocal ( local particle )

Transforms the particle position in a local position relative to the emitter.

virtual void notifyPause ( )

virtual

var notifyPause ( )

virtual

local notifyPause ( )

virtual

virtual void notifyRescaled ( const Vec3 & scale )

virtual

Reimplemented in PULineEmitter.

var notifyRescaled ( var scale )

virtual

Reimplemented in PULineEmitter.

local notifyRescaled ( local scale )

virtual

Reimplemented in PULineEmitter.

virtual void notifyResume ( )

virtual

var notifyResume ( )

virtual

local notifyResume ( )

virtual

virtual void notifyStart ( )

virtual

Reimplemented in PUCircleEmitter, PUSlaveEmitter, PUPositionEmitter, and PULineEmitter.

var notifyStart ( )

virtual

Reimplemented in PUCircleEmitter, PUSlaveEmitter, PUPositionEmitter, and PULineEmitter.

local notifyStart ( )

virtual

Reimplemented in PUCircleEmitter, PUSlaveEmitter, PUPositionEmitter, and PULineEmitter.

virtual void notifyStop ( )

virtual

var notifyStop ( )

virtual

local notifyStop ( )

virtual

virtual void postUpdateEmitter ( float deltaTime )

virtual

var postUpdateEmitter ( var deltaTime )

virtual

local postUpdateEmitter ( local deltaTime )

virtual

virtual void prepare ( )

virtual

Reimplemented in PUMeshSurfaceEmitter, and PUSlaveEmitter.

var prepare ( )

virtual

Reimplemented in PUMeshSurfaceEmitter, and PUSlaveEmitter.

local prepare ( )

virtual

Reimplemented in PUMeshSurfaceEmitter, and PUSlaveEmitter.

virtual void preUpdateEmitter ( float deltaTime )

virtual

var preUpdateEmitter ( var deltaTime )

virtual

local preUpdateEmitter ( local deltaTime )

virtual

void setAutoDirection ( bool autoDirection )

Todo.

var setAutoDirection ( var autoDirection )

Todo.

local setAutoDirection ( local autoDirection )

Todo.

void setDynAngle ( PUDynamicAttribute * dynAngle )

var setDynAngle ( var dynAngle )

local setDynAngle ( local dynAngle )

void setDynDuration ( PUDynamicAttribute * dynDuration )

var setDynDuration ( var dynDuration )

local setDynDuration ( local dynDuration )

void setDynDurationSet ( bool durationSet )

var setDynDurationSet ( var durationSet )

local setDynDurationSet ( local durationSet )

void setDynEmissionRate ( PUDynamicAttribute * dynEmissionRate )

var setDynEmissionRate ( var dynEmissionRate )

local setDynEmissionRate ( local dynEmissionRate )

void setDynParticleAllDimensions ( PUDynamicAttribute * dynParticleAllDimensions )

var setDynParticleAllDimensions ( var dynParticleAllDimensions )

local setDynParticleAllDimensions ( local dynParticleAllDimensions )

void setDynParticleAllDimensionsSet ( bool particleAllDimensionsSet )

var setDynParticleAllDimensionsSet ( var particleAllDimensionsSet )

local
setDynParticleAllDimensionsSet ( local particleAllDimensionsSet )

void setDynParticleDepth ( PUDynamicAttribute * dynParticleDepth )

var setDynParticleDepth ( var dynParticleDepth )

local setDynParticleDepth ( local dynParticleDepth )

void setDynParticleDepthSet ( bool particleDepthSet )

var setDynParticleDepthSet ( var particleDepthSet )

local setDynParticleDepthSet ( local particleDepthSet )

void setDynParticleHeight ( PUDynamicAttribute * dynParticleHeight )

var setDynParticleHeight ( var dynParticleHeight )

local setDynParticleHeight ( local dynParticleHeight )

void setDynParticleHeightSet ( bool particleHeightSet )

var setDynParticleHeightSet ( var particleHeightSet )

local setDynParticleHeightSet ( local particleHeightSet )

void setDynParticleMass ( PUDynamicAttribute * dynParticleMass )

var setDynParticleMass ( var dynParticleMass )

local setDynParticleMass ( local dynParticleMass )

void setDynParticleWidth ( PUDynamicAttribute * dynParticleWidth )

var setDynParticleWidth ( var dynParticleWidth )

local setDynParticleWidth ( local dynParticleWidth )

void setDynParticleWidthSet ( bool particleWidthSet )

var setDynParticleWidthSet ( var particleWidthSet )

local setDynParticleWidthSet ( local particleWidthSet )

void setDynRepeatDelay ( PUDynamicAttribute * dynRepeatDelay )

var setDynRepeatDelay ( var dynRepeatDelay )

local setDynRepeatDelay ( local dynRepeatDelay )

void setDynRepeatDelaySet ( bool repeatDelaySet )

var setDynRepeatDelaySet ( var repeatDelaySet )

local setDynRepeatDelaySet ( local repeatDelaySet )

void setDynTotalTimeToLive ( PUDynamicAttribute * dynTotalTimeToLive )

var setDynTotalTimeToLive ( var dynTotalTimeToLive )

local setDynTotalTimeToLive ( local dynTotalTimeToLive )

void setDynVelocity ( PUDynamicAttribute * dynVelocity )

var setDynVelocity ( var dynVelocity )

local setDynVelocity ( local dynVelocity )

void setEmitsName ( const std::string & emitsName )

var setEmitsName ( var emitsName )

local setEmitsName ( local emitsName )

void setEmitsType ( PUParticle3D::ParticleType type )

inline

var setEmitsType ( var type )

inline

local setEmitsType ( local type )

inline

void setEmitterType ( const std::string & emitterType )

inline

var setEmitterType ( var emitterType )

inline

local setEmitterType ( local emitterType )

inline

void setEnabled ( bool enabled )

Enables or disables the emitter.

var setEnabled ( var enabled )

Enables or disables the emitter.

local setEnabled ( local enabled )

Enables or disables the emitter.

void setForceEmission ( bool forceEmission )

Todo.

var setForceEmission ( var forceEmission )

Todo.

local setForceEmission ( local forceEmission )

Todo.

void setKeepLocal ( bool keepLocal )

If this attribute is set to 'true', the particles are emitted relative to the emitter.

var setKeepLocal ( var keepLocal )

If this attribute is set to 'true', the particles are emitted relative to the emitter.

local setKeepLocal ( local keepLocal )

If this attribute is set to 'true', the particles are emitted relative to the emitter.

void setLocalPosition ( const Vec3 & pos )

inline

var setLocalPosition ( var pos )

inline

local setLocalPosition ( local pos )

inline

void setMarkedForEmission ( bool isMarked )

inline

var setMarkedForEmission ( var isMarked )

inline

local setMarkedForEmission ( local isMarked )

inline

void setName ( const std::string & name )

inline

var setName ( var name )

inline

local setName ( local name )

inline

void setParticleColor ( const Vec4 & particleColour )

Set the colour of an emitted particle.

var setParticleColor ( var particleColour )

Set the colour of an emitted particle.

local setParticleColor ( local particleColour )

Set the colour of an emitted particle.

void setParticleColorRangeEnd ( const Vec4 & particleColourRangeEnd )

Set the colour range end of an emitted particle.

This is the upper value used to generate a random colour.

var setParticleColorRangeEnd ( var particleColourRangeEnd )

Set the colour range end of an emitted particle.

This is the upper value used to generate a random colour.

local setParticleColorRangeEnd ( local particleColourRangeEnd )

Set the colour range end of an emitted particle.

This is the upper value used to generate a random colour.

void setParticleColorRangeStart ( const Vec4 & particleColourRangeStart )

Set the colour range start of an emitted particle.

This is the lower value used to generate a random colour.

var setParticleColorRangeStart ( var particleColourRangeStart )

Set the colour range start of an emitted particle.

This is the lower value used to generate a random colour.

local setParticleColorRangeStart ( local particleColourRangeStart )

Set the colour range start of an emitted particle.

This is the lower value used to generate a random colour.

void setParticleDirection ( const Vec3 & direction )

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

Remarks: Don't confuse this with the emitters own direction.

Parameters

dir	The base direction of emitted particles.

var setParticleDirection ( var direction )

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

Remarks: Don't confuse this with the emitters own direction.

Parameters

dir	The base direction of emitted particles.

local setParticleDirection ( local direction )

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

Remarks: Don't confuse this with the emitters own direction.

Parameters

dir	The base direction of emitted particles.

void setParticleOrientation ( const Quaternion & orientation )

Set the orientation of the particle.

var setParticleOrientation ( var orientation )

Set the orientation of the particle.

local setParticleOrientation ( local orientation )

Set the orientation of the particle.

void setParticleOrientationRangeEnd ( const Quaternion & orientationRangeEnd )

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

Remarks: The orientation is generated random between mParticleOrientationRangeStart and mParticleOrientationRangeEnd.

var setParticleOrientationRangeEnd ( var orientationRangeEnd )

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

Remarks: The orientation is generated random between mParticleOrientationRangeStart and mParticleOrientationRangeEnd.

local
setParticleOrientationRangeEnd ( local orientationRangeEnd )

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

Remarks: The orientation is generated random between mParticleOrientationRangeStart and mParticleOrientationRangeEnd.

void
setParticleOrientationRangeStart ( const Quaternion & orientationRangeStart )

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

Remarks: The orientation is generated random between mParticleOrientationRangeStart and mParticleOrientationRangeEnd.

var
setParticleOrientationRangeStart ( var orientationRangeStart )

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

Remarks: The orientation is generated random between mParticleOrientationRangeStart and mParticleOrientationRangeEnd.

local
setParticleOrientationRangeStart ( local orientationRangeStart )

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

Remarks: The orientation is generated random between mParticleOrientationRangeStart and mParticleOrientationRangeEnd.

void setParticleTextureCoords ( const unsigned short & particleTextureCoords )

Set the texture coords of an emitted particle.

var setParticleTextureCoords ( var particleTextureCoords )

Set the texture coords of an emitted particle.

local setParticleTextureCoords ( local particleTextureCoords )

Set the texture coords of an emitted particle.

void
setParticleTextureCoordsRangeEnd ( const unsigned short & particleTextureCoordsRangeEnd )

Set the texture coords range end of an emitted particle.

This is the upper value used to set a random texture coords.

var
setParticleTextureCoordsRangeEnd ( var particleTextureCoordsRangeEnd )

Set the texture coords range end of an emitted particle.

This is the upper value used to set a random texture coords.

local
setParticleTextureCoordsRangeEnd ( local particleTextureCoordsRangeEnd )

Set the texture coords range end of an emitted particle.

This is the upper value used to set a random texture coords.

void
setParticleTextureCoordsRangeStart ( const unsigned short & particleTextureCoordsRangeStart )

Set the texture coords range start of an emitted particle.

This is the lower value used to set a random texture coords.

var
setParticleTextureCoordsRangeStart ( var particleTextureCoordsRangeStart )

Set the texture coords range start of an emitted particle.

This is the lower value used to set a random texture coords.

local
setParticleTextureCoordsRangeStart ( local particleTextureCoordsRangeStart )

Set the texture coords range start of an emitted particle.

This is the lower value used to set a random texture coords.

virtual void unPrepare ( )

virtual

Reimplemented in PUMeshSurfaceEmitter, and PUSlaveEmitter.

var unPrepare ( )

virtual

Reimplemented in PUMeshSurfaceEmitter, and PUSlaveEmitter.

local unPrepare ( )

virtual

Reimplemented in PUMeshSurfaceEmitter, and PUSlaveEmitter.

virtual void updateEmitter	(	Particle3D *	particle,
		float	deltaTime
	)

overridevirtual

Reimplemented from Particle3DEmitter.

var updateEmitter	(	var	particle,
		var	deltaTime
	)

overridevirtual

Reimplemented from Particle3DEmitter.

local updateEmitter	(	local	particle,
		local	deltaTime
	)

overridevirtual

Reimplemented from Particle3DEmitter.

Friends And Related Function Documentation

friend class PUParticleSystem3D

friend

var PUParticleSystem3D

friend

local PUParticleSystem3D

friend

Member Data Documentation

bool _autoDirection

protected

Auto direction means that the direction of a particle is not determined by the direction vector that has been set, but the direction vector is generated based on the shape of the emitter.

In most cases this means that the particle direction is perpendicular on the shape of the emitter.

Remarks: This attribute has only a meaning for certain emitters.

var _autoDirection

protected

Auto direction means that the direction of a particle is not determined by the direction vector that has been set, but the direction vector is generated based on the shape of the emitter.

In most cases this means that the particle direction is perpendicular on the shape of the emitter.

Remarks: This attribute has only a meaning for certain emitters.

local _autoDirection

protected

Auto direction means that the direction of a particle is not determined by the direction vector that has been set, but the direction vector is generated based on the shape of the emitter.

In most cases this means that the particle direction is perpendicular on the shape of the emitter.

Remarks: This attribute has only a meaning for certain emitters.

Vec3 _derivedPosition

protected

var _derivedPosition

protected

local _derivedPosition

protected

float _durationRemain

protected

Duration remainder.

var _durationRemain

protected

Duration remainder.

local _durationRemain

protected

Duration remainder.

PUDynamicAttributeHelper
_dynamicAttributeHelper

protected

Helper factory.

Helper class

var _dynamicAttributeHelper

protected

Helper factory.

Helper class

local _dynamicAttributeHelper

protected

Helper factory.

Helper class

PUDynamicAttribute* _dynAngle

protected

var _dynAngle

protected

local _dynAngle

protected

PUDynamicAttribute* _dynDuration

protected

Dynamic attribute used to define the duration of the emitter.

var _dynDuration

protected

Dynamic attribute used to define the duration of the emitter.

local _dynDuration

protected

Dynamic attribute used to define the duration of the emitter.

bool _dynDurationSet

protected

Indication to determine whether duration is set.

var _dynDurationSet

protected

Indication to determine whether duration is set.

local _dynDurationSet

protected

Indication to determine whether duration is set.

PUDynamicAttribute*
_dynEmissionRate

protected

var _dynEmissionRate

protected

local _dynEmissionRate

protected

PUDynamicAttribute*
_dynParticleAllDimensions

protected

Dynamic attribute used to define the (own) dimensions of a particle.

Remarks: In the Particle Technique it is possible to set the default dimensions for all particles, but it is also possible to set the dimensions per particle. Note, that this only applies to visual particles, of course. This attribute is used to x, y and z dimensions with the value.

var _dynParticleAllDimensions

protected

Dynamic attribute used to define the (own) dimensions of a particle.

Remarks: In the Particle Technique it is possible to set the default dimensions for all particles, but it is also possible to set the dimensions per particle. Note, that this only applies to visual particles, of course. This attribute is used to x, y and z dimensions with the value.

local _dynParticleAllDimensions

protected

Dynamic attribute used to define the (own) dimensions of a particle.

Remarks: In the Particle Technique it is possible to set the default dimensions for all particles, but it is also possible to set the dimensions per particle. Note, that this only applies to visual particles, of course. This attribute is used to x, y and z dimensions with the value.

bool _dynParticleAllDimensionsSet

protected

var _dynParticleAllDimensionsSet

protected

local _dynParticleAllDimensionsSet

protected

PUDynamicAttribute*
_dynParticleDepth

protected

Dynamic attribute used to define the (own) depth of a particle.

Remarks: In the Particle Technique it is possible to set the default depth for all particles, but it is also possible to set the depth per particle. Note, that this only applies to visual particles, of course.

var _dynParticleDepth

protected

Dynamic attribute used to define the (own) depth of a particle.

Remarks: In the Particle Technique it is possible to set the default depth for all particles, but it is also possible to set the depth per particle. Note, that this only applies to visual particles, of course.

local _dynParticleDepth

protected

Dynamic attribute used to define the (own) depth of a particle.

Remarks: In the Particle Technique it is possible to set the default depth for all particles, but it is also possible to set the depth per particle. Note, that this only applies to visual particles, of course.

bool _dynParticleDepthSet

protected

var _dynParticleDepthSet

protected

local _dynParticleDepthSet

protected

PUDynamicAttribute*
_dynParticleHeight

protected

Dynamic attribute used to define the (own) height of a particle.

Remarks: In the Particle Technique it is possible to set the default height for all particles, but it is also possible to set the height per particle. Note, that this only applies to visual particles, of course.

var _dynParticleHeight

protected

Dynamic attribute used to define the (own) height of a particle.

Remarks: In the Particle Technique it is possible to set the default height for all particles, but it is also possible to set the height per particle. Note, that this only applies to visual particles, of course.

local _dynParticleHeight

protected

Dynamic attribute used to define the (own) height of a particle.

Remarks: In the Particle Technique it is possible to set the default height for all particles, but it is also possible to set the height per particle. Note, that this only applies to visual particles, of course.

bool _dynParticleHeightSet

protected

var _dynParticleHeightSet

protected

local _dynParticleHeightSet

protected

PUDynamicAttribute*
_dynParticleMass

protected

Dynamic attribute used to generate the mass of a particle.

var _dynParticleMass

protected

Dynamic attribute used to generate the mass of a particle.

local _dynParticleMass

protected

Dynamic attribute used to generate the mass of a particle.

PUDynamicAttribute*
_dynParticleWidth

protected

Dynamic attribute used to define the (own) width of a particle.

Remarks: In the Particle Technique it is possible to set the default width for all particles, but it is also possible to set the width per particle. Note, that this only applies to visual particles, of course.

var _dynParticleWidth

protected

Dynamic attribute used to define the (own) width of a particle.

Remarks: In the Particle Technique it is possible to set the default width for all particles, but it is also possible to set the width per particle. Note, that this only applies to visual particles, of course.

local _dynParticleWidth

protected

Dynamic attribute used to define the (own) width of a particle.

Remarks: In the Particle Technique it is possible to set the default width for all particles, but it is also possible to set the width per particle. Note, that this only applies to visual particles, of course.

bool _dynParticleWidthSet

protected

var _dynParticleWidthSet

protected

local _dynParticleWidthSet

protected

PUDynamicAttribute* _dynRepeatDelay

protected

Dynamic attribute used to define the repeat/delay of the emitter.

var _dynRepeatDelay

protected

Dynamic attribute used to define the repeat/delay of the emitter.

local _dynRepeatDelay

protected

Dynamic attribute used to define the repeat/delay of the emitter.

bool _dynRepeatDelaySet

protected

Indication to determine whether repeat/delay is set.

var _dynRepeatDelaySet

protected

Indication to determine whether repeat/delay is set.

local _dynRepeatDelaySet

protected

Indication to determine whether repeat/delay is set.

PUDynamicAttribute*
_dynTotalTimeToLive

protected

Dynamic attribute used to generate the total time to live.

var _dynTotalTimeToLive

protected

Dynamic attribute used to generate the total time to live.

local _dynTotalTimeToLive

protected

Dynamic attribute used to generate the total time to live.

PUDynamicAttribute* _dynVelocity

protected

Dynamic attribute used to generate the velocity of a particle.

var _dynVelocity

protected

Dynamic attribute used to generate the velocity of a particle.

local _dynVelocity

protected

Dynamic attribute used to generate the velocity of a particle.

Ref* _emitsEntity

protected

var _emitsEntity

protected

local _emitsEntity

protected

std::string _emitsName

protected

var _emitsName

protected

local _emitsName

protected

PUParticle3D::ParticleType
_emitsType

protected

var _emitsType

protected

local _emitsType

protected

Vec3 _emitterScale

protected

Although the scale is on a Particle System level, the emitter can also be scaled.

var _emitterScale

protected

Although the scale is on a Particle System level, the emitter can also be scaled.

local _emitterScale

protected

Although the scale is on a Particle System level, the emitter can also be scaled.

std::string _emitterType

protected

var _emitterType

protected

local _emitterType

protected

bool _forceEmission

protected

In normal cases, emission is regulated by time.

This prevents that too much particles are emitted at once, which causes a drop in the framerate. In some cases you just want to emit all particles immediately without any delay. Setting the 'mForceEmission' to true enables this. In that case, the emission rate defines the number of particles that are emitted immediately. If the emission rate is 100, the emitter emits 100 particles at once and then disables.

var _forceEmission

protected

In normal cases, emission is regulated by time.

This prevents that too much particles are emitted at once, which causes a drop in the framerate. In some cases you just want to emit all particles immediately without any delay. Setting the 'mForceEmission' to true enables this. In that case, the emission rate defines the number of particles that are emitted immediately. If the emission rate is 100, the emitter emits 100 particles at once and then disables.

local _forceEmission

protected

In normal cases, emission is regulated by time.

This prevents that too much particles are emitted at once, which causes a drop in the framerate. In some cases you just want to emit all particles immediately without any delay. Setting the 'mForceEmission' to true enables this. In that case, the emission rate defines the number of particles that are emitted immediately. If the emission rate is 100, the emitter emits 100 particles at once and then disables.

bool _forceEmissionExecuted

protected

If mForceEmission has been set to true and if all particles are emitted, the mForceEmissionExecuted is also set to true, preventing any further 'forced emission'.

var _forceEmissionExecuted

protected

If mForceEmission has been set to true and if all particles are emitted, the mForceEmissionExecuted is also set to true, preventing any further 'forced emission'.

local _forceEmissionExecuted

protected

If mForceEmission has been set to true and if all particles are emitted, the mForceEmissionExecuted is also set to true, preventing any further 'forced emission'.

bool _isMarkedForEmission

protected

var _isMarkedForEmission

protected

local _isMarkedForEmission

protected

bool _keepLocal

protected

Determines whether particle positions should be kept local in relation to the emitter.

var _keepLocal

protected

Determines whether particle positions should be kept local in relation to the emitter.

local _keepLocal

protected

Determines whether particle positions should be kept local in relation to the emitter.

Vec3 _latestPosition

protected

var _latestPosition

protected

local _latestPosition

protected

Vec3 _latestPositionDiff

protected

var _latestPositionDiff

protected

local _latestPositionDiff

protected

std::string _name

protected

var _name

protected

local _name

protected

bool _originalForceEmission

protected

Original value, used to set it back.

var _originalForceEmission

protected

Original value, used to set it back.

local _originalForceEmission

protected

Original value, used to set it back.

bool _originalForceEmissionExecuted

protected

Original value, used to set it back.

var _originalForceEmissionExecuted

protected

Original value, used to set it back.

local
_originalForceEmissionExecuted

protected

Original value, used to set it back.

Vec3 _originalParticleDirection

protected

The original direction of the emitted particle.

Remarks: Don't confuse this with the particles' originalDirection.

var _originalParticleDirection

protected

The original direction of the emitted particle.

Remarks: Don't confuse this with the particles' originalDirection.

local _originalParticleDirection

protected

The original direction of the emitted particle.

Remarks: Don't confuse this with the particles' originalDirection.

bool _originEnabled

protected

var _originEnabled

protected

local _originEnabled

protected

bool _originEnabledSet

protected

var _originEnabledSet

protected

local _originEnabledSet

protected

Vec4 _particleColor

protected

Colour that is assigned to an emitted particle.

var _particleColor

protected

Colour that is assigned to an emitted particle.

local _particleColor

protected

Colour that is assigned to an emitted particle.

Vec4 _particleColorRangeEnd

protected

Used to randomize the colour of an emitted particle.

var _particleColorRangeEnd

protected

Used to randomize the colour of an emitted particle.

local _particleColorRangeEnd

protected

Used to randomize the colour of an emitted particle.

bool _particleColorRangeSet

protected

Used to determine whether the colour range has been set.

var _particleColorRangeSet

protected

Used to determine whether the colour range has been set.

local _particleColorRangeSet

protected

Used to determine whether the colour range has been set.

Vec4 _particleColorRangeStart

protected

Used to randomize the colour of an emitted particle.

var _particleColorRangeStart

protected

Used to randomize the colour of an emitted particle.

local _particleColorRangeStart

protected

Used to randomize the colour of an emitted particle.

Vec3 _particleDirection

protected

Direction (and speed) of the emitted particle.

Remarks: Don't confuse the particle direction with the direction of the emitter itself. The particleDirection is the direction of an emitted particle.

var _particleDirection

protected

Direction (and speed) of the emitted particle.

Remarks: Don't confuse the particle direction with the direction of the emitter itself. The particleDirection is the direction of an emitted particle.

local _particleDirection

protected

Direction (and speed) of the emitted particle.

Remarks: Don't confuse the particle direction with the direction of the emitter itself. The particleDirection is the direction of an emitted particle.

Quaternion _particleOrientation

protected

Orientation of the particle as soon as it is emitted.

Remarks: This is only visible if a renderer is used that renders 3D particles.

var _particleOrientation

protected

Orientation of the particle as soon as it is emitted.

Remarks: This is only visible if a renderer is used that renders 3D particles.

local _particleOrientation

protected

Orientation of the particle as soon as it is emitted.

Remarks: This is only visible if a renderer is used that renders 3D particles.

Quaternion
_particleOrientationRangeEnd

protected

var _particleOrientationRangeEnd

protected

local _particleOrientationRangeEnd

protected

bool _particleOrientationRangeSet

protected

var _particleOrientationRangeSet

protected

local _particleOrientationRangeSet

protected

Quaternion
_particleOrientationRangeStart

protected

If set, the range generates a random orientation between start and end.

var _particleOrientationRangeStart

protected

If set, the range generates a random orientation between start and end.

local
_particleOrientationRangeStart

protected

If set, the range generates a random orientation between start and end.

unsigned short
_particleTextureCoords

protected

Texture coords that is assigned to an emitted particle (only works if the renderer uses it)

var _particleTextureCoords

protected

Texture coords that is assigned to an emitted particle (only works if the renderer uses it)

local _particleTextureCoords

protected

Texture coords that is assigned to an emitted particle (only works if the renderer uses it)

unsigned short
_particleTextureCoordsRangeEnd

protected

Used to randomize the texture coords of an emitted particle.

var _particleTextureCoordsRangeEnd

protected

Used to randomize the texture coords of an emitted particle.

local
_particleTextureCoordsRangeEnd

protected

Used to randomize the texture coords of an emitted particle.

bool _particleTextureCoordsRangeSet

protected

Used to determine whether the texture coords range has been set.

var _particleTextureCoordsRangeSet

protected

Used to determine whether the texture coords range has been set.

local
_particleTextureCoordsRangeSet

protected

Used to determine whether the texture coords range has been set.

unsigned short
_particleTextureCoordsRangeStart

protected

Used to randomize the texture coords of an emitted particle.

var
_particleTextureCoordsRangeStart

protected

Used to randomize the texture coords of an emitted particle.

local
_particleTextureCoordsRangeStart

protected

Used to randomize the texture coords of an emitted particle.

Vec3 _position

protected

var _position

protected

local _position

protected

float _remainder

protected

Particles that are left to be emitted from the previous time.

var _remainder

protected

Particles that are left to be emitted from the previous time.

local _remainder

protected

Particles that are left to be emitted from the previous time.

float _repeatDelayRemain

protected

Repeat/delay remainder.

var _repeatDelayRemain

protected

Repeat/delay remainder.

local _repeatDelayRemain

protected

Repeat/delay remainder.

Vec3 _upVector

protected

Notional up vector, just used to speed up generation of variant directions.

var _upVector

protected

Notional up vector, just used to speed up generation of variant directions.

local _upVector

protected

Notional up vector, just used to speed up generation of variant directions.

const float DEFAULT_ANGLE

static

var DEFAULT_ANGLE

static

local DEFAULT_ANGLE

static

const bool DEFAULT_AUTO_DIRECTION

static

var DEFAULT_AUTO_DIRECTION

static

local DEFAULT_AUTO_DIRECTION

static

const Vec4 DEFAULT_COLOUR

static

var DEFAULT_COLOUR

static

local DEFAULT_COLOUR

static

const float DEFAULT_DEPTH

static

var DEFAULT_DEPTH

static

local DEFAULT_DEPTH

static

const float DEFAULT_DIMENSIONS

static

var DEFAULT_DIMENSIONS

static

local DEFAULT_DIMENSIONS

static

const Vec3 DEFAULT_DIRECTION

static

var DEFAULT_DIRECTION

static

local DEFAULT_DIRECTION

static

const float DEFAULT_DURATION

static

var DEFAULT_DURATION

static

local DEFAULT_DURATION

static

const float DEFAULT_EMISSION_RATE

static

var DEFAULT_EMISSION_RATE

static

local DEFAULT_EMISSION_RATE

static

const bool DEFAULT_ENABLED

static

var DEFAULT_ENABLED

static

local DEFAULT_ENABLED

static

const Vec4 DEFAULT_END_COLOUR_RANGE

static

var DEFAULT_END_COLOUR_RANGE

static

local DEFAULT_END_COLOUR_RANGE

static

const unsigned short
DEFAULT_END_TEXTURE_COORDS

static

var DEFAULT_END_TEXTURE_COORDS

static

local DEFAULT_END_TEXTURE_COORDS

static

const bool DEFAULT_FORCE_EMISSION

static

var DEFAULT_FORCE_EMISSION

static

local DEFAULT_FORCE_EMISSION

static

const float DEFAULT_HEIGHT

static

var DEFAULT_HEIGHT

static

local DEFAULT_HEIGHT

static

const bool DEFAULT_KEEP_LOCAL

static

var DEFAULT_KEEP_LOCAL

static

local DEFAULT_KEEP_LOCAL

static

const float DEFAULT_MASS

static

var DEFAULT_MASS

static

local DEFAULT_MASS

static

const Quaternion
DEFAULT_ORIENTATION

static

var DEFAULT_ORIENTATION

static

local DEFAULT_ORIENTATION

static

const Quaternion
DEFAULT_ORIENTATION_RANGE_END

static

var DEFAULT_ORIENTATION_RANGE_END

static

local DEFAULT_ORIENTATION_RANGE_END

static

const Quaternion
DEFAULT_ORIENTATION_RANGE_START

static

var DEFAULT_ORIENTATION_RANGE_START

static

local
DEFAULT_ORIENTATION_RANGE_START

static

const Vec3 DEFAULT_POSITION

static

var DEFAULT_POSITION

static

local DEFAULT_POSITION

static

const float DEFAULT_REPEAT_DELAY

static

var DEFAULT_REPEAT_DELAY

static

local DEFAULT_REPEAT_DELAY

static

const Vec4
DEFAULT_START_COLOUR_RANGE

static

var DEFAULT_START_COLOUR_RANGE

static

local DEFAULT_START_COLOUR_RANGE

static

const unsigned short
DEFAULT_START_TEXTURE_COORDS

static

var DEFAULT_START_TEXTURE_COORDS

static

local DEFAULT_START_TEXTURE_COORDS

static

const unsigned short
DEFAULT_TEXTURE_COORDS

static

var DEFAULT_TEXTURE_COORDS

static

local DEFAULT_TEXTURE_COORDS

static

const float DEFAULT_TIME_TO_LIVE

static

var DEFAULT_TIME_TO_LIVE

static

local DEFAULT_TIME_TO_LIVE

static

const float DEFAULT_VELOCITY

static

var DEFAULT_VELOCITY

static

local DEFAULT_VELOCITY

static

const float DEFAULT_WIDTH

static

var DEFAULT_WIDTH

static

local DEFAULT_WIDTH

static

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

/Users/minggo/SourceCode/cocos2d-x/extensions/Particle3D/PU/CCPUEmitter.h

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation