TMovieSceneTimeArray

A utility class that lets you store a collection of timestamped data originating from various time bases.

Windows
MacOS
Linux

References

Module

MovieScene

Header

/Engine/Source/Runtime/MovieScene/Public/Evaluation/MovieSceneTimeArray.h

Include

#include "Evaluation/MovieSceneTimeArray.h"

Syntax

template<typename DataType>
struct TMovieSceneTimeArray

Remarks

A utility class that lets you store a collection of timestamped data originating from various time bases.

All of the data is stored in "root" time space. That is: as you add timestamped data, these timestamps are converted back to "root times" using the inverse of the current time transform. Pushing and popping time transforms, and incrementing loop counts, makes it possible to change what's considered "local time", which affects this inverse transformation.

Functions

Name Description

Public function

void

 

Add

(
    FFrameNumber LocalTime,
    const DataType& Datum
)

Adds a new piece of data, timestamped to the given local time

Public function

void

 

Clear()

Clears all entries

Public function Const

TArrayView< ...

 

GetEntries()

Gets the current list of entries in the array

Public function

void

 

IncrementWarpCounter()

Incremenets the warp counter for the local time space, i.e. all local times will be considered as being in a further loop

Public function

void

 

PopTransform()

Removes the last pushed local time transform

Public function

void

 

PushTransform

(
    const FMovieSceneTimeTransform& In...
)

Starts a scope where local times are transformed as specified

Public function

void

 

PushTransform

(
    const FMovieSceneTimeWarping& InWa...
)

Starts a scope where local times are transformed as specified

Public function

void

 

PushTransform

(
    FFrameNumber FrameOffset,
    float TimeScale
)

Starts a scope where local times are offset and scaled as specified

Public function

void

 

PushTransform

(
    const FMovieSceneTimeTransform& In...,
    const FMovieSceneTimeWarping& InWa...
)

Starts a scope where local times are transformed as specified

Public function

void

 

PushTransform

(
    FFrameNumber FirstLoopStartFrameOff...,
    FFrameNumber LoopStart,
    FFrameNumber LoopEnd,
    float TimeScale
)

Starts a scope where local times are looped and offset as specified

Typedefs

Name

Description

FEntry

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