PUBaseForceAffector Class Reference

#include <CCPUBaseForceAffector.h>

Inheritance diagram for PUBaseForceAffector:

Public Types
enum	ForceApplication { FA_AVERAGE, FA_ADD }
Public Types inherited from PUAffector
enum	AffectSpecialisation { AFSP_DEFAULT, AFSP_TTL_INCREASE, AFSP_TTL_DECREASE }
	The AffectSpecialisation enumeration is used to specialise the affector even more. More...

Public Member Functions
const Vec3 &	getForceVector () const
void	setForceVector (const Vec3 &forceVector)
ForceApplication	getForceApplication () const
void	setForceApplication (ForceApplication forceApplication)
virtual void	copyAttributesTo (PUAffector *affector) override
var	copyAttributesTo ( var affector)
local	copyAttributesTo ( local affector)
virtual	~PUBaseForceAffector ()
Public Member Functions inherited from PUAffector
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	preUpdateAffector (float deltaTime)
local	preUpdateAffector ( local deltaTime)
virtual void	updatePUAffector (PUParticle3D *particle, float delta)
local	updatePUAffector ( local particle, local delta)
virtual void	postUpdateAffector (float deltaTime)
virtual void	firstParticleUpdate (PUParticle3D *particle, float deltaTime)
var	firstParticleUpdate ( var particle, var deltaTime)
local	firstParticleUpdate ( local particle, local deltaTime)
virtual void	initParticleForEmission (PUParticle3D *particle)
var	initParticleForEmission ( var particle)
local	initParticleForEmission ( local particle)
void	process (PUParticle3D *particle, float delta, bool firstParticle)
void	setLocalPosition (const Vec3 &pos)
const Vec3	getLocalPosition () const
void	setMass (float mass)
float	getMass () const
const Vec3 &	getDerivedPosition ()
	Calculate the derived position of the affector. More...
local	getDerivedPosition ()
	Calculate the derived position of the affector. More...
const AffectSpecialisation &	getAffectSpecialisation (void) const
	Todo. More...
local	getAffectSpecialisation ()
	Todo. More...
void	setAffectSpecialisation (const AffectSpecialisation &affectSpecialisation)
const std::string &	getAffectorType (void) const
	Todo. More...
void	setAffectorType (const std::string &affectorType)
void	addEmitterToExclude (const std::string &emitterName)
	Add a ParticleEmitter name that excludes Particles emitted by this ParticleEmitter from being affected. More...
void	removeEmitterToExclude (const std::string &emitterName)
	Remove a ParticleEmitter name that excludes Particles emitted by this ParticleEmitter. More...
const std::string &	getName (void) const
	Todo. More...
void	setName (const std::string &name)
virtual	~PUAffector ()
Public Member Functions inherited from Particle3DAffector
virtual void	updateAffector (Particle3D *particle, float deltaTime)
void	setEnabled (bool enabled)
	Enables or disables the emitter. More...
bool	isEnabled (void) const
virtual	~Particle3DAffector ()
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...

Public Attributes
CC_CONSTRUCTOR_ACCESS	__pad0__: PUBaseForceAffector()
Public Attributes inherited from PUAffector
CC_CONSTRUCTOR_ACCESS	__pad0__: PUAffector()
Public Attributes inherited from Particle3DAffector
CC_CONSTRUCTOR_ACCESS	__pad0__: Particle3DAffector()

Static Public Attributes
static const Vec3	DEFAULT_FORCE_VECTOR
var	DEFAULT_FORCE_VECTOR
local	DEFAULT_FORCE_VECTOR
static const ForceApplication	DEFAULT_FORCE_APPL

Protected Attributes
Vec3	_forceVector
Vec3	_scaledVector
ForceApplication	_forceApplication
var	_forceApplication
local	_forceApplication
Protected Attributes inherited from PUAffector
Vec3	_position
Vec3	_affectorScale
	Although the scale is on a Particle System level, the affector can also be scaled. More...
Vec3	_derivedPosition
	Because the public attribute ´position?is sometimes used for both localspace and worldspace position, the mDerivedPosition attribute is introduced. More...
AffectSpecialisation	_affectSpecialisation
	The mAffectSpecialisation is used to specialise the affector. More...
std::string	_affectorType
std::vector< std::string >	_excludedEmitters
var	_excludedEmitters
local	_excludedEmitters
std::string	_name
float	_mass
Protected Attributes inherited from Particle3DAffector
ParticleSystem3D *	_particleSystem
bool	_isEnabled
Protected Attributes inherited from Ref
unsigned int	_referenceCount
	count of references More...
local	_referenceCount
	count of references More...

Additional Inherited Members
Protected Member Functions inherited from PUAffector
float	calculateAffectSpecialisationFactor (const PUParticle3D *particle)
var	calculateAffectSpecialisationFactor ( var particle)
local	calculateAffectSpecialisationFactor ( local particle)
Protected Member Functions inherited from Ref
	Ref ()
	Constructor. More...
	Ref ()
	Constructor. More...

Member Enumeration Documentation

enum ForceApplication

Enumerator
FA_AVERAGE
FA_ADD

Constructor & Destructor Documentation

virtual ~PUBaseForceAffector ( )

virtual

var ~PUBaseForceAffector ( )

virtual

local ~PUBaseForceAffector ( )

virtual

Member Function Documentation

virtual void copyAttributesTo ( PUAffector *  affector )

overridevirtual

Reimplemented from PUAffector.

Reimplemented in PUSineForceAffector, and PULinearForceAffector.

var copyAttributesTo ( var  affector )

overridevirtual

Reimplemented from PUAffector.

Reimplemented in PUSineForceAffector, and PULinearForceAffector.

local copyAttributesTo ( local  affector )

overridevirtual

Reimplemented from PUAffector.

Reimplemented in PUSineForceAffector, and PULinearForceAffector.

ForceApplication getForceApplication

(

)

const

var getForceApplication

(

)

local getForceApplication

(

)

const Vec3& getForceVector

(

)

const

var getForceVector

(

)

local getForceVector

(

)

void setForceApplication

(

ForceApplication

forceApplication

)

var setForceApplication

(

var

forceApplication

)

local setForceApplication

(

local

forceApplication

)

void setForceVector

(

const Vec3 &

forceVector

)

var setForceVector

(

var

forceVector

)

local setForceVector

(

local

forceVector

)

Member Data Documentation

CC_CONSTRUCTOR_ACCESS __pad0__

var __pad0__

local __pad0__

ForceApplication _forceApplication

protected

var _forceApplication

protected

local _forceApplication

protected

Vec3 _forceVector

protected

var _forceVector

protected

local _forceVector

protected

Vec3 _scaledVector

protected

var _scaledVector

protected

local _scaledVector

protected

const ForceApplication DEFAULT_FORCE_APPL

static

var DEFAULT_FORCE_APPL

static

local DEFAULT_FORCE_APPL

static

const Vec3 DEFAULT_FORCE_VECTOR

static

var DEFAULT_FORCE_VECTOR

static

local DEFAULT_FORCE_VECTOR

static

---

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

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