iaux::iaKeyFrameGraph< T > Class Template Reference

#include <iaKeyFrameGraph.h>

Public Member Functions

void setValue (float64 at, const T &value)
 
getValue (float64 at) const
 
uint32 getValueCount () const
 
void setValueAtIndex (int32 index, float64 at, const T &value)
 
void getValueAtIndex (int32 index, float64 &at, T &value)
 
void removeIndex (int32 index)
 
void clear ()
 
const std::vector< std::pair< float64, T > > & getValues () const
 
bool isEmpty () const
 
void setInterpolationMode (iInterpolationMode mode)
 
iInterpolationMode getInterpolationMode () const
 
 iaKeyFrameGraph ()=default
 
 ~iaKeyFrameGraph ()=default
 

Detailed Description

template<typename T>
class iaux::iaKeyFrameGraph< T >

gradient of values

Constructor & Destructor Documentation

◆ iaKeyFrameGraph()

template<typename T >
iaux::iaKeyFrameGraph< T >::iaKeyFrameGraph ( )
default

does nothing

◆ ~iaKeyFrameGraph()

template<typename T >
iaux::iaKeyFrameGraph< T >::~iaKeyFrameGraph ( )
default

does nothing

Member Function Documentation

◆ clear()

template<typename T >
void iaKeyFrameGraph::clear ( )

clears gradient entries

◆ getInterpolationMode()

template<typename T >
iInterpolationMode iaKeyFrameGraph::getInterpolationMode ( ) const
Returns
interpolation mode

◆ getValue()

template<typename T >
T iaKeyFrameGraph::getValue ( float64  at) const
Returns
value at given position
Parameters
atthe given position

◆ getValueAtIndex()

template<typename T >
void iaKeyFrameGraph::getValueAtIndex ( int32  index,
float64 at,
T &  value 
)

returns location and value from specified index

Parameters
indexindex to retrieve data from
[out]atlocation at index
[out]valuevalue at index

◆ getValueCount()

template<typename T >
uint32 iaKeyFrameGraph::getValueCount ( ) const
Returns
count of values in gradient

◆ getValues()

template<typename T >
const std::vector< std::pair< float64, T > > & iaKeyFrameGraph::getValues ( ) const
Returns
reference to values

◆ isEmpty()

template<typename T >
bool iaKeyFrameGraph::isEmpty ( ) const
Returns
true if color gradient is empty

◆ removeIndex()

template<typename T >
void iaKeyFrameGraph::removeIndex ( int32  index)

removes specified index

Parameters
indexthe index to remove

◆ setInterpolationMode()

template<typename T >
void iaKeyFrameGraph::setInterpolationMode ( iInterpolationMode  mode)

sets interpolation mode

Parameters
modethe interpolation mode

◆ setValue()

template<typename T >
void iaKeyFrameGraph::setValue ( float64  at,
const T &  value 
)

sets or if not present inserts a value at given position

Parameters
atthe given position
valuethe value

◆ setValueAtIndex()

template<typename T >
void iaKeyFrameGraph::setValueAtIndex ( int32  index,
float64  at,
const T &  value 
)

sets value at specified index

Parameters
indexindex to modify
atthe at value
valuethe new value

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