#include <IMovieScenePropertyComponentHandler.h>

Inheritance diagram for UE::MovieScene::IPropertyComponentHandler:

Public Member Functions
virtual	~IPropertyComponentHandler ()

virtual bool	SupportsProperty (const FPropertyDefinition &Definition, const FProperty &InProperty) const =0

virtual FIntermediatePropertyValue	CoercePropertyValue (const FPropertyDefinition &Definition, const FProperty &InProperty, const FSourcePropertyValue &InPropertyValue) const =0

virtual void	UnpackChannels (const FPropertyDefinition &Definition, const FProperty &Property, const FIntermediatePropertyValueConstRef &Value, FUnpackedChannelValues &OutUnpackedValues) const =0

virtual void	ScheduleSetterTasks (const FPropertyDefinition &Definition, TArrayView< const FPropertyCompositeDefinition > Composites, const FPropertyStats &Stats, IEntitySystemScheduler TaskScheduler, UMovieSceneEntitySystemLinker Linker)=0

virtual void	DispatchSetterTasks (const FPropertyDefinition &Definition, TArrayView< const FPropertyCompositeDefinition > Composites, const FPropertyStats &Stats, FSystemTaskPrerequisites &InPrerequisites, FSystemSubsequentTasks &Subsequents, UMovieSceneEntitySystemLinker *Linker)=0

virtual void	DispatchInitializePropertyMetaDataTasks (const FPropertyDefinition &Definition, FSystemTaskPrerequisites &InPrerequisites, FSystemSubsequentTasks &Subsequents, UMovieSceneEntitySystemLinker *Linker)

virtual TSharedPtr< IPreAnimatedStorage >	GetPreAnimatedStateStorage (const FPropertyDefinition &Definition, FPreAnimatedStateExtension *Container)

virtual void	RecomposeBlendOperational (const FPropertyDefinition &Definition, TArrayView< const FPropertyCompositeDefinition > Composites, const FValueDecompositionParams &Params, UMovieSceneBlenderSystem *Blender, const FIntermediatePropertyValueConstRef &InCurrentValue, TArrayView< FIntermediatePropertyValue > OutResult)=0

virtual void	RecomposeBlendChannel (const FPropertyDefinition &Definition, TArrayView< const FPropertyCompositeDefinition > Composites, int32 CompositeIndex, const FValueDecompositionParams &Params, UMovieSceneBlenderSystem *Blender, double InCurrentValue, TArrayView< double > OutResults)=0

virtual void	RebuildOperational (const FPropertyDefinition &Definition, TArrayView< const FPropertyCompositeDefinition > Composites, const TArrayView< FMovieSceneEntityID > &EntityIDs, UMovieSceneEntitySystemLinker *Linker, FPropertyComponentArrayView OutResult)=0

virtual TSharedPtr< IInitialValueProcessor >	MakeInitialValueProcessor (const FPropertyDefinition &Definition)=0

Detailed Description

Interface for a property type handler that is able to interact with properties in sequencer

Constructor & Destructor Documentation

◆ ~IPropertyComponentHandler()

virtual UE::MovieScene::IPropertyComponentHandler::~IPropertyComponentHandler ( )

inlinevirtual

Member Function Documentation

◆ CoercePropertyValue()

virtual FIntermediatePropertyValue UE::MovieScene::IPropertyComponentHandler::CoercePropertyValue	(	const FPropertyDefinition &	Definition,
		const FProperty &	InProperty,
		const FSourcePropertyValue &	InPropertyValue
	)		const

pure virtual

Implemented in UE::MovieScene::TPropertyComponentHandlerImpl< PropertyTraits, TPropertyMetaData< MetaDataTypes... >, TIntegerSequence< int, MetaDataIndices... >, TIntegerSequence< int, CompositeIndices... >, CompositeTypes... >.

◆ DispatchInitializePropertyMetaDataTasks()

virtual void UE::MovieScene::IPropertyComponentHandler::DispatchInitializePropertyMetaDataTasks	(	const FPropertyDefinition &	Definition,
		FSystemTaskPrerequisites &	InPrerequisites,
		FSystemSubsequentTasks &	Subsequents,
		UMovieSceneEntitySystemLinker *	Linker
	)

inlinevirtual

Dispatch tasks that cache a pre-animated value for any entities that have the CachePreAnimatedState tag

Parameters

Definition	The property definition this handler was registered for
InPrerequisites	Task prerequisites for any entity system tasks that are dispatched
Subsequents	Subsequents to add any dispatched tasks to
Linker	The linker that owns the entity manager to dispatch tasks for
MetaDataProvider	Interface that is able to locate properties for entity IDs

◆ DispatchSetterTasks()

virtual void UE::MovieScene::IPropertyComponentHandler::DispatchSetterTasks	(	const FPropertyDefinition &	Definition,
		TArrayView< const FPropertyCompositeDefinition >	Composites,
		const FPropertyStats &	Stats,
		FSystemTaskPrerequisites &	InPrerequisites,
		FSystemSubsequentTasks &	Subsequents,
		UMovieSceneEntitySystemLinker *	Linker
	)

pure virtual

Implemented in UE::MovieScene::TPropertyComponentHandlerImpl< PropertyTraits, TPropertyMetaData< MetaDataTypes... >, TIntegerSequence< int, MetaDataIndices... >, TIntegerSequence< int, CompositeIndices... >, CompositeTypes... >.

◆ GetPreAnimatedStateStorage()

virtual TSharedPtr< IPreAnimatedStorage > UE::MovieScene::IPropertyComponentHandler::GetPreAnimatedStateStorage	(	const FPropertyDefinition &	Definition,
		FPreAnimatedStateExtension *	Container
	)

inlinevirtual

Retrieve the pre-animated storage for the property that this handler represents

Parameters

Definition	The property definition this handler was registered for
Container	The Pre-Animated state container extension that owns all pre-anim state for this evaluation

Reimplemented in UE::MovieScene::TPropertyComponentHandlerImpl< PropertyTraits, TPropertyMetaData< MetaDataTypes... >, TIntegerSequence< int, MetaDataIndices... >, TIntegerSequence< int, CompositeIndices... >, CompositeTypes... >.

◆ MakeInitialValueProcessor()

virtual TSharedPtr< IInitialValueProcessor > UE::MovieScene::IPropertyComponentHandler::MakeInitialValueProcessor ( const FPropertyDefinition & Definition )

pure virtual

Retrieve an initial value processor interface for this property type

Implemented in UE::MovieScene::TPropertyComponentHandlerImpl< PropertyTraits, TPropertyMetaData< MetaDataTypes... >, TIntegerSequence< int, MetaDataIndices... >, TIntegerSequence< int, CompositeIndices... >, CompositeTypes... >.

◆ RebuildOperational()

virtual void UE::MovieScene::IPropertyComponentHandler::RebuildOperational	(	const FPropertyDefinition &	Definition,
		TArrayView< const FPropertyCompositeDefinition >	Composites,
		const TArrayView< FMovieSceneEntityID > &	EntityIDs,
		UMovieSceneEntitySystemLinker *	Linker,
		FPropertyComponentArrayView	OutResult
	)

pure virtual

Rebuild operational values from the given entities. These entities are expected to store the value type's composite values.

Parameters

Definition	The property definition this handler was registered for
Composites	The composite channels that this property type comproses
EntityIDs	The entities on which the composite values will be found
Linker	The linker that owns the entity manager where the entities live
OutResult	The result to receieve rebuilt values, one for every entitiy in EntityIDs. Must be of type StorageType.

Implemented in UE::MovieScene::TPropertyComponentHandlerImpl< PropertyTraits, TPropertyMetaData< MetaDataTypes... >, TIntegerSequence< int, MetaDataIndices... >, TIntegerSequence< int, CompositeIndices... >, CompositeTypes... >.

◆ RecomposeBlendChannel()

virtual void UE::MovieScene::IPropertyComponentHandler::RecomposeBlendChannel	(	const FPropertyDefinition &	Definition,
		TArrayView< const FPropertyCompositeDefinition >	Composites,
		int32	CompositeIndex,
		const FValueDecompositionParams &	Params,
		UMovieSceneBlenderSystem *	Blender,
		double	InCurrentValue,
		TArrayView< double >	OutResults
	)

pure virtual

Run a recomposition using the specified params and values.

Parameters

Definition	The property definition this handler was registered for
Composite	The composite channel of the property type that we want to decompose
Params	The decomposition parameters
Blender	The blender system to recompose from
InCurrentValue	The current value (of type StorageType) to recompose using. For instance, if a property comprises 3 additive values (a:1, b:2, c:3), and we recompose 'a' with an InCurrentValue of 10, the result for 'a' would be 5.
OutResults	The result to receieve recomposed values, one for every entitiy in Params.Query.Entities.

Implemented in UE::MovieScene::TPropertyComponentHandlerImpl< PropertyTraits, TPropertyMetaData< MetaDataTypes... >, TIntegerSequence< int, MetaDataIndices... >, TIntegerSequence< int, CompositeIndices... >, CompositeTypes... >.

◆ RecomposeBlendOperational()

virtual void UE::MovieScene::IPropertyComponentHandler::RecomposeBlendOperational	(	const FPropertyDefinition &	Definition,
		TArrayView< const FPropertyCompositeDefinition >	Composites,
		const FValueDecompositionParams &	Params,
		UMovieSceneBlenderSystem *	Blender,
		const FIntermediatePropertyValueConstRef &	InCurrentValue,
		TArrayView< FIntermediatePropertyValue >	OutResult
	)

pure virtual

Run a recomposition using the specified params and values. The current value and result views must be of type StorageType

Parameters

Definition	The property definition this handler was registered for
Composites	The composite channels that this property type comprises
Params	The decomposition parameters
Blender	The blender system to recompose from
InCurrentValue	The current value (of type StorageType) to recompose using. For instance, if a property comprises 3 additive values (a:1, b:2, c:3), and we recompose 'a' with an InCurrentValue of 10, the result for 'a' would be 5.
OutResult	The result to receieve recomposed values, one for every entitiy in Params.Query.Entities. Must be of type StorageType.

Implemented in UE::MovieScene::TPropertyComponentHandlerImpl< PropertyTraits, TPropertyMetaData< MetaDataTypes... >, TIntegerSequence< int, MetaDataIndices... >, TIntegerSequence< int, CompositeIndices... >, CompositeTypes... >.

◆ ScheduleSetterTasks()

virtual void UE::MovieScene::IPropertyComponentHandler::ScheduleSetterTasks	(	const FPropertyDefinition &	Definition,
		TArrayView< const FPropertyCompositeDefinition >	Composites,
		const FPropertyStats &	Stats,
		IEntitySystemScheduler *	TaskScheduler,
		UMovieSceneEntitySystemLinker *	Linker
	)

pure virtual

Dispatch tasks that apply any entity that matches this property type to their final values

Parameters

Definition	The property definition this handler was registered for
Composites	The composite channels that this property type comprises
Stats	Stats pertaining to the entities that currently exist in the entity manager
InPrerequisites	Task prerequisites for any entity system tasks that are dispatched
Subsequents	Subsequents to add any dispatched tasks to
Linker	The linker that owns the entity manager to dispatch tasks for

Implemented in UE::MovieScene::TPropertyComponentHandlerImpl< PropertyTraits, TPropertyMetaData< MetaDataTypes... >, TIntegerSequence< int, MetaDataIndices... >, TIntegerSequence< int, CompositeIndices... >, CompositeTypes... >.

◆ SupportsProperty()

virtual bool UE::MovieScene::IPropertyComponentHandler::SupportsProperty	(	const FPropertyDefinition &	Definition,
		const FProperty &	InProperty
	)		const

pure virtual

Implemented in UE::MovieScene::TPropertyComponentHandlerImpl< PropertyTraits, TPropertyMetaData< MetaDataTypes... >, TIntegerSequence< int, MetaDataIndices... >, TIntegerSequence< int, CompositeIndices... >, CompositeTypes... >.

◆ UnpackChannels()

virtual void UE::MovieScene::IPropertyComponentHandler::UnpackChannels	(	const FPropertyDefinition &	Definition,
		const FProperty &	Property,
		const FIntermediatePropertyValueConstRef &	Value,
		FUnpackedChannelValues &	OutUnpackedValues
	)		const

pure virtual

Implemented in UE::MovieScene::TPropertyComponentHandlerImpl< PropertyTraits, TPropertyMetaData< MetaDataTypes... >, TIntegerSequence< int, MetaDataIndices... >, TIntegerSequence< int, CompositeIndices... >, CompositeTypes... >.

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

Engine/Source/Runtime/MovieScene/Public/EntitySystem/IMovieScenePropertyComponentHandler.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IPropertyComponentHandler()

Member Function Documentation

◆ CoercePropertyValue()

◆ DispatchInitializePropertyMetaDataTasks()

◆ DispatchSetterTasks()

◆ GetPreAnimatedStateStorage()

◆ MakeInitialValueProcessor()

◆ RebuildOperational()

◆ RecomposeBlendChannel()

◆ RecomposeBlendOperational()

◆ ScheduleSetterTasks()

◆ SupportsProperty()

◆ UnpackChannels()