OpenSiv3D  v0.6.5
C++20 framework for creative coding
s3d::EasingAB< Type > Class Template Reference

#include <EasingAB.hpp>

Public Types

using value_type = Type
 

Public Member Functions

SIV3D_NODISCARD_CXX20 EasingAB ()=default
 
SIV3D_NODISCARD_CXX20 EasingAB (const value_type &a, const value_type &b, double easingFunction(double), double durationMillisec, ISteadyClock *pSteadyClock=nullptr)
 
SIV3D_NODISCARD_CXX20 EasingAB (const value_type &a, const value_type &b, double easingFunction(double), const Duration &duration=SecondsF{ 1.0 }, ISteadyClock *pSteadyClock=nullptr)
 
void start ()
 
void pause ()
 
void resume ()
 
void reset ()
 
auto easeIn () const
 
auto easeOut () const
 
auto easeInOut () const
 
auto value () const
 
const value_typegetA () const noexcept
 
const value_typegetB () const noexcept
 
void setA (const value_type &value)
 
void setB (const value_type &value)
 
bool onA () const
 
bool onB () const
 
double progress0_1 () const
 
bool isMoving () const
 
bool done () const
 
const Type & base () const noexcept
 
void jumpToA ()
 
void jumpToB ()
 

Member Typedef Documentation

◆ value_type

template<class Type >
using s3d::EasingAB< Type >::value_type = Type

Constructor & Destructor Documentation

◆ EasingAB() [1/3]

template<class Type >
SIV3D_NODISCARD_CXX20 s3d::EasingAB< Type >::EasingAB ( )
default

◆ EasingAB() [2/3]

template<class Type >
SIV3D_NODISCARD_CXX20 s3d::EasingAB< Type >::EasingAB ( const value_type a,
const value_type b,
double   easingFunctiondouble,
double  durationMillisec,
ISteadyClock pSteadyClock = nullptr 
)

◆ EasingAB() [3/3]

template<class Type >
SIV3D_NODISCARD_CXX20 s3d::EasingAB< Type >::EasingAB ( const value_type a,
const value_type b,
double   easingFunctiondouble,
const Duration duration = SecondsF{ 1.0 },
ISteadyClock pSteadyClock = nullptr 
)

Member Function Documentation

◆ base()

template<class Type >
const Type& s3d::EasingAB< Type >::base ( ) const
noexcept

◆ done()

template<class Type >
bool s3d::EasingAB< Type >::done ( ) const

◆ easeIn()

template<class Type >
auto s3d::EasingAB< Type >::easeIn ( ) const

◆ easeInOut()

template<class Type >
auto s3d::EasingAB< Type >::easeInOut ( ) const

◆ easeOut()

template<class Type >
auto s3d::EasingAB< Type >::easeOut ( ) const

◆ getA()

template<class Type >
const value_type& s3d::EasingAB< Type >::getA ( ) const
noexcept

◆ getB()

template<class Type >
const value_type& s3d::EasingAB< Type >::getB ( ) const
noexcept

◆ isMoving()

template<class Type >
bool s3d::EasingAB< Type >::isMoving ( ) const

◆ jumpToA()

template<class Type >
void s3d::EasingAB< Type >::jumpToA ( )

◆ jumpToB()

template<class Type >
void s3d::EasingAB< Type >::jumpToB ( )

◆ onA()

template<class Type >
bool s3d::EasingAB< Type >::onA ( ) const

◆ onB()

template<class Type >
bool s3d::EasingAB< Type >::onB ( ) const

◆ pause()

template<class Type >
void s3d::EasingAB< Type >::pause ( )

◆ progress0_1()

template<class Type >
double s3d::EasingAB< Type >::progress0_1 ( ) const

◆ reset()

template<class Type >
void s3d::EasingAB< Type >::reset ( )

◆ resume()

template<class Type >
void s3d::EasingAB< Type >::resume ( )

◆ setA()

template<class Type >
void s3d::EasingAB< Type >::setA ( const value_type value)

◆ setB()

template<class Type >
void s3d::EasingAB< Type >::setB ( const value_type value)

◆ start()

template<class Type >
void s3d::EasingAB< Type >::start ( )

◆ value()

template<class Type >
auto s3d::EasingAB< Type >::value ( ) const

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