UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::MovieScene::TSetCompositePropertyValuesImpl< PropertyTraits, TPropertyMetaData< MetaDataTypes... >, CompositeTypes... > Struct Template Reference

#include <MovieScenePropertySystemTypes.h>

Public Types

using StorageType = typename PropertyTraits::StorageType
 
using FThreeWayAccessor = TMultiReadOptional< FCustomPropertyIndex, uint16, TSharedPtr< FTrackInstancePropertyBindings > >
 
using FTwoWayAccessor = TMultiReadOptional< uint16, TSharedPtr< FTrackInstancePropertyBindings > >
 

Public Member Functions

 TSetCompositePropertyValuesImpl (const PropertyTraits *InTraits, const ICustomPropertyRegistration *InCustomProperties)
 
void ForEachEntity (UObject *InObject, FCustomPropertyIndex CustomPropertyIndex, typename TCallTraits< MetaDataTypes >::ParamType... MetaData, typename TCallTraits< CompositeTypes >::ParamType... CompositeResults) const
 
void ForEachEntity (UObject *InObject, uint16 PropertyOffset, typename TCallTraits< MetaDataTypes >::ParamType... MetaData, typename TCallTraits< CompositeTypes >::ParamType... CompositeResults) const
 
void ForEachEntity (UObject *InObject, const TSharedPtr< FTrackInstancePropertyBindings > &PropertyBindings, typename TCallTraits< MetaDataTypes >::ParamType... MetaData, typename TCallTraits< CompositeTypes >::ParamType... CompositeResults) const
 
void ForEachAllocation (const FEntityAllocation *Allocation, TRead< UObject * > BoundObjectComponents, FThreeWayAccessor ResolvedPropertyComponents, TRead< MetaDataTypes >... InMetaData, TRead< CompositeTypes >... VariadicComponents) const
 
void ForEachAllocation (const FEntityAllocation *Allocation, TRead< UObject * > BoundObjectComponents, FTwoWayAccessor ResolvedPropertyComponents, TRead< MetaDataTypes >... InMetaData, TRead< CompositeTypes >... VariadicComponents) const
 

Member Typedef Documentation

◆ FThreeWayAccessor

template<typename PropertyTraits , typename... MetaDataTypes, typename... CompositeTypes>
using UE::MovieScene::TSetCompositePropertyValuesImpl< PropertyTraits, TPropertyMetaData< MetaDataTypes... >, CompositeTypes... >::FThreeWayAccessor = TMultiReadOptional<FCustomPropertyIndex, uint16, TSharedPtr<FTrackInstancePropertyBindings> >

◆ FTwoWayAccessor

template<typename PropertyTraits , typename... MetaDataTypes, typename... CompositeTypes>
using UE::MovieScene::TSetCompositePropertyValuesImpl< PropertyTraits, TPropertyMetaData< MetaDataTypes... >, CompositeTypes... >::FTwoWayAccessor = TMultiReadOptional<uint16, TSharedPtr<FTrackInstancePropertyBindings> >

◆ StorageType

template<typename PropertyTraits , typename... MetaDataTypes, typename... CompositeTypes>
using UE::MovieScene::TSetCompositePropertyValuesImpl< PropertyTraits, TPropertyMetaData< MetaDataTypes... >, CompositeTypes... >::StorageType = typename PropertyTraits::StorageType

Constructor & Destructor Documentation

◆ TSetCompositePropertyValuesImpl()

template<typename PropertyTraits , typename... MetaDataTypes, typename... CompositeTypes>
UE::MovieScene::TSetCompositePropertyValuesImpl< PropertyTraits, TPropertyMetaData< MetaDataTypes... >, CompositeTypes... >::TSetCompositePropertyValuesImpl ( const PropertyTraits *  InTraits,
const ICustomPropertyRegistration InCustomProperties 
)
inlineexplicit

Member Function Documentation

◆ ForEachAllocation() [1/2]

template<typename PropertyTraits , typename... MetaDataTypes, typename... CompositeTypes>
void UE::MovieScene::TSetCompositePropertyValuesImpl< PropertyTraits, TPropertyMetaData< MetaDataTypes... >, CompositeTypes... >::ForEachAllocation ( const FEntityAllocation Allocation,
TRead< UObject * >  BoundObjectComponents,
FThreeWayAccessor  ResolvedPropertyComponents,
TRead< MetaDataTypes >...  InMetaData,
TRead< CompositeTypes >...  VariadicComponents 
) const

Task callback that applies properties for a whole allocation of entities with either an FCustomPropertyIndex, uint16 or TSharedPtr<FTrackInstancePropertyBindings> property component Must be invoked with a task builder with the specified parameters:

FEntityTaskBuilder()
.Read(      TComponentTypeID<UObject*>(...) )
.ReadOneOf( TComponentTypeID<FCustomPropertyIndex>(...), TComponentTypeID<uint16>(...), TComponentTypeID<TSharedPtr<FTrackInstancePropertyBindings>>(...) )
.Read( TComponentTypeID<CompositeType[0  ]>(...) )
.Read( TComponentTypeID<CompositeType[...]>(...) )
.Read( TComponentTypeID<CompositeType[N-1]>(...) )
.Dispatch_PerAllocation<TSetCompositePropertyValues<PropertyType, CompositeTypes...>>(...);

◆ ForEachAllocation() [2/2]

template<typename PropertyTraits , typename... MetaDataTypes, typename... CompositeTypes>
void UE::MovieScene::TSetCompositePropertyValuesImpl< PropertyTraits, TPropertyMetaData< MetaDataTypes... >, CompositeTypes... >::ForEachAllocation ( const FEntityAllocation Allocation,
TRead< UObject * >  BoundObjectComponents,
FTwoWayAccessor  ResolvedPropertyComponents,
TRead< MetaDataTypes >...  InMetaData,
TRead< CompositeTypes >...  VariadicComponents 
) const

Task callback that applies properties for a whole allocation of entities with either a uint16 or TSharedPtr<FTrackInstancePropertyBindings> property component Must be invoked with a task builder with the specified parameters:

FEntityTaskBuilder()
.Read(      TComponentTypeID<UObject*>(...) )
.ReadOneOf( TComponentTypeID<uint16>(...), TComponentTypeID<TSharedPtr<FTrackInstancePropertyBindings>>(...) )
.Read( TComponentTypeID<CompositeType[0  ]>(...) )
.Read( TComponentTypeID<CompositeType[...]>(...) )
.Read( TComponentTypeID<CompositeType[N-1]>(...) )
.Dispatch_PerAllocation<TSetCompositePropertyValues<PropertyType, CompositeTypes...>>(...);

◆ ForEachEntity() [1/3]

template<typename PropertyTraits , typename... MetaDataTypes, typename... CompositeTypes>
void UE::MovieScene::TSetCompositePropertyValuesImpl< PropertyTraits, TPropertyMetaData< MetaDataTypes... >, CompositeTypes... >::ForEachEntity ( UObject InObject,
const TSharedPtr< FTrackInstancePropertyBindings > &  PropertyBindings,
typename TCallTraits< MetaDataTypes >::ParamType...  MetaData,
typename TCallTraits< CompositeTypes >::ParamType...  CompositeResults 
) const

Task callback that applies a value to an object property via a slow (legacy) track instance binding Must be invoked with a task builder with the specified parameters:

FEntityTaskBuilder()
.Read( TComponentTypeID<UObject*>(...) )
.Read( TComponentTypeID<TSharedPtr<FTrackInstancePropertyBindings>>(...) )
.Read( TComponentTypeID<CompositeType[0  ]>(...) )
.Read( TComponentTypeID<CompositeType[...]>(...) )
.Read( TComponentTypeID<CompositeType[N-1]>(...) )
.Dispatch_PerEntity<TSetCompositePropertyValues<PropertyType, CompositeTypes...>>(...);

◆ ForEachEntity() [2/3]

template<typename PropertyTraits , typename... MetaDataTypes, typename... CompositeTypes>
void UE::MovieScene::TSetCompositePropertyValuesImpl< PropertyTraits, TPropertyMetaData< MetaDataTypes... >, CompositeTypes... >::ForEachEntity ( UObject InObject,
FCustomPropertyIndex  CustomPropertyIndex,
typename TCallTraits< MetaDataTypes >::ParamType...  MetaData,
typename TCallTraits< CompositeTypes >::ParamType...  CompositeResults 
) const

Task callback that applies a value to an object property via a custom native setter function Must be invoked with a task builder with the specified parameters:

FEntityTaskBuilder()
.Read( TComponentTypeID<UObject*>(...) )
.Read( TComponentTypeID<FCustomPropertyIndex>(...) )
.Read( TComponentTypeID<CompositeType[0  ]>(...) )
.Read( TComponentTypeID<CompositeType[...]>(...) )
.Read( TComponentTypeID<CompositeType[N-1]>(...) )
.Dispatch_PerEntity<TSetCompositePropertyValues<PropertyType, CompositeTypes...>>(...);

◆ ForEachEntity() [3/3]

template<typename PropertyTraits , typename... MetaDataTypes, typename... CompositeTypes>
void UE::MovieScene::TSetCompositePropertyValuesImpl< PropertyTraits, TPropertyMetaData< MetaDataTypes... >, CompositeTypes... >::ForEachEntity ( UObject InObject,
uint16  PropertyOffset,
typename TCallTraits< MetaDataTypes >::ParamType...  MetaData,
typename TCallTraits< CompositeTypes >::ParamType...  CompositeResults 
) const

Task callback that applies a value to an object property via a fast pointer offset Must be invoked with a task builder with the specified parameters:

FEntityTaskBuilder()
.Read( TComponentTypeID<UObject*>(...) )
.Read( TComponentTypeID<uint16>(...) )
.Read( TComponentTypeID<CompositeType[0  ]>(...) )
.Read( TComponentTypeID<CompositeType[...]>(...) )
.Read( TComponentTypeID<CompositeType[N-1]>(...) )
.Dispatch_PerEntity<TSetCompositePropertyValues<PropertyType, CompositeTypes...>>(...);

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