FMovieScenePreAnimatedState

Class that caches pre-animated state for objects that were manipulated by sequencer

Windows
MacOS
Linux

References

Module

MovieScene

Header

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

Include

#include "Evaluation/MovieScenePreAnimatedState.h"

Syntax

class FMovieScenePreAnimatedState

Remarks

Class that caches pre-animated state for objects that were manipulated by sequencer

Constructors

Name Description

Public function

FMovieScenePreAnimatedState()

Default construction

Public function

FMovieScenePreAnimatedState

(
    const FMovieScenePreAnimatedState&
)

Functions

Name Description

Public function

void

 

DisableGlobalCapture()

Disable this cache, preventing it from caching state

Public function

void

 

DiscardAndRemoveEntityTokensForObject

(
    UObject& Object
)

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

Public function

void

 

DiscardEntityTokens()

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

Public function

void

 

EnableGlobalCapture()

Enable this cache and allow it to start caching state

Public function

void

 

EntityHasAnimatedMaster

(
    FMovieSceneEvaluationKey EntityKey
)

Public function

void

 

EntityHasAnimatedObject

(
    FMovieSceneEvaluationKey EntityKey,
    FObjectKey ObjectKey
)

Public function Const

bool

 

IsGlobalCaptureEnabled()

Check whether we're currently caching pre-animated state at a global level

Public function

void

 

OnObjectsReplaced

(
    const TMap< UObject*, UObject ...
)

Called when objects have been replaced so that pre animated state can swap out to the new objects

Public function

void

 

RestorePreAnimatedState

(
    IMovieScenePlayer& Player
)

Public function

void

 

RestorePreAnimatedState

(
    IMovieScenePlayer& Player,
    const FMovieSceneEvaluationKey& Ke...
)

Public function

void

 

RestorePreAnimatedState

(
    IMovieScenePlayer& Player,
    UObject& Object
)

Public function

void

 

RestorePreAnimatedState

(
    IMovieScenePlayer& Player,
    UClass* GeneratedClass
)

Public function

void

 

RestorePreAnimatedState

(
    IMovieScenePlayer& Player,
    const FMovieSceneEvaluationKey& Ke...,
    TFunctionRef< bool...
)

Public function

void

 

RestorePreAnimatedState

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

Protected function

void

 

RestorePreAnimatedStateImpl

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

Public function

void

 

SavePreAnimatedState

(
    FMovieSceneAnimTypeID InTokenType,
    const IMovieScenePreAnimatedGlobalT...,
    ECapturePreAnimatedState CaptureSta...,
    FMovieSceneEvaluationKey CaptureEnt...
)

Public function

void

 

SavePreAnimatedState

(
    FMovieSceneAnimTypeID InTokenType,
    const IMovieScenePreAnimatedGlobalT...
)

Public function

void

 

SavePreAnimatedState

(
    FMovieSceneAnimTypeID InTokenType,
    const IMovieScenePreAnimatedTokenPr...,
    UObject& InObject
)

Public function

void

 

SavePreAnimatedState

(
    FMovieSceneAnimTypeID InTokenType,
    const IMovieScenePreAnimatedTokenPr...,
    UObject& InObject,
    ECapturePreAnimatedState CaptureSta...,
    FMovieSceneEvaluationKey CaptureEnt...
)

Public function

void

 

SetCaptureEntity

(
    FMovieSceneEvaluationKey InEntity,
    EMovieSceneCompletionMode InComplet...
)

Operators

Name Description

Public function

FMovieSceneP...

 

operator=

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