IKeyFrameManipulator< TimeType > Class Template Reference

#include <IKeyFrameManipulator.h>

Public Types
typedef TCallTraits< TimeType >::ParamType	TimeTypeRef

Public Member Functions
FKeyHandle	AddKey (TimeTypeRef InTime)
void	SetKeyTime (FKeyHandle KeyHandle, TimeTypeRef NewTime)
void	RemoveKey (FKeyHandle KeyHandle)
TOptional< TimeType >	GetKeyTime (FKeyHandle KeyHandle) const
TOptional< FKeyHandle >	FindKey (TimeTypeRef KeyTime, TimeTypeRef KeyTimeTolerance) const

Detailed Description

template<typename TimeType = float>
class IKeyFrameManipulator< TimeType >

Templated key frame manipulator that knows how to add, remove and (re)arrange key times. Should guarantee that any manipulation of a previously sorted time array, will remain sorted.

Member Typedef Documentation

TimeTypeRef

template<typename TimeType = float>

typedef TCallTraits<TimeType>::ParamType IKeyFrameManipulator< TimeType >::TimeTypeRef

Member Function Documentation

AddKey()

template<typename TimeType = float>

FKeyHandle IKeyFrameManipulator< TimeType >::AddKey ( TimeTypeRef  InTime )

inline

Add a new key time to the data structure

Parameters

InTime

The value of the time to add

Returns

A key handle for the new key

FindKey()

template<typename TimeType = float>

TOptional< FKeyHandle > IKeyFrameManipulator< TimeType >::FindKey ( TimeTypeRef  KeyTime, TimeTypeRef  KeyTimeTolerance  ) const

inline

Attempt to find a key using a custom predicate

Parameters

InPredicate

Predicate function to use when searching

Returns

The key's handle if found, or an empty container if not

GetKeyTime()

template<typename TimeType = float>

TOptional< TimeType > IKeyFrameManipulator< TimeType >::GetKeyTime ( FKeyHandle  KeyHandle ) const

inline

Get the time that corresponds to the specified key handle

Parameters

KeyHandle

Handle to the key to get the time for.

Returns

The time that this key exists at, or an empty container if it was not found

RemoveKey()

template<typename TimeType = float>

void IKeyFrameManipulator< TimeType >::RemoveKey ( FKeyHandle  KeyHandle )

inline

Remove a key that corresponds to the specified key handle

Parameters

KeyHandle

Handle to the key to remove

SetKeyTime()

template<typename TimeType = float>

void IKeyFrameManipulator< TimeType >::SetKeyTime ( FKeyHandle  KeyHandle, TimeTypeRef  NewTime  )

inline

Set the time for a key that corresponds to the specified key handle

Parameters

KeyHandle	Handle to the key to set the time for
NewTime	The time to assign to this key

---

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

• Engine/Source/Runtime/Engine/Public/Curves/IKeyFrameManipulator.h