PUOnTimeObserver Class Reference

#include <CCPUOnTimeObserver.h>

Inheritance diagram for PUOnTimeObserver:

Public Member Functions
virtual void	preUpdateObserver (float deltaTime) override
	In case there are no particles, but the observation returns true, the event handlers must still be called. More...
local	preUpdateObserver ( local deltaTime)
	In case there are no particles, but the observation returns true, the event handlers must still be called. More...
virtual bool	observe (PUParticle3D *particle, float timeElapsed) override
	This function determines whether a condition (the event) is true or false. More...
float	getThreshold (void) const
void	setThreshold (float threshold)
const PUComparisionOperator	getCompare (void) const
local	getCompare ()
void	setCompare (PUComparisionOperator op)
bool	isSinceStartSystem (void) const
void	setSinceStartSystem (bool sinceStartSystem)
virtual void	copyAttributesTo (PUObserver *observer) override
virtual	~PUOnTimeObserver (void)
Public Member Functions inherited from PUObserver
const std::string &	getObserverType (void) const
	Todo. More...
void	setObserverType (const std::string &observerType)
virtual bool	isEnabled (void) const
	Todo. More...
bool	_getOriginalEnabled (void) const
	Returns the 'enabled' value that was set in setEnabled() and not altered during execution. More...
virtual void	setEnabled (bool enabled)
	Todo. More...
void	_resetEnabled (void)
	Reset internal values for 'enabled'. More...
const std::string &	getName (void) const
	Todo. More...
void	setName (const std::string &name)
const PUParticle3D::ParticleType &	getParticleTypeToObserve (void) const
	Todo. More...
local	getParticleTypeToObserve ()
	Todo. More...
void	setParticleTypeToObserve (const PUParticle3D::ParticleType particleTypeToObserve)
virtual void	notifyStart (void)
virtual void	notifyStop (void)
virtual void	notifyRescaled (const Vec3 &scale)
local	notifyRescaled ( local scale)
virtual void	updateObserver (PUParticle3D *particle, float deltaTime, bool firstParticle)
local	updateObserver ( local particle, local deltaTime, local firstParticle)
virtual void	postUpdateObserver (float deltaTime)
virtual void	firstParticleUpdate (PUParticle3D *particle, float deltaTime)
var	firstParticleUpdate ( var particle, var deltaTime)
local	firstParticleUpdate ( local particle, local deltaTime)
PUEventHandler *	createEventHandler (const std::string &eventHandlerType)
	Todo. More...
var	createEventHandler ( var eventHandlerType)
	Todo. More...
local	createEventHandler ( local eventHandlerType)
	Todo. More...
void	addEventHandler (PUEventHandler *eventHandler)
	Todo. More...
void	removeEventHandler (PUEventHandler *eventHandler)
	Todo. More...
PUEventHandler *	getEventHandler (size_t index) const
	Todo. More...
var	getEventHandler ( var index)
	Todo. More...
local	getEventHandler ( local index)
	Todo. More...
PUEventHandler *	getEventHandler (const std::string &eventHandlerName) const
	Todo. More...
size_t	getNumEventHandlers (void) const
	Todo. More...
void	destroyEventHandler (PUEventHandler *eventHandler)
	Todo. More...
void	destroyEventHandler (size_t index)
	Todo. More...
void	destroyAllEventHandlers (void)
	Todo. More...
float	getObserverInterval (void) const
	Return the interval value, which defines at what interval the observer is called. More...
void	setObserverInterval (float observerInterval)
	Set the interval value, which defines at what interval the observer is called. More...
bool	getObserveUntilEvent (void) const
	Return the value of mObserveUntilEvent. More...
void	setObserveUntilEvent (bool observeUntilEvent)
	Sets the value of mObserveUntilEvent. More...
bool	isParticleTypeToObserveSet (void) const
	Returns true if the particle type to observe specifically has been set. More...
virtual	~PUObserver (void)
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 Member Functions
static PUOnTimeObserver *	create ()
local	create ()

Public Attributes
CC_CONSTRUCTOR_ACCESS	__pad0__: PUOnTimeObserver(void)
Public Attributes inherited from PUObserver
CC_CONSTRUCTOR_ACCESS	__pad0__: PUObserver(void)

Static Public Attributes
static const float	DEFAULT_THRESHOLD
static const bool	DEFAULT_SINCE_START_SYSTEM
var	DEFAULT_SINCE_START_SYSTEM
local	DEFAULT_SINCE_START_SYSTEM
Static Public Attributes inherited from PUObserver
static const bool	DEFAULT_ENABLED
var	DEFAULT_ENABLED
local	DEFAULT_ENABLED
static const PUParticle3D::ParticleType	DEFAULT_PARTICLE_TYPE
static const float	DEFAULT_INTERVAL
static const bool	DEFAULT_UNTIL_EVENT
var	DEFAULT_UNTIL_EVENT
local	DEFAULT_UNTIL_EVENT

Protected Attributes
float	_threshold
PUComparisionOperator	_compare
var	_compare
local	_compare
bool	_sinceStartSystem
Protected Attributes inherited from PUObserver
PUParticleSystem3D *	_particleSystem
std::string	_observerType
std::string	_name
bool	_enabled
	Determines whether an observer is activated. More...
bool	_originalEnabled
bool	_originalEnabledSet
bool	_observe
	Determines whether the _observe() function must be executed. More...
bool	_observeUntilEvent
	Observes until an event takes place. More...
bool	_eventHandlersExecuted
	Flag that is set if the event handler(s) are called at least once. More...
Vec3	_observerScale
	Although the scale is on a Particle System level, the observer can also be scaled. More...
PUParticle3D::ParticleType	_particleTypeToObserve
local	_particleTypeToObserve
bool	_particleTypeToObserveSet
	Determines whether mParticleTypeToObserve is set. More...
ParticleEventHandlerList	_eventHandlers
float	_observerInterval
	Values that determine that the observer is called after every interval. More...
float	_observerIntervalRemainder
bool	_observerIntervalSet
Protected Attributes inherited from Ref
unsigned int	_referenceCount
	count of references More...
local	_referenceCount
	count of references More...

Additional Inherited Members
Public Types inherited from PUObserver
typedef std::vector < PUEventHandler * >::iterator	ParticleEventHandlerIterator
typedef std::vector < PUEventHandler * > ::const_iterator	ParticleEventHandlerConstIterator
typedef std::vector < PUEventHandler * >	ParticleEventHandlerList
Protected Member Functions inherited from PUObserver
virtual void	handleObserve (PUParticle3D *particle, float timeElapsed)
	Handle the observer implementation. More...
local	handleObserve ( local particle, local timeElapsed)
	Handle the observer implementation. More...
virtual void	handleEvent (PUParticle3D *particle, float timeElapsed)
	Handle the event. More...
var	handleEvent ( var particle, var timeElapsed)
	Handle the event. More...
local	handleEvent ( local particle, local timeElapsed)
	Handle the event. More...
Protected Member Functions inherited from Ref
	Ref ()
	Constructor. More...
	Ref ()
	Constructor. More...

Constructor & Destructor Documentation

virtual ~PUOnTimeObserver ( void  )

inlinevirtual

var ~PUOnTimeObserver (   )

inlinevirtual

local ~PUOnTimeObserver (   )

inlinevirtual

Member Function Documentation

virtual void copyAttributesTo ( PUObserver *  observer )

overridevirtual

Reimplemented from PUObserver.

var copyAttributesTo ( var  observer )

overridevirtual

Reimplemented from PUObserver.

local copyAttributesTo ( local  observer )

overridevirtual

Reimplemented from PUObserver.

static PUOnTimeObserver* create ( )

static

var create ( )

static

local create ( )

static

const PUComparisionOperator getCompare ( void  ) const

inline

var getCompare (   )

inline

local getCompare (   )

inline

float getThreshold ( void  ) const

inline

var getThreshold (   )

inline

local getThreshold (   )

inline

bool isSinceStartSystem ( void  ) const

inline

var isSinceStartSystem (   )

inline

local isSinceStartSystem (   )

inline

virtual bool observe ( PUParticle3D *  particle, float  timeElapsed  )

overridevirtual

This function determines whether a condition (the event) is true or false.

Implements PUObserver.

var observe ( var  particle, var  timeElapsed  )

overridevirtual

This function determines whether a condition (the event) is true or false.

Implements PUObserver.

local observe ( local  particle, local  timeElapsed  )

overridevirtual

This function determines whether a condition (the event) is true or false.

Implements PUObserver.

virtual void preUpdateObserver ( float  deltaTime )

overridevirtual

In case there are no particles, but the observation returns true, the event handlers must still be called.

Reimplemented from PUObserver.

var preUpdateObserver ( var  deltaTime )

overridevirtual

In case there are no particles, but the observation returns true, the event handlers must still be called.

Reimplemented from PUObserver.

local preUpdateObserver ( local  deltaTime )

overridevirtual

In case there are no particles, but the observation returns true, the event handlers must still be called.

Reimplemented from PUObserver.

void setCompare ( PUComparisionOperator  op )

inline

var setCompare ( var  op )

inline

local setCompare ( local  op )

inline

void setSinceStartSystem ( bool  sinceStartSystem )

inline

var setSinceStartSystem ( var  sinceStartSystem )

inline

local setSinceStartSystem ( local  sinceStartSystem )

inline

void setThreshold ( float  threshold )

inline

var setThreshold ( var  threshold )

inline

local setThreshold ( local  threshold )

inline

Member Data Documentation

CC_CONSTRUCTOR_ACCESS __pad0__

var __pad0__

local __pad0__

PUComparisionOperator _compare

protected

var _compare

protected

local _compare

protected

bool _sinceStartSystem

protected

var _sinceStartSystem

protected

local _sinceStartSystem

protected

float _threshold

protected

var _threshold

protected

local _threshold

protected

const bool DEFAULT_SINCE_START_SYSTEM

static

var DEFAULT_SINCE_START_SYSTEM

static

local DEFAULT_SINCE_START_SYSTEM

static

const float DEFAULT_THRESHOLD

static

var DEFAULT_THRESHOLD

static

local DEFAULT_THRESHOLD

static

---

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

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