tfC_event.h File Reference

#include "tf_port_c.h"
#include "tfCParticle.h"

Include dependency graph for tfC_event.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	tfEventParticleEventParticleSelectorEnumHandle
struct	tfEventTimeEventTimeSetterEnumHandle
struct	tfEventParticleTimeEventParticleSelectorEnumHandle
struct	tfEventParticleTimeEventTimeSetterEnumHandle
struct	tfEventEventHandle
	Handle to a event::Event instance. More...
struct	tfEventParticleEventHandle
	Handle to a event::ParticleEvent instance. More...
struct	tfEventTimeEventHandle
	Handle to a event::TimeEvent instance. More...
struct	tfEventParticleTimeEventHandle
	Handle to a event::ParticleTimeEvent instance. More...

Typedefs
typedef HRESULT(*	tfEventEventMethodHandleFcn) (struct tfEventEventHandle *)
typedef HRESULT(*	tfEventParticleEventMethodHandleFcn) (struct tfEventParticleEventHandle *)
typedef HRESULT(*	tfEventTimeEventMethodHandleFcn) (struct tfEventTimeEventHandle *)
typedef HRESULT(*	tfEventParticleTimeEventMethodHandleFcn) (struct tfEventParticleTimeEventHandle *)

Functions
HRESULT	tfEventParticleEventParticleSelectorEnum_init (struct tfEventParticleEventParticleSelectorEnumHandle *handle)
	Initialize an instance.
HRESULT	tfEventTimeEventTimeSetterEnum_init (struct tfEventTimeEventTimeSetterEnumHandle *handle)
	Initialize an instance.
HRESULT	tfEventParticleTimeEventParticleSelectorEnum_init (struct tfEventParticleTimeEventParticleSelectorEnumHandle *handle)
	Initialize an instance.
HRESULT	tfEventParticleTimeEventTimeSetterEnum_init (struct tfEventParticleTimeEventTimeSetterEnumHandle *handle)
	Initialize an instance.
HRESULT	tfEventEvent_getLastFired (struct tfEventEventHandle *handle, tfFloatP_t *last_fired)
	Get the last time an event was fired.
HRESULT	tfEventEvent_getTimesFired (struct tfEventEventHandle *handle, unsigned int *times_fired)
	Get the number of times an event has fired.
HRESULT	tfEventEvent_remove (struct tfEventEventHandle *handle)
	Designates event for removal.
HRESULT	tfEventParticleEvent_getLastFired (struct tfEventParticleEventHandle *handle, tfFloatP_t *last_fired)
	Get the last time an event was fired.
HRESULT	tfEventParticleEvent_getTimesFired (struct tfEventParticleEventHandle *handle, unsigned int *times_fired)
	Get the number of times an event has fired.
HRESULT	tfEventParticleEvent_remove (struct tfEventParticleEventHandle *handle)
	Designates event for removal.
HRESULT	tfEventParticleEvent_getTargetType (struct tfEventParticleEventHandle *handle, struct tfParticleTypeHandle *targetType)
	Get the target particle type of this event.
HRESULT	tfEventParticleEvent_getTargetParticle (struct tfEventParticleEventHandle *handle, struct tfParticleHandleHandle *targetParticle)
	Get the target particle of an event evaluation.
HRESULT	tfEventTimeEvent_getLastFired (struct tfEventTimeEventHandle *handle, tfFloatP_t *last_fired)
	Get the last time an event was fired.
HRESULT	tfEventTimeEvent_getTimesFired (struct tfEventTimeEventHandle *handle, unsigned int *times_fired)
	Get the number of times an event has fired.
HRESULT	tfEventTimeEvent_remove (struct tfEventTimeEventHandle *handle)
	Designates event for removal.
HRESULT	tfEventTimeEvent_getNextTime (struct tfEventTimeEventHandle *handle, tfFloatP_t *next_time)
	Get the next time of evaluation.
HRESULT	tfEventTimeEvent_getPeriod (struct tfEventTimeEventHandle *handle, tfFloatP_t *period)
	Get the period of evaluation.
HRESULT	tfEventTimeEvent_getStartTime (struct tfEventTimeEventHandle *handle, tfFloatP_t *start_time)
	Get the start time of evaluations.
HRESULT	tfEventTimeEvent_getEndTime (struct tfEventTimeEventHandle *handle, tfFloatP_t *end_time)
	Get the end time of evaluations.
HRESULT	tfEventParticleTimeEvent_getLastFired (struct tfEventParticleTimeEventHandle *handle, tfFloatP_t *last_fired)
	Get the last time an event was fired.
HRESULT	tfEventParticleTimeEvent_getTimesFired (struct tfEventParticleTimeEventHandle *handle, unsigned int *times_fired)
	Get the number of times an event has fired.
HRESULT	tfEventParticleTimeEvent_remove (struct tfEventParticleTimeEventHandle *handle)
	Designates event for removal.
HRESULT	tfEventParticleTimeEvent_getNextTime (struct tfEventParticleTimeEventHandle *handle, tfFloatP_t *next_time)
	Get the next time of evaluation.
HRESULT	tfEventParticleTimeEvent_getPeriod (struct tfEventParticleTimeEventHandle *handle, tfFloatP_t *period)
	Get the period of evaluation.
HRESULT	tfEventParticleTimeEvent_getStartTime (struct tfEventParticleTimeEventHandle *handle, tfFloatP_t *start_time)
	Get the start time of evaluations.
HRESULT	tfEventParticleTimeEvent_getEndTime (struct tfEventParticleTimeEventHandle *handle, tfFloatP_t *end_time)
	Get the end time of evaluations.
HRESULT	tfEventParticleTimeEvent_getTargetType (struct tfEventParticleTimeEventHandle *handle, struct tfParticleTypeHandle *targetType)
	Get the target particle type of this event.
HRESULT	tfEventParticleTimeEvent_getTargetParticle (struct tfEventParticleTimeEventHandle *handle, struct tfParticleHandleHandle *targetParticle)
	Get the target particle of an event evaluation.
HRESULT	tfEventOnEvent (struct tfEventEventHandle *handle, tfEventEventMethodHandleFcn *invokeMethod, tfEventEventMethodHandleFcn *predicateMethod)
	Creates an event using prescribed invoke and predicate functions.
HRESULT	tfEventOnParticleEvent (struct tfEventParticleEventHandle *handle, struct tfParticleTypeHandle *targetType, unsigned int selectorEnum, tfEventParticleEventMethodHandleFcn *invokeMethod, tfEventParticleEventMethodHandleFcn *predicateMethod)
	Creates a particle event using prescribed invoke and predicate functions.
HRESULT	tfEventOnTimeEvent (struct tfEventTimeEventHandle *handle, tfFloatP_t period, tfEventTimeEventMethodHandleFcn *invokeMethod, tfEventTimeEventMethodHandleFcn *predicateMethod, unsigned int nextTimeSetterEnum, tfFloatP_t start_time, tfFloatP_t end_time)
	Creates a time-dependent event using prescribed invoke and predicate functions.
HRESULT	tfEventOnParticleTimeEvent (struct tfEventParticleTimeEventHandle *handle, struct tfParticleTypeHandle *targetType, tfFloatP_t period, tfEventParticleTimeEventMethodHandleFcn *invokeMethod, tfEventParticleTimeEventMethodHandleFcn *predicateMethod, unsigned int nextTimeSetterEnum, tfFloatP_t start_time, tfFloatP_t end_time, unsigned int particleSelectorEnum)
	Creates a time-dependent particle event using prescribed invoke and predicate functions.

Function Documentation

tfEventEvent_getLastFired()

HRESULT tfEventEvent_getLastFired	(	struct tfEventEventHandle *	handle,
		tfFloatP_t *	last_fired )

Get the last time an event was fired.

Parameters

handle	populated handle
last_fired	last time fired

Returns

S_OK on success

tfEventEvent_getTimesFired()

HRESULT tfEventEvent_getTimesFired	(	struct tfEventEventHandle *	handle,
		unsigned int *	times_fired )

Get the number of times an event has fired.

Parameters

handle	populated handle
times_fired	number of times fired

Returns

S_OK on success

tfEventEvent_remove()

HRESULT tfEventEvent_remove

(

struct tfEventEventHandle *

handle

)

Designates event for removal.

Parameters

handle

populated handle

Returns

S_OK on success

tfEventOnEvent()

HRESULT tfEventOnEvent	(	struct tfEventEventHandle *	handle,
		tfEventEventMethodHandleFcn *	invokeMethod,
		tfEventEventMethodHandleFcn *	predicateMethod )

Creates an event using prescribed invoke and predicate functions.

Parameters

handle	handle to populate
invokeMethod	an invoke function; evaluated when an event occurs
predicateMethod	a predicate function; evaluated to determine if an event occurs

Returns

S_OK on success

tfEventOnParticleEvent()

HRESULT tfEventOnParticleEvent	(	struct tfEventParticleEventHandle *	handle,
		struct tfParticleTypeHandle *	targetType,
		unsigned int	selectorEnum,
		tfEventParticleEventMethodHandleFcn *	invokeMethod,
		tfEventParticleEventMethodHandleFcn *	predicateMethod )

Creates a particle event using prescribed invoke and predicate functions.

Parameters

handle	handle to populate
targetType	target particle type
selectorEnum	particle selector enum
invokeMethod	an invoke function; evaluated when an event occurs
predicateMethod	a predicate function; evaluated to determine if an event occurs

Returns

S_OK on success

tfEventOnParticleTimeEvent()

HRESULT tfEventOnParticleTimeEvent	(	struct tfEventParticleTimeEventHandle *	handle,
		struct tfParticleTypeHandle *	targetType,
		tfFloatP_t	period,
		tfEventParticleTimeEventMethodHandleFcn *	invokeMethod,
		tfEventParticleTimeEventMethodHandleFcn *	predicateMethod,
		unsigned int	nextTimeSetterEnum,
		tfFloatP_t	start_time,
		tfFloatP_t	end_time,
		unsigned int	particleSelectorEnum )

Creates a time-dependent particle event using prescribed invoke and predicate functions.

Parameters

handle	handle to populate
targetType	target particle type
period	period of evaluations
invokeMethod	an invoke function; evaluated when an event occurs
predicateMethod	a predicate function; evaluated to determine if an event occurs
nextTimeSetterEnum	enum of function that sets the next evaulation time
start_time	time at which evaluations begin
end_time	time at which evaluations end
particleSelectorEnum	enum of function that selects the next particle

Returns

S_OK on success

tfEventOnTimeEvent()

HRESULT tfEventOnTimeEvent	(	struct tfEventTimeEventHandle *	handle,
		tfFloatP_t	period,
		tfEventTimeEventMethodHandleFcn *	invokeMethod,
		tfEventTimeEventMethodHandleFcn *	predicateMethod,
		unsigned int	nextTimeSetterEnum,
		tfFloatP_t	start_time,
		tfFloatP_t	end_time )

Creates a time-dependent event using prescribed invoke and predicate functions.

Parameters

handle	handle to populate
period	period of evaluations
invokeMethod	an invoke function; evaluated when an event occurs
predicateMethod	a predicate function; evaluated to determine if an event occurs
nextTimeSetterEnum	enum selecting the function that sets the next evaulation time
start_time	time at which evaluations begin
end_time	time at which evaluations end

Returns

S_OK on success

tfEventParticleEvent_getLastFired()

HRESULT tfEventParticleEvent_getLastFired	(	struct tfEventParticleEventHandle *	handle,
		tfFloatP_t *	last_fired )

Get the last time an event was fired.

Parameters

handle	populated handle
last_fired	last time fired

Returns

S_OK on success

tfEventParticleEvent_getTargetParticle()

HRESULT tfEventParticleEvent_getTargetParticle	(	struct tfEventParticleEventHandle *	handle,
		struct tfParticleHandleHandle *	targetParticle )

Get the target particle of an event evaluation.

Parameters

handle	populated handle
targetParticle	target particle

Returns

S_OK on success

tfEventParticleEvent_getTargetType()

HRESULT tfEventParticleEvent_getTargetType	(	struct tfEventParticleEventHandle *	handle,
		struct tfParticleTypeHandle *	targetType )

Get the target particle type of this event.

Parameters

handle	populated handle
targetType	target particle type

Returns

S_OK on success

tfEventParticleEvent_getTimesFired()

HRESULT tfEventParticleEvent_getTimesFired	(	struct tfEventParticleEventHandle *	handle,
		unsigned int *	times_fired )

Get the number of times an event has fired.

Parameters

handle	populated handle
times_fired	number of times fired

Returns

S_OK on success

tfEventParticleEvent_remove()

HRESULT tfEventParticleEvent_remove

(

struct tfEventParticleEventHandle *

handle

)

Designates event for removal.

Parameters

handle

populated handle

Returns

S_OK on success

tfEventParticleEventParticleSelectorEnum_init()

HRESULT tfEventParticleEventParticleSelectorEnum_init

(

struct tfEventParticleEventParticleSelectorEnumHandle *

handle

)

Initialize an instance.

Parameters

handle

handle to populate

Returns

S_OK on success

tfEventParticleTimeEvent_getEndTime()

HRESULT tfEventParticleTimeEvent_getEndTime	(	struct tfEventParticleTimeEventHandle *	handle,
		tfFloatP_t *	end_time )

Get the end time of evaluations.

Parameters

handle	populated handle
end_time	end time of evaluations

Returns

S_OK on success

tfEventParticleTimeEvent_getLastFired()

HRESULT tfEventParticleTimeEvent_getLastFired	(	struct tfEventParticleTimeEventHandle *	handle,
		tfFloatP_t *	last_fired )

Get the last time an event was fired.

Parameters

handle	populated handle
last_fired	last time fired

Returns

S_OK on success

tfEventParticleTimeEvent_getNextTime()

HRESULT tfEventParticleTimeEvent_getNextTime	(	struct tfEventParticleTimeEventHandle *	handle,
		tfFloatP_t *	next_time )

Get the next time of evaluation.

Parameters

handle	populated handle
next_time	next time of evaluation

Returns

S_OK on success

tfEventParticleTimeEvent_getPeriod()

HRESULT tfEventParticleTimeEvent_getPeriod	(	struct tfEventParticleTimeEventHandle *	handle,
		tfFloatP_t *	period )

Get the period of evaluation.

Parameters

handle	populated handle
period	period of evaluation

Returns

S_OK on success

tfEventParticleTimeEvent_getStartTime()

HRESULT tfEventParticleTimeEvent_getStartTime	(	struct tfEventParticleTimeEventHandle *	handle,
		tfFloatP_t *	start_time )

Get the start time of evaluations.

Parameters

handle	populated handle
start_time	start time of evaluations

Returns

S_OK on success

tfEventParticleTimeEvent_getTargetParticle()

HRESULT tfEventParticleTimeEvent_getTargetParticle	(	struct tfEventParticleTimeEventHandle *	handle,
		struct tfParticleHandleHandle *	targetParticle )

Get the target particle of an event evaluation.

Parameters

handle	populated handle
targetParticle	target particle

Returns

S_OK on success

tfEventParticleTimeEvent_getTargetType()

HRESULT tfEventParticleTimeEvent_getTargetType	(	struct tfEventParticleTimeEventHandle *	handle,
		struct tfParticleTypeHandle *	targetType )

Get the target particle type of this event.

Parameters

handle	populated handle
targetType	target particle type

Returns

S_OK on success

tfEventParticleTimeEvent_getTimesFired()

HRESULT tfEventParticleTimeEvent_getTimesFired	(	struct tfEventParticleTimeEventHandle *	handle,
		unsigned int *	times_fired )

Get the number of times an event has fired.

Parameters

handle	populated handle
times_fired	number of times fired

Returns

S_OK on success

tfEventParticleTimeEvent_remove()

HRESULT tfEventParticleTimeEvent_remove

(

struct tfEventParticleTimeEventHandle *

handle

)

Designates event for removal.

Parameters

handle

populated handle

Returns

S_OK on success

tfEventParticleTimeEventParticleSelectorEnum_init()

HRESULT tfEventParticleTimeEventParticleSelectorEnum_init

(

struct tfEventParticleTimeEventParticleSelectorEnumHandle *

handle

)

Initialize an instance.

Parameters

handle

handle to populate

Returns

S_OK on success

tfEventParticleTimeEventTimeSetterEnum_init()

HRESULT tfEventParticleTimeEventTimeSetterEnum_init

(

struct tfEventParticleTimeEventTimeSetterEnumHandle *

handle

)

Initialize an instance.

Parameters

handle

handle to populate

Returns

S_OK on success

tfEventTimeEvent_getEndTime()

HRESULT tfEventTimeEvent_getEndTime	(	struct tfEventTimeEventHandle *	handle,
		tfFloatP_t *	end_time )

Get the end time of evaluations.

Parameters

handle	populated handle
end_time	end time of evaluations

Returns

S_OK on success

tfEventTimeEvent_getLastFired()

HRESULT tfEventTimeEvent_getLastFired	(	struct tfEventTimeEventHandle *	handle,
		tfFloatP_t *	last_fired )

Get the last time an event was fired.

Parameters

handle	populated handle
last_fired	last time fired

Returns

S_OK on success

tfEventTimeEvent_getNextTime()

HRESULT tfEventTimeEvent_getNextTime	(	struct tfEventTimeEventHandle *	handle,
		tfFloatP_t *	next_time )

Get the next time of evaluation.

Parameters

handle	populated handle
next_time	next time of evaluation

Returns

S_OK on success

tfEventTimeEvent_getPeriod()

HRESULT tfEventTimeEvent_getPeriod	(	struct tfEventTimeEventHandle *	handle,
		tfFloatP_t *	period )

Get the period of evaluation.

Parameters

handle	populated handle
period	period of evaluation

Returns

S_OK on success

tfEventTimeEvent_getStartTime()

HRESULT tfEventTimeEvent_getStartTime	(	struct tfEventTimeEventHandle *	handle,
		tfFloatP_t *	start_time )

Get the start time of evaluations.

Parameters

handle	populated handle
start_time	start time of evaluations

Returns

S_OK on success

tfEventTimeEvent_getTimesFired()

HRESULT tfEventTimeEvent_getTimesFired	(	struct tfEventTimeEventHandle *	handle,
		unsigned int *	times_fired )

Get the number of times an event has fired.

Parameters

handle	populated handle
times_fired	number of times fired

Returns

S_OK on success

tfEventTimeEvent_remove()

HRESULT tfEventTimeEvent_remove

(

struct tfEventTimeEventHandle *

handle

)

Designates event for removal.

Parameters

handle

populated handle

Returns

S_OK on success

tfEventTimeEventTimeSetterEnum_init()

HRESULT tfEventTimeEventTimeSetterEnum_init

(

struct tfEventTimeEventTimeSetterEnumHandle *

handle

)

Initialize an instance.

Parameters

handle

handle to populate

Returns

S_OK on success