1. Epic GamesDeveloper
  3. TMovieSceneChannelData

TMovieSceneChannelData

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

Unreal Engine C++ API Reference > Runtime > MovieScene > Channels

Inheritance Hierarchy

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

TMovieSceneChannelData< const ValueType >

Constructors

  Type Name Description
Public function  

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
Public function  

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

Functions

  Type 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 > InHandles
)

 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 > InHandles,
TArrayView< FKeyHandle > OutNewHandles
)

 Duplicate a number of keys within this channel data
Public function Const TArrayView< const ValueType > Read-only access to this channel's values
Public function TArrayView< ValueType > 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 > InHandles,
TArrayView< const FFrameNumber > InKeyTimes
)

 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

  Type Name Description
Public function   Conversion to a constant version of this class

Typedefs

Name Description
ParamType  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page