1. Epic GamesDeveloper
  3. FMovieSceneInstancePreAnimatedState

FMovieSceneInstancePreAnimatedState

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

API > API/Runtime > API/Runtime/MovieScene

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

   
Name FMovieSceneInstancePreAnimatedState
Type class
Header File /Engine/Source/Runtime/MovieScene/Public/Evaluation/MovieScenePreAnimatedState.h
Include Path #include "Evaluation/MovieScenePreAnimatedState.h"

Syntax

class FMovieSceneInstancePreAnimatedState

Constructors

Name Remarks Include Path Unreal Specifiers
  Evaluation/MovieScenePreAnimatedState.h  
  Evaluation/MovieScenePreAnimatedState.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FMovieSceneInstancePreAnimatedState()

   Evaluation/MovieScenePreAnimatedState.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bCapturingGlobalPreAnimatedState bool Whether global pre-animated state capture has been requested on the linker extension Evaluation/MovieScenePreAnimatedState.h  
InstanceHandle UE::MovieScene::FRootInstanceHandle The instance handle for the root sequence instance Evaluation/MovieScenePreAnimatedState.h  
WeakLinker TWeakObjectPtr< UMovieSceneEntitySystemLinker > Weak pointer to the linker that we're associated with Evaluation/MovieScenePreAnimatedState.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool ContainsAnyStateForSequence()

 Search the global pre-animated state extension for any captured state that originated from this sequence WARNING: This is a linear search across all state, and so is potentially very slow Evaluation/MovieScenePreAnimatedState.h  
Discard any tokens that relate to the requested object (ie sections or tracks) without restoring the values. Evaluation/MovieScenePreAnimatedState.h  
Discard any tokens that relate to entity animation (ie sections or tracks) without restoring the values. Evaluation/MovieScenePreAnimatedState.h  

void DiscardPreAnimatedState()

 Discards all pre-animated state without restoring it. Evaluation/MovieScenePreAnimatedState.h  

void EnableGlobalPreAnimatedStateCapture()

 Check whether this sequence instance is capturing any and all changes of state so they can be restored later Evaluation/MovieScenePreAnimatedState.h  
Retrieve the linker this container is bound to Evaluation/MovieScenePreAnimatedState.h  

bool IsCapturingGlobalPreAnimatedState()

 Check whether this sequence instance is capturing any and all changes of state so they can be restored later Evaluation/MovieScenePreAnimatedState.h  
  Evaluation/MovieScenePreAnimatedState.h  

void RestorePreAnimatedState ( UObject& Object
)

   Evaluation/MovieScenePreAnimatedState.h  

void RestorePreAnimatedState ( UClass* GeneratedClass
)

   Evaluation/MovieScenePreAnimatedState.h  
  Evaluation/MovieScenePreAnimatedState.h  
Save the current state of the environment as defined by the specified token producer, identified by a specific anim type ID This will use the currently evaluating track template, evaluation hook or track instance (and its 'When Finished' property) as the capture source Evaluation/MovieScenePreAnimatedState.h  
Save the current state of an object as defined by the specified token producer, identified by a specific anim type ID This will use the currently evaluating track template, evaluation hook or track instance (and its 'When Finished' property) as the capture source Evaluation/MovieScenePreAnimatedState.h  

Operators

Name Remarks Include Path Unreal Specifiers
  Evaluation/MovieScenePreAnimatedState.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page