Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Curves > TKeyFrameManipulator

Light Theme

Dark Theme

TKeyFrameManipulator

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

Windows

MacOS

Linux

Inheritance Hierarchy

IKeyFrameManipulator

TKeyFrameManipulator

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

	Name	Description
	TKeyFrameManipulator ( const TKeyFrameManipulator& Rhs )
	TKeyFrameManipulator ( TKeyFrameManipulator&& Rhs )
	TKeyFrameManipulator ( TArray< TimeType >* KeyTimesPa..., FKeyHandleLookupTable* Externa... )	Construction from an externally owned array of times

Destructors

	Name	Description
	~TKeyFrameManipulator()

Functions

	Name	Description
FKeyHandle	AddKey ( TimeTypeRef InTime )	Add a new key time to the data structure
int32	ComputeInsertIndex ( TimeTypeRef InTime, int32 StartAtIndex )	Calculate the index at which to insert the given time such that the container remains sorted
TOptional< F...	FindKey ( const TFunctionRef< bool... )	Attempt to find a key using a custom predicate
int32	GetIndex ( FKeyHandle KeyHandle )	Get the index that corresponds to the specified key handle
FKeyHandle	GetKeyHandleFromIndex ( int32 Index )	Get the handle that corresponds to the specified index
TOptional< T...	GetKeyTime ( FKeyHandle KeyHandle )	Get the time that corresponds to the specified key handle
TimeType	GetKeyTimeChecked ( int32 KeyIndex )	Get the time of the specified key index. Index is assumed to be valid.
FKeyHandle	InsertKeyImpl ( TimeTypeRef Time, int32 InsertIndex )	Insert the specified time into our container at the specified index
TKeyTimeIter...	IterateKeys()	Iterate the times stored in the external data structure
void	RelocateKeyImpl ( int32 OldIndex, int32 NewIndex )	Move a key from one index to another
void	RemoveKey ( FKeyHandle KeyHandle )	Remove a key that corresponds to the specified key handle
void	Reset()	Removes all keys.
void	SetKeyTime ( FKeyHandle KeyHandle, TimeTypeRef NewTime )	Set the time for a key that corresponds to the specified key handle

Operators

		Name	Description
	TKeyFrameMan...	operator= ( const TKeyFrameManipulator& Rhs )
	TKeyFrameMan...	operator= ( TKeyFrameManipulator&& Rhs )

Typedefs

Name	Description
TimeTypeRef	Pass by value/ref parameter type.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss