Murl::Math::SplineKey< DataType > Class Template Reference

A template class to create spline key objects for the spline interpolation classes. More...

#include "murl_math_spline_base.h"

Public Types

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

Public Member Functions

 SplineKey ()
 The default constructor.
 
 SplineKey (Real time, const DataType &value)
 The constructor including time and value. More...
 
Bool IsEqual (const SplineKey &other) const
 Compare the animation key to another one. More...
 
bool operator== (const SplineKey &rhs) const
 The "equal to" comparison operator, calls IsEqual(). More...
 
bool operator!= (const SplineKey &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...
 

Detailed Description

template<class DataType>
class Murl::Math::SplineKey< DataType >

A template class to create spline key objects for the spline interpolation classes.

Member Typedef Documentation

◆ ValueType

template<class DataType >
typedef DataType Murl::Math::SplineKey< DataType >::ValueType

The template parameter value type.

Constructor & Destructor Documentation

◆ SplineKey()

template<class DataType >
Murl::Math::SplineKey< DataType >::SplineKey ( 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.

Member Function Documentation

◆ IsEqual()

template<class DataType >
Bool Murl::Math::SplineKey< DataType >::IsEqual ( const SplineKey< DataType > &  other) const
inline

Compare the animation key to another one.

Parameters
otherThe key to compare.
Returns
true if both keys are identical.

References Murl::Math::SplineKey< DataType >::mTime, and Murl::Math::SplineKey< DataType >::mValue.

Referenced by Murl::Math::SplineKey< DataType >::operator!=(), and Murl::Math::SplineKey< DataType >::operator==().

◆ operator==()

template<class DataType >
bool Murl::Math::SplineKey< DataType >::operator== ( const SplineKey< 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::Math::SplineKey< DataType >::IsEqual().

◆ operator!=()

template<class DataType >
bool Murl::Math::SplineKey< DataType >::operator!= ( const SplineKey< 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::Math::SplineKey< DataType >::IsEqual().

Member Data Documentation

◆ mTime

◆ mValue


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


Copyright © 2011-2018 Spraylight GmbH.