modm API documentation
Public Typedefs | Public Member Functions | List of all members
modm::ui::AnimationBase< T > Class Template Referenceabstract
User interface » Animators
Inheritance diagram for modm::ui::AnimationBase< T >:
modm::ui::Animation< T >

Public Typedefs

using TimeType = uint32_t
 

Public Member Functions

virtual void setValue (T value) = 0
 stop any running animation and set a value.
 
virtual bool isAnimating () const = 0
 
virtual void stop () = 0
 stops any running animation.
 
virtual bool animateTo (T value, uint32_t time) = 0
 
virtual bool update ()
 

Member Function Documentation

template<typename T >
virtual bool modm::ui::AnimationBase< T >::animateTo ( T  value,
uint32_t  time 
)
pure virtual

Animate from the current value to a new value in the specified ms.

Returns
true if animation started, false if otherwise

Implemented in modm::ui::Animation< uint8_t >, and modm::ui::Animation< T >.

template<typename T >
virtual bool modm::ui::AnimationBase< T >::isAnimating ( ) const
pure virtual
Returns
true if animation is currently running, false if otherwise

Implemented in modm::ui::Animation< T >, and modm::ui::Animation< uint8_t >.

template<typename T >
virtual bool modm::ui::AnimationBase< T >::update ( )
inlinevirtual
Returns
true if the value has been changed, false otherwise

Reimplemented in modm::ui::Animation< T >, and modm::ui::Animation< uint8_t >.

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