1. Epic GamesDeveloper
  3. TKeyFrameManipulator

TKeyFrameManipulator

Templated key frame manipulator that knows how to add, remove and (re)arrange key times.

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Curves

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/Curves/IKeyFrameManipulator.h
Include #include "Curves/IKeyFrameManipulator.h"

Syntax

template<typename TimeType>  
class TKeyFrameManipulator : private IKeyFrameManipulator< TimeType >

Remarks

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

Constructors

  Type Name Description
Public function    
Public function    
Public function  

TKeyFrameManipulator ( TArray< TimeType >* KeyTimesParam,
FKeyHandleLookupTable* ExternalKeyHandleLUT
)

 Construction from an externally owned array of times

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function FKeyHandle

AddKey ( TimeTypeRef InTime
)

 Add a new key time to the data structure
Protected function Const int32

ComputeInsertIndex ( TimeTypeRef InTime,
int32 StartAtIndex
)

 Calculate the index at which to insert the given time such that the container remains sorted
Public function Const TOptional< FKeyHandle >

FindKey ( const TFunctionRef< bool(TimeTypeRef)>& InPredicate
)

 Attempt to find a key using a custom predicate
Protected function Const int32

GetIndex ( FKeyHandle KeyHandle
)

 Get the index that corresponds to the specified key handle
Protected function Const FKeyHandle

GetKeyHandleFromIndex ( int32 Index
)

 Get the handle that corresponds to the specified index
Public function Const TOptional< TimeType >

GetKeyTime ( FKeyHandle KeyHandle
)

 Get the time that corresponds to the specified key handle
Protected function Const TimeType

GetKeyTimeChecked ( int32 KeyIndex
)

 Get the time of the specified key index.
Protected function Const FKeyHandle

InsertKeyImpl ( TimeTypeRef Time,
int32 InsertIndex
)

 Insert the specified time into our container at the specified index
Public function Const TKeyTimeIterator< TimeType > Iterate the times stored in the external data structure
Protected function void

RelocateKeyImpl ( int32 OldIndex,
int32 NewIndex
)

 Move a key from one index to another
Public function void

RemoveKey ( FKeyHandle KeyHandle
)

 Remove a key that corresponds to the specified key handle
Public function void

Reset ()

 Removes all keys.
Public function void

SetKeyTime ( FKeyHandle KeyHandle,
TimeTypeRef NewTime
)

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

Operators

  Type Name Description
Public function TKeyFrameManipulator &  
Public function TKeyFrameManipulator &  

Typedefs

Name Description
TimeTypeRef Pass by value/ref parameter type.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page