SOFA API  6a688117
Open source framework for multi-physics simuation
sofa::simulation::AnimateBeginEvent Class Reference

#include <AnimateBeginEvent.h>

Inheritance diagram for sofa::simulation::AnimateBeginEvent:

Detailed Description

Event fired by Simulation::animate() before computing a new animation step.

Author
Jeremie Allard

Protected Attributes

SReal dt
 
- Protected Attributes inherited from sofa::core::objectmodel::Event
bool m_handled
 

Public Member Functions

 AnimateBeginEvent (SReal dt)
 
 ~AnimateBeginEvent () override
 
SReal getDt () const
 
- Public Member Functions inherited from sofa::core::objectmodel::Event
 Event ()
 
virtual ~Event ()
 
void setHandled ()
 Tag the event as handled, i.e. the event needs not be propagated further. More...
 
bool isHandled () const
 Returns true of the event has been handled. More...
 
virtual const char * getClassName () const
 
virtual size_t getEventTypeIndex () const =0
 

Static Public Member Functions

static const char * GetClassName ()
 
- Static Public Member Functions inherited from sofa::core::objectmodel::Event
static const char * GetClassName ()
 
static size_t getEventTypeCount ()
 

Additional Inherited Members

- Static Protected Attributes inherited from sofa::core::objectmodel::Event
static size_t s_lastEventTypeIndex = 0
 storing the last given id More...
 

Attribute details

SReal sofa::simulation::AnimateBeginEvent::dt
protected

Constructor details

sofa::simulation::AnimateBeginEvent::AnimateBeginEvent ( SReal  dt)
sofa::simulation::AnimateBeginEvent::~AnimateBeginEvent ( )
override

Function details

static const char* sofa::simulation::AnimateBeginEvent::GetClassName ( )
inlinestatic
SReal sofa::simulation::AnimateBeginEvent::getDt ( ) const
inline