TMovieSceneChannelData | Unreal Engine 5.7 Documentation

API > API/Runtime > API/Runtime/MovieScene

Templated channel data utility class that provides a consistent interface for interacting with a channel's keys and values. Assumes that the supplied time and value arrays are already sorted ascendingly by time and are the same size. This class will maintain those invariants throughout its lifetime.


Name	TMovieSceneChannelData
Type	struct
Header File	/Engine/Source/Runtime/MovieScene/Public/Channels/MovieSceneChannelData.h
Include Path	#include "Channels/MovieSceneChannelData.h"

Syntax

template<typename ValueType>  
struct TMovieSceneChannelData : public FMovieSceneChannelData

Inheritance Hierarchy

FMovieSceneChannelData → TMovieSceneChannelData
TMovieSceneChannelData

Constructors

Name	Remarks	Include Path	Unreal Specifiers
TMovieSceneChannelData ( TArray< FFrameNumber >* InTimes, TArray< ValueType >* InValues, FKeyHandleLookupTable* InKeyHandles, FMovieSceneChannel* InChannel )	Constructor that takes a non-owning pointer to an array of times and values, and a key handle map	Channels/MovieSceneChannelData.h
TMovieSceneChannelData ( TArray< FFrameNumber >* InTimes, TArray< ValueType >* InValues, FMovieSceneChannel* InChannel, FKeyHandleLookupTable* InKeyHandles )	Constructor that takes a non-owning pointer to an array of times and values, and a key handle map	Channels/MovieSceneChannelData.h

Struct Specializations

Name	Remarks
TMovieSceneChannelData< const ValueType >	Specialization of TMovieSceneChannelData for const value types (limited read-only access to data)

Typedefs

Name	Type	Remarks	Include Path
ParamType	TCallTraits< ValueType >::ParamType		Channels/MovieSceneChannelData.h

Variables

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
Values	TArray< ValueType > *	Pointer to an external array of values, to be kept in sync with FMovieSceneChannelData::Times	Channels/MovieSceneChannelData.h

Functions

Public

Name	Remarks	Include Path
int32 AddKey ( FFrameNumber InTime, ParamType InValue )	Add a new key at a given time	Channels/MovieSceneChannelData.h
void DeleteKeys ( TArrayView< const FKeyHandle > InHandles )	Delete a number of keys from this channel data	Channels/MovieSceneChannelData.h
void DeleteKeysFrom ( FFrameNumber InTime, bool bDeleteKeysBefore )	Delete keys before or after a specified time	Channels/MovieSceneChannelData.h
void DuplicateKeys ( TArrayView< const FKeyHandle > InHandles, TArrayView< FKeyHandle > OutNewHandles )	Duplicate a number of keys within this channel data	Channels/MovieSceneChannelData.h
TArrayView< ValueType > GetValues ()	Mutable access to this channel's values	Channels/MovieSceneChannelData.h
TArrayView< const ValueType > GetValues ()	Read-only access to this channel's values	Channels/MovieSceneChannelData.h
int32 MoveKey ( int32 KeyIndex, FFrameNumber NewTime, bool bRemoveDuplicateKeys, TCanRemove&& CanRemove )		Channels/MovieSceneChannelData.h
int32 MoveKey ( int32 KeyIndex, FFrameNumber NewTime, bool bRemoveDuplicateKeys )	Move the key at index KeyIndex to a new time	Channels/MovieSceneChannelData.h
void RemapTimes ( const UE::MovieScene::IRetimingInterface& Retimer )	Remap the times of all the keys in this channel using an abstract retimer	Channels/MovieSceneChannelData.h
void RemoveKey ( int32 KeyIndex )	Remove the key at a given index	Channels/MovieSceneChannelData.h
void ReplaceKeyHandle ( int32 KeyIndex, FKeyHandle NewHandle )	Replaces the key handle at the given Index with NewHandle. Fails if the handle is already in use.	Channels/MovieSceneChannelData.h
void ReplaceKeyHandles ( TConstArrayView< int32 > KeyIndices, TConstArrayView< FKeyHandle > NewHandles )	Replaces the key handles at the given KeyIndices with NewHandles.	Channels/MovieSceneChannelData.h
void Reset()	Remove all the keys from this channel	Channels/MovieSceneChannelData.h
int32 SetKeyTime ( int32 KeyIndex, FFrameNumber InNewTime )	Move the key at index KeyIndex to a new time	Channels/MovieSceneChannelData.h
void SetKeyTimes ( TArrayView< const FKeyHandle > InHandles, TArrayView< const FFrameNumber > InKeyTimes )	Set key times for a number of keys in this channel data	Channels/MovieSceneChannelData.h
FKeyHandle UpdateOrAddKey ( FFrameNumber InTime, ParamType InValue )	Set the value of the key at InTime to InValue, adding a new key if necessary	Channels/MovieSceneChannelData.h
void UpdateOrAddKeys ( const TArrayView< const FFrameNumber > InTimes, const TArrayView< ValueType > InValues )	Updates keys with these times in the channel.	Channels/MovieSceneChannelData.h

Navigation