1. Epic GamesDeveloper
  3. FMovieSceneChannelData

FMovieSceneChannelData

Base class channel data utility that provides a consistent interface to a sorted array of times and handles.

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

struct FMovieSceneChannelData

Remarks

Base class channel data utility that provides a consistent interface to a sorted array of times and handles. Complete access should be through TMovieSceneChannelData that allows mutation of the data

Variables

  Type Name Description
Protected variable FKeyHandleLookupTable * KeyHandles Pointer to an external key handle map
Protected variable FMovieSceneChannel * OwningChannel Optional Pointer to the owning FMovieSceneChannel, should be set if the add,move, and delete callbacks are needed
Protected variable TArray< FFrameNumber > * Times Pointer to an external array of sorted times.

Constructors

  Type Name Description
Protected function   Constructor that takes a non-owning pointer to an array of times and a key handle map

Functions

  Type Name Description
Protected function int32 Add a new key at the specified time
Public function void

ChangeFrameResolution ( FFrameRate SourceRate,
FFrameRate DestinationRate
)

 Convert the frame resolution of a movie scene channel by moving the key times to the equivalent frame time
Public function int32

FindKey ( FFrameNumber InTime,
FFrameNumber InTolerance
)

 Attempt to find a key at a given time and tolerance
Public function void

FindKeys ( FFrameNumber InTime,
int32 MaxNum,
int32& OutMinIndex,
int32& OutMaxIndex,
int32 InTolerance
)

 Find the range of keys that fall around InTime +/- InTolerance up to a maximum
Public function FKeyHandle

GetHandle ( int32 Index
)

 Retrieve a key handle for the specified key time index
Public function int32

GetIndex ( FKeyHandle Handle
)

 Attempt to retrieve the index of key from its handle
Public function void

GetKeys ( const TRange< FFrameNumber >& WithinRange,
TArray< FFrameNumber >* OutKeyTimes,
TArray< FKeyHandle >* OutKeyHandles
)

 Get all the keys in the given range.
Public function void

GetKeyTimes ( TArrayView< const FKeyHandle > InHandles,
TArrayView< FFrameNumber > OutKeyTimes
)

 Get key times for a number of keys in the channel data
Public function Const TArrayView< const FFrameNumber > Read-only access to this channel's key times.
Public function TArrayView< FFrameNumber > Mutable access to this channel's key times.
Public function Const TRange< FFrameNumber > Compute the total time range of the channel data.
Protected function int32

MoveKeyInternal ( int32 KeyIndex,
FFrameNumber InNewTime
)

 Move the key at index KeyIndex to a new time
Public function void

Offset ( FFrameNumber DeltaTime
)

 Offset the channel data by a given delta time

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page