TissueForge::event::EventBase Struct Reference

Inheritance diagram for TissueForge::event::EventBase:

Public Member Functions
virtual HRESULT	predicate ()=0
virtual HRESULT	invoke ()=0
virtual HRESULT	eval (const FloatP_t &time)
void	remove ()
	Designates event for removal.

Public Attributes
std::forward_list< EventFlag >	flags
FloatP_t	last_fired
	Record of last time fired.
int	times_fired
	Record of how many times fired.

Member Function Documentation

invoke()

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

pure virtual

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

Implemented in TissueForge::event::Event, TissueForge::event::ParticleEvent, TissueForge::event::ParticleTimeEvent, TissueForge::event::TimeEvent, TissueForge::py::EventPy, TissueForge::py::ParticleEventPy, TissueForge::py::ParticleTimeEventPy, and TissueForge::py::TimeEventPy.

predicate()

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

pure 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

Implemented in TissueForge::event::Event, TissueForge::event::ParticleEvent, TissueForge::event::ParticleTimeEvent, TissueForge::event::TimeEvent, TissueForge::py::EventPy, TissueForge::py::ParticleEventPy, TissueForge::py::ParticleTimeEventPy, and TissueForge::py::TimeEventPy.

---

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

• source/event/tfEvent.h