1. Epic GamesDeveloper
  3. FMovieSceneChannelData

FMovieSceneChannelData

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

API > API/Runtime > API/Runtime/MovieScene

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

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

Syntax

struct FMovieSceneChannelData

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers
Constructor that takes a non-owning pointer to an array of times and a key handle map Channels/MovieSceneChannelData.h  
  Channels/MovieSceneChannelData.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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 Channels/MovieSceneChannelData.h  

int32 FindKey ( FFrameNumber InTime,
FFrameNumber InTolerance
)

 Attempt to find a key at a given time and tolerance Channels/MovieSceneChannelData.h  

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 Channels/MovieSceneChannelData.h  

FKeyHandle GetHandle ( int32 Index
)

 Retrieve a key handle for the specified key time index Channels/MovieSceneChannelData.h  

int32 GetIndex ( FKeyHandle Handle
)

 Attempt to retrieve the index of key from its handle Channels/MovieSceneChannelData.h  

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

 Get all the keys in the given range. Channels/MovieSceneChannelData.h  

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

 Get key times for a number of keys in the channel data Channels/MovieSceneChannelData.h  
Read-only access to this channel's key times. Channels/MovieSceneChannelData.h  
Mutable access to this channel's key times. Channels/MovieSceneChannelData.h  

TRange< FFrameNumber > GetTotalRange()

 Compute the total time range of the channel data. Channels/MovieSceneChannelData.h  

void Offset ( FFrameNumber DeltaTime
)

 Offset the channel data by a given delta time Channels/MovieSceneChannelData.h  

Protected

Name Remarks Include Path Unreal Specifiers

int32 AddKeyInternal ( FFrameNumber InTime
)

 Add a new key at the specified time Channels/MovieSceneChannelData.h  

int32 MoveKeyInternal ( int32 KeyIndex,
FFrameNumber InNewTime
)

 Move the key at index KeyIndex to a new time Channels/MovieSceneChannelData.h  

void ReplaceKeyHandlesInternal ( TConstArrayView< int32 > KeyIndices,
TConstArrayView< FKeyHandle > NewHandles
)

 Replaces the key handle at the given Index with NewHandle. Fails if the handle is already in use. Channels/MovieSceneChannelData.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page