TissueForge::event::ParticleEvent Struct Reference

Inheritance diagram for TissueForge::event::ParticleEvent:

Collaboration diagram for TissueForge::event::ParticleEvent:

Public Member Functions
	ParticleEvent (ParticleType *targetType, ParticleEventMethod *invokeMethod, ParticleEventMethod *predicateMethod, ParticleEventParticleSelector *particleSelector=NULL)
virtual HRESULT	predicate ()
virtual HRESULT	invoke ()
virtual HRESULT	eval (const FloatP_t &time)
HRESULT	setParticleEventParticleSelector (ParticleEventParticleSelector *particleSelector)
HRESULT	setParticleEventParticleSelector (ParticleEventParticleSelectorEnum selectorEnum)
HRESULT	setParticleEventParticleSelector (std::string selectorName)
Public Member Functions inherited from TissueForge::event::EventBase
void	remove ()
	Designates event for removal.

Public Attributes
ParticleType *	targetType
	Target particle type of this event.
ParticleHandle *	targetParticle
	Target particle of an event evaluation.
Public Attributes inherited from TissueForge::event::EventBase
std::forward_list< EventFlag >	flags
FloatP_t	last_fired
	Record of last time fired.
int	times_fired
	Record of how many times fired.

Protected Member Functions
ParticleHandle *	getNextParticle ()

Member Function Documentation

eval()

virtual HRESULT TissueForge::event::ParticleEvent::eval ( const FloatP_t & time )

virtual

Reimplemented from TissueForge::event::EventBase.

invoke()

virtual HRESULT TissueForge::event::ParticleEvent::invoke ( )

virtual

What occurs during an event. Typically, this invokes an underlying specialized method returns 0 if OK and 1 on error.

Implements TissueForge::event::EventBase.

Reimplemented in TissueForge::py::ParticleEventPy.

predicate()

virtual HRESULT TissueForge::event::ParticleEvent::predicate ( )

virtual

Evaluates an event predicate, returns 0 if the event should not fire, 1 if the event should, and a negative value on error. A predicate without a defined predicate method always returns 0

Implements TissueForge::event::EventBase.

Reimplemented in TissueForge::py::ParticleEventPy.

---

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

• source/event/tfParticleEvent.h