Blue Brain BioExplorer
Public Types | Public Member Functions | List of all members
core::AnimationParameters Class Reference

#include <AnimationParameters.h>

Inheritance diagram for core::AnimationParameters:
Inheritance graph
[legend]
Collaboration diagram for core::AnimationParameters:
Collaboration graph
[legend]

Public Types

using IsReadyCallback = std::function< bool()>
 
- Public Types inherited from core::BaseObject
using ModifiedCallback = std::function< void(const BaseObject &)>
 

Public Member Functions

 AnimationParameters ()
 
void print () final
 
void reset ()
 
void setFrame (uint32_t value)
 
uint32_t getFrame () const
 
void setDelta (const int32_t delta)
 
int32_t getDelta () const
 
void setNumFrames (const uint32_t numFrames, const bool triggerCallback=true)
 
uint32_t getNumFrames () const
 
void setDt (const double dt, const bool triggerCallback=true)
 
double getDt () const
 
void setUnit (const std::string &unit, const bool triggerCallback=true)
 
void setIsReadyCallback (const IsReadyCallback &callback)
 
void removeIsReadyCallback ()
 
bool hasIsReadyCallback () const
 
void update ()
 
void jumpFrames (int frames)
 
void togglePlayback ()
 
bool isPlaying () const
 
- Public Member Functions inherited from core::AbstractParameters
 AbstractParameters (const std::string &name)
 
virtual ~AbstractParameters ()=default
 
virtual void parse (const po::variables_map &)
 
po::options_description & parameters ()
 
- Public Member Functions inherited from core::BaseObject
 BaseObject ()=default
 
virtual ~BaseObject ()=default
 
 BaseObject (const BaseObject &)
 
BaseObject & operator= (const BaseObject &rhs)
 
bool isModified () const
 
void resetModified ()
 
void markModified (const bool triggerCallback=true)
 
void onModified (const ModifiedCallback &callback)
 
void clearModifiedCallback ()
 

Additional Inherited Members

- Protected Member Functions inherited from core::BaseObject
template<typename T >
void _updateValue (T &member, const T &newValue, const bool triggerCallback=true)
 
template<class T >
bool _isEqual (const T &a, const T &b, typename std::enable_if< std::is_floating_point< T >::value >::type *=0)
 
template<class T >
bool _isEqual (const T &a, const T &b, typename std::enable_if<!std::is_floating_point< T >::value >::type *=0)
 
- Static Protected Member Functions inherited from core::AbstractParameters
static std::string asString (const bool flag)
 
- Protected Attributes inherited from core::AbstractParameters
std::string _name
 
po::options_description _parameters
 

Detailed Description

Definition at line 32 of file AnimationParameters.h.

Member Typedef Documentation

◆ IsReadyCallback

using core::AnimationParameters::IsReadyCallback = std::function<bool()>

Definition at line 63 of file AnimationParameters.h.

Constructor & Destructor Documentation

◆ AnimationParameters()

core::AnimationParameters::AnimationParameters ( )

Definition at line 33 of file AnimationParameters.cpp.

Member Function Documentation

◆ getDelta()

int32_t core::AnimationParameters::getDelta ( ) const
inline

Definition at line 48 of file AnimationParameters.h.

◆ getDt()

double core::AnimationParameters::getDt ( ) const
inline

Definition at line 57 of file AnimationParameters.h.

◆ getFrame()

uint32_t core::AnimationParameters::getFrame ( ) const
inline

Definition at line 45 of file AnimationParameters.h.

◆ getNumFrames()

uint32_t core::AnimationParameters::getNumFrames ( ) const
inline

Definition at line 54 of file AnimationParameters.h.

◆ hasIsReadyCallback()

bool core::AnimationParameters::hasIsReadyCallback ( ) const
inline

Definition at line 82 of file AnimationParameters.h.

◆ isPlaying()

bool core::AnimationParameters::isPlaying ( ) const
inline

Definition at line 90 of file AnimationParameters.h.

◆ jumpFrames()

void core::AnimationParameters::jumpFrames ( int  frames)

Jump 'frames' from current frame if all listeners are ready.

Definition at line 74 of file AnimationParameters.cpp.

◆ print()

void core::AnimationParameters::print ( )
finalvirtual

Displays values of registered parameters

Reimplemented from core::AbstractParameters.

Definition at line 42 of file AnimationParameters.cpp.

◆ removeIsReadyCallback()

void core::AnimationParameters::removeIsReadyCallback ( )
inline

Remove the given callback from the list of IsReadyCallbacks.

Definition at line 73 of file AnimationParameters.h.

◆ reset()

void core::AnimationParameters::reset ( )

Reset to a 'no animation' state: 0 for dt, start and end.

Definition at line 48 of file AnimationParameters.cpp.

◆ setDelta()

void core::AnimationParameters::setDelta ( const int32_t  delta)

The (frame) delta to apply for animations to select the next frame.

Definition at line 61 of file AnimationParameters.cpp.

◆ setDt()

void core::AnimationParameters::setDt ( const double  dt,
const bool  triggerCallback = true 
)
inline

The dt of a simulation.

Definition at line 56 of file AnimationParameters.h.

◆ setFrame()

void core::AnimationParameters::setFrame ( uint32_t  value)
inline

The current frame number of the animation.

Definition at line 44 of file AnimationParameters.h.

◆ setIsReadyCallback()

void core::AnimationParameters::setIsReadyCallback ( const IsReadyCallback &  callback)
inline

Set a callback to report if the current animation frame is ready (e.g. simulation has been loaded) and the animation can advance to the next frame.

Definition at line 70 of file AnimationParameters.h.

◆ setNumFrames()

void core::AnimationParameters::setNumFrames ( const uint32_t  numFrames,
const bool  triggerCallback = true 
)
inline

Definition at line 49 of file AnimationParameters.h.

◆ setUnit()

void core::AnimationParameters::setUnit ( const std::string &  unit,
const bool  triggerCallback = true 
)
inline

The time unit of a simulation.

Definition at line 59 of file AnimationParameters.h.

◆ togglePlayback()

void core::AnimationParameters::togglePlayback ( )
inline

Definition at line 89 of file AnimationParameters.h.

◆ update()

void core::AnimationParameters::update ( )

Update the current frame if delta is set and all listeners are ready.

Definition at line 68 of file AnimationParameters.cpp.

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