1. Epic GamesDeveloper
  3. FPreAnimatedStateExtension

FPreAnimatedStateExtension

Pre-animated state extension that houses all cached values for objects animated by a specific [UMovieSceneEntitySystemLinker](API\Runtime\MovieScene\EntitySystem\UMovieSceneEntitySystemLinker)- The presence of this extension denotes that pre-animated state should be stored in one form or another.

Unreal Engine C++ API Reference > Runtime > MovieScene > Evaluation > PreAnimatedState

References

   
Module MovieScene
Header /Engine/Source/Runtime/MovieScene/Public/Evaluation/PreAnimatedState/MovieScenePreAnimatedStateExtension.h
Include #include "Evaluation/PreAnimatedState/MovieScenePreAnimatedStateExtension.h"

Syntax

struct FPreAnimatedStateExtension

Remarks

Pre-animated state extension that houses all cached values for objects animated by a specific UMovieSceneEntitySystemLinker- The presence of this extension denotes that pre-animated state should be stored in one form or another. If the extension is not present, this implies that there are no IMovieScenePlayers that need global Restore State, and no tracks set to 'Restore State'. FPreAnimatedStateExtension::NumRequestsForGlobalState defines whether this extension needs to cache any and all changes or not

  • Each specific 'type' of pre-animated state is defined by a unique StorageID (TPreAnimatedStorageID), registered through RegisterStorage
  • Pre-animated state is grouped into buckets in order to preserve significant ordering constraints (for instance, each object must restore state in the reverse order it was cached)
  • Groups are managed by registered IPreAnimatedStateGroupManager instances. The main implementation is FPreAnimatedObjectGroupManager, which maintains an object to group mapping

Variables

  Type Name Description
Public variable uint32 NumRequestsForGlobalState The number of requests that have been made to capture global state - only one should exist per playing sequence

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void  
Public function void  
Public function void

AddStorage ( TPreAnimatedStorageID< StorageType > InStorageID,
TSharedPtr< StorageType > InStorage
)

 Add a specific storage type to this extension
Public function void  
Public function FPreAnimatedStorageGroupHandle Called by group managers to allocate a new group
Public function Const bool Check whether any previously cached entries may have become invalid due to a recent call to RestoreGlobalState If this function returns true, clients should consider re-saving pre-animated state even if it already did so
Public function Const bool Search for any captured state that originated from the specified root instance handle WARNING: This is a linear search across all state, and so is potentially very slow
Public function void Discard any and all cached values for the specified group without restoring them.
Public function void Discard any transient state and all meta-data for any currently animating objects, whilst preserving the cached values internally.
Public function void  
Public function Const TSharedPtr< GroupManagerType > Find a group manager by its type.
Public function Const TSharedPtr< StorageType >

FindStorage ( TPreAnimatedStorageID< StorageType > InStorageID
)

 Find a specific storage type by its ID.
Public function void Called by group managers to free an existing group
Public function Const FPreAnimatedEntityCaptureSource *  
Public function FPreAnimatedEntityCaptureSource *  
Public function TSharedPtr< GroupManagerType > Get or create a group manager by its type.
Public function TSharedPtr< StorageType >

GetOrCreateStorage ( TPreAnimatedStorageID< StorageType > InStorageID
)

 Get a specific type of storage, creating it if it does not already exist
Public function TSharedPtr< StorageType > Get a specific type of storage, creating it if it does not already exist
Public function FPreAnimatedTrackInstanceInputCaptureSources *  
Public function FPreAnimatedTrackInstanceCaptureSources *  
Public function Const TSharedPtr< IPreAnimatedStorage > Get a genericly typed storage entry by its erased ID, failing an assertion if it does not exist
Public function Const EPreAnimatedStorageRequirement  
Public function Const FPreAnimatedTrackInstanceInputCaptureSources *  
Public function Const FPreAnimatedTrackInstanceCaptureSources *  
Public function Const bool  
Public function void  
Public function Const bool Check if this extension has any current requests to capture global (persistent) state entries
Public function Const bool  
Public function Static TPreAnimatedStorageID< StorageType > Called from TAutoRegisterPreAnimatedStorageID to register a new application-wide storage type
Public function void  
Public function void  
Public function void

ReplaceObjectForGroup ( FPreAnimatedStorageGroupHandle GroupHandle,
const FObjectKey& OldObject,
const FObjectKey& NewObject
)

 Called during blueprint re-instancing to replace the object bound to a specific group handle with another.
Public function void Resets the entry invalidation flag
Public function void Restore any state for any persistent tokens captured during the course of evaluation
Public function void Restore any state cached for the specified groupGroupHandle Handle to the group to restore
Public function void Use FScopedPreAnimatedCaptureSource to capture from a specific source rather than globally.
Public function void Use FScopedPreAnimatedCaptureSource to capture from a specific source rather than globally.
Public function void  
Public function void  
Public function void  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page