Navigation
API > API/Runtime > API/Runtime/Engine
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.
| Name | TKeyFrameManipulator |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/Curves/KeyFrameManipulator.h |
| Include Path | #include "Curves/KeyFrameManipulator.h" |
Syntax
template<typename TimeType>
class TKeyFrameManipulator : private IKeyFrameManipulator< TimeType >
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TKeyFrameManipulator
(
const TKeyFrameManipulator& Rhs |
Curves/KeyFrameManipulator.h | ||
TKeyFrameManipulator
(
TKeyFrameManipulator&& Rhs |
Curves/KeyFrameManipulator.h | ||
TKeyFrameManipulator
(
TArray< TimeType >* KeyTimesParam, |
Construction from an externally owned array of times | Curves/KeyFrameManipulator.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~TKeyFrameManipulator() |
Curves/KeyFrameManipulator.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| TimeTypeRef | TCallTraits< TimeType >::ParamType | Pass by value/ref parameter type. | Curves/KeyFrameManipulator.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| KeyHandleLUT | FKeyHandleLookupTable * | Lookup table for key handles. | Curves/KeyFrameManipulator.h | |
| KeyTimes | TArray< TimeType > * | Ptr to array of key times | Curves/KeyFrameManipulator.h | |
| TemporaryKeyHandleLUT | FKeyHandleLookupTable | Lookup table for key handles used when the user did not supply one. | Curves/KeyFrameManipulator.h | |
| TKeyTimeIterator< TimeType > | friend | Curves/KeyFrameManipulator.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FKeyHandle AddKey
(
TimeTypeRef InTime |
Add a new key time to the data structure | Curves/KeyFrameManipulator.h | |
TOptional< FKeyHandle > FindKey
(
const TFunctionRef< bool(TimeTypeRef)>& InPredicate |
Attempt to find a key using a custom predicate | Curves/KeyFrameManipulator.h | |
TOptional< TimeType > GetKeyTime
(
FKeyHandle KeyHandle |
Get the time that corresponds to the specified key handle | Curves/KeyFrameManipulator.h | |
TKeyTimeIterator< TimeType > IterateKeys() |
Iterate the times stored in the external data structure | Curves/KeyFrameManipulator.h | |
void RemoveKey
(
FKeyHandle KeyHandle |
Remove a key that corresponds to the specified key handle | Curves/KeyFrameManipulator.h | |
void Reset() |
Removes all keys. | Curves/KeyFrameManipulator.h | |
void SetKeyTime
(
FKeyHandle KeyHandle, |
Set the time for a key that corresponds to the specified key handle | Curves/KeyFrameManipulator.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 ComputeInsertIndex
(
TimeTypeRef InTime, |
Calculate the index at which to insert the given time such that the container remains sorted | Curves/KeyFrameManipulator.h | |
int32 GetIndex
(
FKeyHandle KeyHandle |
Get the index that corresponds to the specified key handle | Curves/KeyFrameManipulator.h | |
FKeyHandle GetKeyHandleFromIndex
(
int32 Index |
Get the handle that corresponds to the specified index | Curves/KeyFrameManipulator.h | |
TimeType GetKeyTimeChecked
(
int32 KeyIndex |
Get the time of the specified key index. Index is assumed to be valid. | Curves/KeyFrameManipulator.h | |
FKeyHandle InsertKeyImpl
(
TimeTypeRef Time, |
Insert the specified time into our container at the specified index | Curves/KeyFrameManipulator.h | |
void RelocateKeyImpl
(
int32 OldIndex, |
Move a key from one index to another | Curves/KeyFrameManipulator.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TKeyFrameManipulator & operator=
(
const TKeyFrameManipulator& Rhs |
Curves/KeyFrameManipulator.h | ||
TKeyFrameManipulator & operator=
(
TKeyFrameManipulator&& Rhs |
Curves/KeyFrameManipulator.h |