PUParticle3D Struct Reference

#include <CCPUParticleSystem3D.h>

Inheritance diagram for PUParticle3D:

Public Types
enum	ParticleType {   PT_VISUAL, PT_TECHNIQUE, PT_EMITTER, PT_AFFECTOR,   PT_SYSTEM }
enum	ReservedParticleEventFlags { PEF_EXPIRED = 1<<0, PEF_EMITTED = 1<<1, PEF_COLLIDED = 1<<2 }
	Enumeration which lists a number of reserved event flags. More...
typedef std::vector < PUBehaviour * >	ParticleBehaviourList

Public Member Functions
	PUParticle3D ()
virtual	~PUParticle3D ()
void	copyBehaviours (const ParticleBehaviourList &list)
float	calculateVelocity () const
void	setOwnDimensions (float newWidth, float newHeight, float newDepth)
	Set own dimensions. More...
var	setOwnDimensions ( var newWidth, var newHeight, var newDepth)
	Set own dimensions. More...
local	setOwnDimensions ( local newWidth, local newHeight, local newDepth)
	Set own dimensions. More...
void	calculateBoundingSphereRadius ()
var	calculateBoundingSphereRadius ()
local	calculateBoundingSphereRadius ()
void	initForEmission ()
void	initForExpiration (float timeElapsed)
void	process (float timeElapsed)
void	setEventFlags (unsigned int flags)
	Sets the event flags. More...
void	addEventFlags (unsigned int flags)
	As setEventFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
void	removeEventFlags (unsigned int flags)
	The flags passed as parameters are removed from the existing flags. More...
unsigned int	getEventFlags () const
	Return the event flags. More...
bool	hasEventFlags (unsigned int flags) const
	Determines whether it has certain flags set. More...
var	hasEventFlags ( var flags)
	Determines whether it has certain flags set. More...
local	hasEventFlags ( local flags)
	Determines whether it has certain flags set. More...
bool	isFreezed (void) const
var	isFreezed ()
local	isFreezed ()
void	setFreezed (bool fzd)
var	setFreezed ( var fzd)
local	setFreezed ( local fzd)
Public Member Functions inherited from Particle3D
	Particle3D ()
virtual	~Particle3D ()
local	~Particle3D ()

Public Attributes
Ref *	particleEntityPtr
PUEmitter *	parentEmitter
Ref *	visualData
ParticleType	particleType
Vec3	originalPosition
Vec3	latestPosition
Vec3	direction
Vec3	originalDirection
float	originalDirectionLength
float	originalVelocity
float	originalScaledDirectionLength
Vec3	rotationAxis
	The rotation axis is used in combination with orientation. More...
Vec4	originalColor
	Current and original colour. More...
float	zRotationSpeed
	The zRotationSpeed is used in combination with zRotation and defines tha actual rotationspeed in 2D. More...
Quaternion	originalOrientation
float	rotationSpeed
	The rotation is used in combination with orientation. More...
float	radius
	Radius of the particle, to be used for inter-particle collision and such. More...
ParticleBehaviourList	behaviours
bool	ownDimensions
	Does this particle have it's own dimensions? More...
unsigned int	eventFlags
bool	freezed
float	timeToLive
float	totalTimeToLive
float	timeFraction
float	mass
float	textureAnimationTimeStep
	Animation attributes. More...
var	textureAnimationTimeStep
	Animation attributes. More...
local	textureAnimationTimeStep
	Animation attributes. More...
float	textureAnimationTimeStepCount
var	textureAnimationTimeStepCount
local	textureAnimationTimeStepCount
unsigned short	textureCoordsCurrent
bool	textureAnimationDirectionUp
float	depthInView
float	zRotation
Public Attributes inherited from Particle3D
Vec3	position
Quaternion	orientation
Vec4	color
Vec2	lb_uv
Vec2	rt_uv
float	width
float	height
float	depth
std::map< std::string, void * >	userDefs

Static Public Attributes
static float	DEFAULT_TTL
static float	DEFAULT_MASS

Member Typedef Documentation

typedef std::vector <PUBehaviour*> ParticleBehaviourList

var ParticleBehaviourList

local ParticleBehaviourList

Member Enumeration Documentation

enum ParticleType

Enumerator
PT_VISUAL
PT_TECHNIQUE
PT_EMITTER
PT_AFFECTOR
PT_SYSTEM

var ParticleType

Enumerator
PT_VISUAL
PT_TECHNIQUE
PT_EMITTER
PT_AFFECTOR
PT_SYSTEM

local ParticleType

Enumerator
PT_VISUAL
PT_TECHNIQUE
PT_EMITTER
PT_AFFECTOR
PT_SYSTEM

enum ReservedParticleEventFlags

Enumeration which lists a number of reserved event flags.

Although custom flags can be used to indicate that a certain condition occurs, the first number of flags may not be used as custom flags.

Enumerator
PEF_EXPIRED
PEF_EMITTED
PEF_COLLIDED

var ReservedParticleEventFlags

Enumeration which lists a number of reserved event flags.

Although custom flags can be used to indicate that a certain condition occurs, the first number of flags may not be used as custom flags.

Enumerator
PEF_EXPIRED
PEF_EMITTED
PEF_COLLIDED

local ReservedParticleEventFlags

Enumeration which lists a number of reserved event flags.

Although custom flags can be used to indicate that a certain condition occurs, the first number of flags may not be used as custom flags.

Enumerator
PEF_EXPIRED
PEF_EMITTED
PEF_COLLIDED

Constructor & Destructor Documentation

PUParticle3D

(

)

var PUParticle3D

(

)

local PUParticle3D

(

)

virtual ~PUParticle3D ( )

virtual

var ~PUParticle3D ( )

virtual

local ~PUParticle3D ( )

virtual

Member Function Documentation

void addEventFlags ( unsigned int  flags )

inline

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

var addEventFlags ( var  flags )

inline

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

local addEventFlags ( local  flags )

inline

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

void calculateBoundingSphereRadius

(

)

var calculateBoundingSphereRadius

(

)

local calculateBoundingSphereRadius

(

)

float calculateVelocity

(

)

const

var calculateVelocity

(

)

local calculateVelocity

(

)

void copyBehaviours

(

const ParticleBehaviourList &

list

)

var copyBehaviours

(

var

list

)

local copyBehaviours

(

local

list

)

unsigned int getEventFlags ( ) const

inline

Return the event flags.

var getEventFlags ( )

inline

Return the event flags.

local getEventFlags ( )

inline

Return the event flags.

bool hasEventFlags ( unsigned int  flags ) const

inline

Determines whether it has certain flags set.

var hasEventFlags ( var  flags )

inline

Determines whether it has certain flags set.

local hasEventFlags ( local  flags )

inline

Determines whether it has certain flags set.

void initForEmission

(

)

var initForEmission

(

)

local initForEmission

(

)

void initForExpiration

(

float

timeElapsed

)

var initForExpiration

(

var

timeElapsed

)

local initForExpiration

(

local

timeElapsed

)

bool isFreezed ( void  ) const

inline

var isFreezed (   )

inline

local isFreezed (   )

inline

void process

(

float

timeElapsed

)

var process

(

var

timeElapsed

)

local process

(

local

timeElapsed

)

void removeEventFlags ( unsigned int  flags )

inline

The flags passed as parameters are removed from the existing flags.

var removeEventFlags ( var  flags )

inline

The flags passed as parameters are removed from the existing flags.

local removeEventFlags ( local  flags )

inline

The flags passed as parameters are removed from the existing flags.

void setEventFlags ( unsigned int  flags )

inline

Sets the event flags.

var setEventFlags ( var  flags )

inline

Sets the event flags.

local setEventFlags ( local  flags )

inline

Sets the event flags.

void setFreezed ( bool  fzd )

inline

var setFreezed ( var  fzd )

inline

local setFreezed ( local  fzd )

inline

void setOwnDimensions	(	float	newWidth,
		float	newHeight,
		float	newDepth
	)

Set own dimensions.

var setOwnDimensions	(	var	newWidth,
		var	newHeight,
		var	newDepth
	)

Set own dimensions.

local setOwnDimensions	(	local	newWidth,
		local	newHeight,
		local	newDepth
	)

Set own dimensions.

Member Data Documentation

ParticleBehaviourList behaviours

var behaviours

local behaviours

float DEFAULT_MASS

static

var DEFAULT_MASS

static

local DEFAULT_MASS

static

float DEFAULT_TTL

static

var DEFAULT_TTL

static

local DEFAULT_TTL

static

float depthInView

var depthInView

local depthInView

Vec3 direction

var direction

local direction

unsigned int eventFlags

var eventFlags

local eventFlags

bool freezed

var freezed

local freezed

Vec3 latestPosition

var latestPosition

local latestPosition

float mass

var mass

local mass

Vec4 originalColor

Current and original colour.

var originalColor

Current and original colour.

local originalColor

Current and original colour.

Vec3 originalDirection

var originalDirection

local originalDirection

float originalDirectionLength

var originalDirectionLength

local originalDirectionLength

Quaternion originalOrientation

var originalOrientation

local originalOrientation

Vec3 originalPosition

var originalPosition

local originalPosition

float originalScaledDirectionLength

var originalScaledDirectionLength

local originalScaledDirectionLength

float originalVelocity

var originalVelocity

local originalVelocity

bool ownDimensions

Does this particle have it's own dimensions?

var ownDimensions

Does this particle have it's own dimensions?

local ownDimensions

Does this particle have it's own dimensions?

PUEmitter* parentEmitter

var parentEmitter

local parentEmitter

Ref* particleEntityPtr

var particleEntityPtr

local particleEntityPtr

ParticleType particleType

var particleType

local particleType

float radius

Radius of the particle, to be used for inter-particle collision and such.

var radius

Radius of the particle, to be used for inter-particle collision and such.

local radius

Radius of the particle, to be used for inter-particle collision and such.

Vec3 rotationAxis

The rotation axis is used in combination with orientation.

Because the rotation axis is part of the particle itself, it can be changed independently.

var rotationAxis

The rotation axis is used in combination with orientation.

Because the rotation axis is part of the particle itself, it can be changed independently.

local rotationAxis

The rotation axis is used in combination with orientation.

Because the rotation axis is part of the particle itself, it can be changed independently.

float rotationSpeed

The rotation is used in combination with orientation.

Because the rotation speed is part of the particle itself, it can be changed independently.

var rotationSpeed

The rotation is used in combination with orientation.

Because the rotation speed is part of the particle itself, it can be changed independently.

local rotationSpeed

The rotation is used in combination with orientation.

Because the rotation speed is part of the particle itself, it can be changed independently.

bool textureAnimationDirectionUp

var textureAnimationDirectionUp

local textureAnimationDirectionUp

float textureAnimationTimeStep

Animation attributes.

var textureAnimationTimeStep

Animation attributes.

local textureAnimationTimeStep

Animation attributes.

float textureAnimationTimeStepCount

var textureAnimationTimeStepCount

local textureAnimationTimeStepCount

unsigned short textureCoordsCurrent

var textureCoordsCurrent

local textureCoordsCurrent

float timeFraction

var timeFraction

local timeFraction

float timeToLive

var timeToLive

local timeToLive

float totalTimeToLive

var totalTimeToLive

local totalTimeToLive

Ref* visualData

var visualData

local visualData

float zRotation

var zRotation

local zRotation

float zRotationSpeed

The zRotationSpeed is used in combination with zRotation and defines tha actual rotationspeed in 2D.

var zRotationSpeed

The zRotationSpeed is used in combination with zRotation and defines tha actual rotationspeed in 2D.

local zRotationSpeed

The zRotationSpeed is used in combination with zRotation and defines tha actual rotationspeed in 2D.

---

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

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