Murl::Logic::AnimationKey< DataType > Class Template Reference

A template class to create key objects for the Animation class. More...

#include "murl_logic_animation.h"

Public Types

typedef DataType ValueType
 The template parameter value type. More...
 

Public Member Functions

 AnimationKey ()
 The default constructor.
 
 AnimationKey (Real time, const DataType &value)
 The constructor including time and value. More...
 
 AnimationKey (Real time, const DataType &value, Bool linear)
 The constructor including time, value and linear flag. More...
 
 AnimationKey (Real time, const DataType &value, IEnums::Interpolation interpolation)
 The constructor including time, value and interpolation. More...
 
Bool IsEqual (const AnimationKey &other) const
 Compare the animation key to another one. More...
 
bool operator== (const AnimationKey &rhs) const
 The "equal to" comparison operator, calls IsEqual(). More...
 
bool operator!= (const AnimationKey &rhs) const
 The "not equal to" comparison operator, calls IsEqual(). More...
 

Public Attributes

Real mTime
 The time of the key. More...
 
DataType mValue
 The value of the key. More...
 
IEnums::Interpolation mInterpolation
 The interpolation type of the key. More...
 

Detailed Description

template<class DataType>
class Murl::Logic::AnimationKey< DataType >

A template class to create key objects for the Animation class.

Member Typedef Documentation

◆ ValueType

template<class DataType >
typedef DataType Murl::Logic::AnimationKey< DataType >::ValueType

The template parameter value type.

Constructor & Destructor Documentation

◆ AnimationKey() [1/3]

template<class DataType >
Murl::Logic::AnimationKey< DataType >::AnimationKey ( Real  time,
const DataType &  value 
)
inline

The constructor including time and value.

Parameters
timeThe time for the key in seconds.
valueThe value for the key.

◆ AnimationKey() [2/3]

template<class DataType >
Murl::Logic::AnimationKey< DataType >::AnimationKey ( Real  time,
const DataType &  value,
Bool  linear 
)
inline

The constructor including time, value and linear flag.

Parameters
timeThe time for the key in seconds.
valueThe value for the key.
lineartrue for linear interpolation, false for constant interpolation.

◆ AnimationKey() [3/3]

template<class DataType >
Murl::Logic::AnimationKey< DataType >::AnimationKey ( Real  time,
const DataType &  value,
IEnums::Interpolation  interpolation 
)
inline

The constructor including time, value and interpolation.

Parameters
timeThe time for the key in seconds.
valueThe value for the key.
interpolationThe interpolation type.

Member Function Documentation

◆ IsEqual()

template<class DataType >
Bool Murl::Logic::AnimationKey< DataType >::IsEqual ( const AnimationKey< DataType > &  other) const
inline

◆ operator==()

template<class DataType >
bool Murl::Logic::AnimationKey< DataType >::operator== ( const AnimationKey< DataType > &  rhs) const
inline

The "equal to" comparison operator, calls IsEqual().

Parameters
rhsThe right hand side key to compare.
Returns
true if both keys are identical.

References Murl::Logic::AnimationKey< DataType >::IsEqual().

◆ operator!=()

template<class DataType >
bool Murl::Logic::AnimationKey< DataType >::operator!= ( const AnimationKey< DataType > &  rhs) const
inline

The "not equal to" comparison operator, calls IsEqual().

Parameters
rhsThe right hand side key to compare.
Returns
true if both keys are not identical.

References Murl::Logic::AnimationKey< DataType >::IsEqual().

Member Data Documentation

◆ mTime

◆ mValue

template<class DataType >
DataType Murl::Logic::AnimationKey< DataType >::mValue

◆ mInterpolation

template<class DataType >
IEnums::Interpolation Murl::Logic::AnimationKey< DataType >::mInterpolation

The documentation for this class was generated from the following file:
  • murl_logic_animation.h


Copyright © 2011-2018 Spraylight GmbH.