UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
IMovieScenePreAnimatedTokenProducer Struct Referenceabstract

#include <MovieSceneExecutionToken.h>

+ Inheritance diagram for IMovieScenePreAnimatedTokenProducer:

Public Member Functions

virtual ~IMovieScenePreAnimatedTokenProducer ()
 
virtual void InitializeObjectForAnimation (UObject &Object) const
 
virtual IMovieScenePreAnimatedTokenPtr CacheExistingState (UObject &Object) const =0
 

Detailed Description

Type required for production of pre-animated state tokens. Implemented as a type rather than a callback to ensure efficient construction (these types are often constructed, but rarely utilized)

Constructor & Destructor Documentation

◆ ~IMovieScenePreAnimatedTokenProducer()

virtual IMovieScenePreAnimatedTokenProducer::~IMovieScenePreAnimatedTokenProducer ( )
inlinevirtual

Member Function Documentation

◆ CacheExistingState()

virtual IMovieScenePreAnimatedTokenPtr IMovieScenePreAnimatedTokenProducer::CacheExistingState ( UObject Object) const
pure virtual

Produce a token that can be used to return the specified object back to its current state

Note
Under some circumstances, the object may already be animated (for instance, after something has animated the object, but didn't restore state)
Parameters
ObjectThe object to initialize
Returns
A valid pre animated token that will restore this object back to its current state

Implemented in FMovieSceneRemoveInitialValueTokenProducer, UE::MovieScene::FSpawnTrackPreAnimatedTokenProducer, PropertyTemplate::FTokenProducer< PropertyValueType >, FStatelessPreAnimatedTokenProducer, TStatelessPreAnimatedTokenProducer< TokenType >, TForwardingPreAnimatedTokenProducer< TokenType >, FParticleParameterPreAnimatedTokenProducer, and UE::MovieScene::FLevelStreamingPreAnimatedTokenProducer.

◆ InitializeObjectForAnimation()

virtual void IMovieScenePreAnimatedTokenProducer::InitializeObjectForAnimation ( UObject Object) const
inlinevirtual

Perform any initial set up required to animate the specified object

Note
Only ever called when Object is in an unanimated state, as according to the AnimTypeID that this producer is operating on.
Parameters
ObjectThe object to initialize

The documentation for this struct was generated from the following file: