TMovieSceneBlendingActuator< DataType > Struct Template Reference

#include <MovieSceneBlendingActuator.h>

Inheritance diagram for TMovieSceneBlendingActuator< DataType >:

Public Member Functions
virtual void	Actuate (UObject *InObject, typename TCallTraits< DataType >::ParamType InValue, const TBlendableTokenStack< DataType > &OriginalStack, const FMovieSceneContext &Context, FPersistentEvaluationData &PersistentData, IMovieScenePlayer &Player)=0
virtual void	Actuate (FMovieSceneInterrogationData &InterrogationData, typename TCallTraits< DataType >::ParamType InValue, const TBlendableTokenStack< DataType > &OriginalStack, const FMovieSceneContext &Context) const
virtual DataType	RetrieveCurrentValue (UObject *InObject, IMovieScenePlayer *Player) const =0
virtual void	RemoveInitialValueForObject (FObjectKey ObjectToRemove) override
FMovieSceneBlendingActuatorID	GetActuatorID () const
bool	HasInitialValue (FObjectKey InObject) const
Public Member Functions inherited from IMovieSceneBlendingActuator
virtual	~IMovieSceneBlendingActuator ()
Public Member Functions inherited from TSharedFromThis< IMovieSceneBlendingActuator >
TSharedRef< IMovieSceneBlendingActuator, Mode >	AsShared ()
TSharedRef< IMovieSceneBlendingActuator const, Mode >	AsShared () const
TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const
TWeakPtr< IMovieSceneBlendingActuator, Mode >	AsWeak ()
TWeakPtr< IMovieSceneBlendingActuator const, Mode >	AsWeak () const
TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const
void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Protected Member Functions
	TMovieSceneBlendingActuator (FMovieSceneBlendingActuatorID InActuatorID)
Protected Member Functions inherited from TSharedFromThis< IMovieSceneBlendingActuator >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()

Friends
struct	TMovieSceneInitialValueStore< DataType >

Additional Inherited Members
Static Protected Member Functions inherited from TSharedFromThis< IMovieSceneBlendingActuator >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Detailed Description

template<typename DataType>
struct TMovieSceneBlendingActuator< DataType >

Templated blending actuator that knows how to apply a specific data type to an object

Constructor & Destructor Documentation

TMovieSceneBlendingActuator()

template<typename DataType >

TMovieSceneBlendingActuator< DataType >::TMovieSceneBlendingActuator ( FMovieSceneBlendingActuatorID  InActuatorID )

inlineprotected

Constructor

Member Function Documentation

Actuate() [1/2]

template<typename DataType >

virtual void TMovieSceneBlendingActuator< DataType >::Actuate ( FMovieSceneInterrogationData &  InterrogationData, typename TCallTraits< DataType >::ParamType  InValue, const TBlendableTokenStack< DataType > &  OriginalStack, const FMovieSceneContext &  Context  ) const

inlinevirtual

Add the final result of a blending operation to the interrogation data

Parameters

InterrogationData	The interrogation data to populate
InValue	The value to apply to the object.
OriginalStack	Reference to the original stack from which the final result was derived.
Context	Movie scene context structure from the root level

Reimplemented in TPropertyActuator< PropertyType >.

Actuate() [2/2]

template<typename DataType >

virtual void TMovieSceneBlendingActuator< DataType >::Actuate ( UObject *  InObject, typename TCallTraits< DataType >::ParamType  InValue, const TBlendableTokenStack< DataType > &  OriginalStack, const FMovieSceneContext &  Context, FPersistentEvaluationData &  PersistentData, IMovieScenePlayer &  Player  )

pure virtual

Apply the the specified value to an object.

Parameters

InObject	The object to apply the value to. nullptr where this actuator is being used for a root track.
InValue	The value to apply to the object.
OriginalStack	Reference to the original stack from which the final result was derived.
Context	Movie scene context structure from the root level
PersistentData	Persistent data store for the evaluation
Player	The movie scene player currently running the sequence

Implemented in FInt32Actuator, and TPropertyActuator< PropertyType >.

GetActuatorID()

template<typename DataType >

FMovieSceneBlendingActuatorID TMovieSceneBlendingActuator< DataType >::GetActuatorID ( ) const

inline

Access this actuator's unique identifier

HasInitialValue()

template<typename DataType >

bool TMovieSceneBlendingActuator< DataType >::HasInitialValue ( FObjectKey  InObject ) const

inline

Check whether this actuator has an initial value for the specified animated object

RemoveInitialValueForObject()

template<typename DataType >

virtual void TMovieSceneBlendingActuator< DataType >::RemoveInitialValueForObject ( FObjectKey  ObjectToRemove )

inlineoverridevirtual

Remove the initial value for the specified object from this actuator causing it to be re-computed next time it is required.

Parameters

InObject

The object to remove the initial value for.

Implements IMovieSceneBlendingActuator.

RetrieveCurrentValue()

template<typename DataType >

virtual DataType TMovieSceneBlendingActuator< DataType >::RetrieveCurrentValue ( UObject *  InObject, IMovieScenePlayer *  Player  ) const

pure virtual

Retrieve the current value of the specified object

Parameters

InObject	The object to retrieve the value from. nullptr where this actuator is being used for a root track.
Player	The movie scene player currently running the sequence. Null when this actuator is used in an interrogation context.

Returns

The current value of the object

Implemented in FInt32Actuator, and TPropertyActuator< PropertyType >.

Friends And Related Symbol Documentation

TMovieSceneInitialValueStore< DataType >

template<typename DataType >

friend struct TMovieSceneInitialValueStore< DataType >

friend

---

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

• Engine/Source/Runtime/MovieScene/Public/Evaluation/Blending/BlendableTokenStack.h
• Engine/Source/Runtime/MovieScene/Public/Evaluation/Blending/MovieSceneBlendingActuator.h