TMovieSceneSavedTokens

Saved state for animation bound to a particular animated object

Windows
MacOS
Linux

References

Module

MovieScene

Header

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

Include

#include "Evaluation/MovieScenePreAnimatedState.h"

Syntax

template<typename TokenType>
struct TMovieSceneSavedTokens

Remarks

Saved state for animation bound to a particular animated object

Constructors

Name Description

Public function

TMovieSceneSavedTokens

(
    PayloadType&& InPayload
)

Public function

TMovieSceneSavedTokens

Public function

TMovieSceneSavedTokens

(
    const TMovieSceneSavedTokens&
)

Non-copyable.

Functions

Name Description

Public function

void

 

CopyFrom

(
    TMovieSceneSavedTokens& Other
)

Public function

void

 

DiscardEntityTokens()

Discard any tokens that relate to entity animation (ie sections or tracks) without restoring the values.

Public function

void

 

OnPreAnimated

(
    ECapturePreAnimatedState InCaptureM...,
    FMovieSceneAnimTypeID InAnimTypeID,
    FMovieSceneEvaluationKey InAssociat...,
    const ProducerType& InProducer,
    FMovieScenePreAnimatedState& InPar...
)

Called when animation is about to happen to cache of any existing state

Public function

void

 

Reset()

Reset all containers without applying or restoring any tokens

Public function

void

 

Restore

(
    IMovieScenePlayer& Player
)

Forcefully restore all pre animated state tokens held by this container

Public function

void

 

Restore

(
    IMovieScenePlayer& Player,
    TFunctionRef< bool...
)

Restore all pre animated state tokens held by this container that pass the specified filter predicate

Public function

bool

 

RestoreEntity

(
    IMovieScenePlayer& Player,
    FMovieSceneEvaluationKey EntityKey,
    TOptional< TFunctionRef< bool...
)

Restore any pre animated state for the specified entity key, based on an optional filter

Operators

Name Description

Public function

TMovieSceneS...

 

operator=

Public function

TMovieSceneS...

 

operator=

(
    const TMovieSceneSavedTokens&
)

Typedefs

Name

Description

PayloadType

ProducerType

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