TMovieSceneChannelData

Templated channel data utility class that provides a consistent interface for interacting with a channel's keys and values.

Windows
MacOS
Linux

Inheritance Hierarchy

FMovieSceneChannelData

TMovieSceneChannelData

References

Module

MovieScene

Header

/Engine/Source/Runtime/MovieScene/Public/Channels/MovieSceneChannelData.h

Include

#include "Channels/MovieSceneChannelData.h"

Syntax

template<typename ValueType>
struct TMovieSceneChannelData : public FMovieSceneChannelData

Remarks

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.

Specializations

Constructors

Name Description

Public function

TMovieSceneChannelData

(
    TArray< FFrameNumber >* InTime...,
    TArray< ValueType >* InValues,
    FKeyHandleLookupTable* InKeyHa...
)

Constructor that takes a non-owning pointer to an array of times and values, and a key handle map

Functions

Name Description

Public function

int32

 

AddKey

(
    FFrameNumber InTime,
    ParamType InValue
)

Add a new key at a given time

Public function

void

 

DeleteKeys

(
    TArrayView< const FKeyHandle > InHa...
)

Delete a number of keys from this channel data

Public function

void

 

DeleteKeysFrom

(
    FFrameNumber InTime,
    bool bDeleteKeysBefore
)

Delete keys before or after a specified time

Public function

void

 

DuplicateKeys

(
    TArrayView< const FKeyHandle > InHa...,
    TArrayView< FKeyHandle > OutNewHand...
)

Duplicate a number of keys within this channel data

Public function Const

TArrayView< ...

 

GetValues()

Read-only access to this channel's values

Public function

TArrayView< ...

 

GetValues()

Mutable access to this channel's values

Public function

int32

 

MoveKey

(
    int32 KeyIndex,
    FFrameNumber NewTime
)

Move the key at index KeyIndex to a new time

Public function

void

 

RemoveKey

(
    int32 KeyIndex
)

Remove the key at a given index

Public function

void

 

Reset()

Remove all the keys from this channel

Public function

int32

 

SetKeyTime

(
    int32 KeyIndex,
    FFrameNumber InNewTime
)

Move the key at index KeyIndex to a new time

Public function

void

 

SetKeyTimes

(
    TArrayView< const FKeyHandle > InHa...,
    TArrayView< const FFrameNumber > In...
)

Set key times for a number of keys in this channel data

Public function

FKeyHandle

 

UpdateOrAddKey

(
    FFrameNumber InTime,
    ParamType InValue
)

Set the value of the key at InTime to InValue, adding a new key if necessary

Operators

Name Description

Public function

 

operator TMovieSceneChannelData< const ValueType >()

Conversion to a constant version of this class

Typedefs

Name

Description

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