UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
MovieScenePropertySystemTypes.inl
Go to the documentation of this file.
1// Copyright Epic Games, Inc. All Rights Reserved.
2
3#pragma once
4
5#include "EntitySystem/MovieScenePropertySystemTypes.h"
6#include "CoreTypes.h"
7#include "UObject/NameTypes.h"
8#include "Templates/SharedPointer.h"
9#include "Templates/UnrealTypeTraits.h"
10#include "Containers/SparseArray.h"
11#include "MovieSceneCommonHelpers.h"
12#include "EntitySystem/MovieSceneEntitySystemTypes.h"
13#include "EntitySystem/MovieSceneComponentRegistry.h"
14#include "EntitySystem/MovieSceneEntitySystemLinker.h"
15#include "EntitySystem/MovieSceneComponentAccessors.h"
16#include "EntitySystem/MovieSceneOperationalTypeConversions.h"
17#include "EntitySystem/MovieScenePropertyBinding.h"
18
19
20namespace UE::MovieScene
21{
22
23template<typename PropertyTraits, typename ...MetaDataTypes>
24void TSetPropertyValuesImpl<PropertyTraits, TPropertyMetaData<MetaDataTypes...>>::ForEachEntity(
25 UObject* InObject,
26 FCustomPropertyIndex CustomIndex,
27 typename TCallTraits<MetaDataTypes>::ParamType... MetaData,
28 InParamType ValueToSet) const
29{
30 Traits->SetObjectPropertyValue(InObject, MetaData..., CustomAccessors[CustomIndex.Value], ValueToSet);
31}
32
33template<typename PropertyTraits, typename ...MetaDataTypes>
34void TSetPropertyValuesImpl<PropertyTraits, TPropertyMetaData<MetaDataTypes...>>::ForEachEntity(
35 UObject* InObject,
36 uint16 PropertyOffset,
37 typename TCallTraits<MetaDataTypes>::ParamType... MetaData,
38 InParamType ValueToSet) const
39{
40 // Would really like to avoid branching here, but if we encounter this data the options are either handle it gracefully, stomp a vtable, or report a fatal error.
41 if (ensureAlwaysMsgf(PropertyOffset != 0, TEXT("Invalid property offset specified (ptr+%d bytes) for property on object %s. This would otherwise overwrite the object's vfptr."), PropertyOffset, *InObject->GetName()))
42 {
43 Traits->SetObjectPropertyValue(InObject, MetaData..., PropertyOffset, ValueToSet);
44 }
45}
46
47template<typename PropertyTraits, typename ...MetaDataTypes>
48void TSetPropertyValuesImpl<PropertyTraits, TPropertyMetaData<MetaDataTypes...>>::ForEachEntity(
49 UObject* InObject,
50 const TSharedPtr<FTrackInstancePropertyBindings>& PropertyBindings,
51 typename TCallTraits<MetaDataTypes>::ParamType... MetaData,
52 InParamType ValueToSet) const
53{
54 Traits->SetObjectPropertyValue(InObject, MetaData..., PropertyBindings.Get(), ValueToSet);
55}
56
57template<typename PropertyTraits, typename ...MetaDataTypes>
58void TSetPropertyValuesImpl<PropertyTraits, TPropertyMetaData<MetaDataTypes...>>::ForEachAllocation(
59 const FEntityAllocation* Allocation,
60 TRead<UObject*> BoundObjectComponents,
61 FThreeWayAccessor ResolvedPropertyComponents,
62 TRead<MetaDataTypes>... MetaDataComponents,
63 TRead<StorageType> PropertyValueComponents) const
64{
65 const int32 Num = Allocation->Num();
66 if (const FCustomPropertyIndex* Custom = ResolvedPropertyComponents.template Get<0>())
67 {
68 for (int32 Index = 0; Index < Num; ++Index)
69 {
70 ForEachEntity(BoundObjectComponents[Index], Custom[Index], MetaDataComponents[Index]..., PropertyValueComponents[Index]);
71 }
72 }
73 else if (const uint16* Fast = ResolvedPropertyComponents.template Get<1>())
74 {
75 for (int32 Index = 0; Index < Num; ++Index)
76 {
77 ForEachEntity(BoundObjectComponents[Index], Fast[Index], MetaDataComponents[Index]..., PropertyValueComponents[Index]);
78 }
79 }
80 else if (const TSharedPtr<FTrackInstancePropertyBindings>* Slow = ResolvedPropertyComponents.template Get<2>())
81 {
82 for (int32 Index = 0; Index < Num; ++Index)
83 {
84 ForEachEntity(BoundObjectComponents[Index], Slow[Index], MetaDataComponents[Index]..., PropertyValueComponents[Index]);
85 }
86 }
87}
88
89template<typename PropertyTraits, typename ...MetaDataTypes>
90void TSetPropertyValuesImpl<PropertyTraits, TPropertyMetaData<MetaDataTypes...>>::ForEachAllocation(
91 const FEntityAllocation* Allocation,
92 TRead<UObject*> BoundObjectComponents,
93 FTwoWayAccessor ResolvedPropertyComponents,
94 TRead<MetaDataTypes>... MetaDataComponents,
95 TRead<StorageType> PropertyValueComponents) const
96{
97 const int32 Num = Allocation->Num();
98 if (const uint16* Fast = ResolvedPropertyComponents.template Get<0>())
99 {
100 for (int32 Index = 0; Index < Num; ++Index)
101 {
102 ForEachEntity(BoundObjectComponents[Index], *Fast++, MetaDataComponents[Index]..., PropertyValueComponents[Index]);
103 }
104 }
105 else if (const TSharedPtr<FTrackInstancePropertyBindings>* Slow = ResolvedPropertyComponents.template Get<1>())
106 {
107 for (int32 Index = 0; Index < Num; ++Index)
108 {
109 ForEachEntity(BoundObjectComponents[Index], *Slow++, MetaDataComponents[Index]..., PropertyValueComponents[Index]);
110 }
111 }
112}
113
114template<typename PropertyTraits, typename ...MetaDataTypes>
115void TGetPropertyValuesImpl<PropertyTraits, TPropertyMetaData<MetaDataTypes...>>::ForEachEntity(
116 UObject* InObject,
117 FCustomPropertyIndex CustomPropertyIndex,
118 typename TCallTraits<MetaDataTypes>::ParamType... MetaData,
119 StorageType& OutValue) const
120{
121 Traits->GetObjectPropertyValue(InObject, MetaData..., CustomAccessors[CustomPropertyIndex.Value], OutValue);
122}
123
124template<typename PropertyTraits, typename ...MetaDataTypes>
125void TGetPropertyValuesImpl<PropertyTraits, TPropertyMetaData<MetaDataTypes...>>::ForEachEntity(
126 UObject* InObject,
127 uint16 PropertyOffset,
128 typename TCallTraits<MetaDataTypes>::ParamType... MetaData,
129 StorageType& OutValue) const
130{
131 // Would really like to avoid branching here, but if we encounter this data the options are either handle it gracefully, stomp a vtable, or report a fatal error.
132 if (ensureAlwaysMsgf(PropertyOffset != 0, TEXT("Invalid property offset specified (ptr+%d bytes) for property on object %s. This would otherwise overwrite the object's vfptr."), PropertyOffset, *InObject->GetName()))
133 {
134 Traits->GetObjectPropertyValue(InObject, MetaData..., PropertyOffset, OutValue);
135 }
136}
137
138template<typename PropertyTraits, typename ...MetaDataTypes>
139void TGetPropertyValuesImpl<PropertyTraits, TPropertyMetaData<MetaDataTypes...>>::ForEachEntity(
140 UObject* InObject,
141 const TSharedPtr<FTrackInstancePropertyBindings>& PropertyBindings,
142 typename TCallTraits<MetaDataTypes>::ParamType... MetaData,
143 StorageType& OutValue) const
144{
145 Traits->GetObjectPropertyValue(InObject, MetaData..., PropertyBindings.Get(), OutValue);
146}
147
148template<typename PropertyTraits, typename ...MetaDataTypes>
149void TGetPropertyValuesImpl<PropertyTraits, TPropertyMetaData<MetaDataTypes...>>::ForEachAllocation(
150 const FEntityAllocation* Allocation,
151 TRead<UObject*> BoundObjectComponents,
152 FThreeWayAccessor ResolvedPropertyComponents,
153 TRead<MetaDataTypes>... MetaData,
154 TWrite<StorageType> OutValueComponents) const
155{
156 const int32 Num = Allocation->Num();
157 if (const FCustomPropertyIndex* Custom = ResolvedPropertyComponents.template Get<0>())
158 {
159 for (int32 Index = 0; Index < Num; ++Index)
160 {
161 ForEachEntity(BoundObjectComponents[Index], Custom[Index], MetaData[Index]..., OutValueComponents[Index]);
162 }
163 }
164 else if (const uint16* Fast = ResolvedPropertyComponents.template Get<1>())
165 {
166 for (int32 Index = 0; Index < Num; ++Index)
167 {
168 ForEachEntity(BoundObjectComponents[Index], Fast[Index], MetaData[Index]..., OutValueComponents[Index]);
169 }
170 }
171 else if (const TSharedPtr<FTrackInstancePropertyBindings>* Slow = ResolvedPropertyComponents.template Get<2>())
172 {
173 for (int32 Index = 0; Index < Num; ++Index)
174 {
175 ForEachEntity(BoundObjectComponents[Index], Slow[Index], MetaData[Index]..., OutValueComponents[Index]);
176 }
177 }
178}
179
180template<typename PropertyTraits, typename ...MetaDataTypes>
181void TGetPropertyValuesImpl<PropertyTraits, TPropertyMetaData<MetaDataTypes...>>::ForEachAllocation(
182 const FEntityAllocation* Allocation,
183 TRead<UObject*> BoundObjectComponents,
184 FTwoWayAccessor ResolvedPropertyComponents,
185 TRead<MetaDataTypes>... MetaData,
186 TWrite<StorageType> OutValueComponents) const
187{
188 const int32 Num = Allocation->Num();
189 if (const uint16* Fast = ResolvedPropertyComponents.template Get<0>())
190 {
191 for (int32 Index = 0; Index < Num; ++Index)
192 {
193 ForEachEntity(BoundObjectComponents[Index], Fast[Index], MetaData[Index]..., OutValueComponents[Index]);
194 }
195 }
196 else if (const TSharedPtr<FTrackInstancePropertyBindings>* Slow = ResolvedPropertyComponents.template Get<1>())
197 {
198 for (int32 Index = 0; Index < Num; ++Index)
199 {
200 ForEachEntity(BoundObjectComponents[Index], Slow[Index], MetaData[Index]..., OutValueComponents[Index]);
201 }
202 }
203}
204
205
206template<typename PropertyTraits, typename... MetaDataTypes, typename... CompositeTypes>
207void TSetCompositePropertyValuesImpl<PropertyTraits, TPropertyMetaData<MetaDataTypes...>, CompositeTypes...>::ForEachEntity(
208 UObject* InObject,
209 FCustomPropertyIndex CustomPropertyIndex,
210 typename TCallTraits<MetaDataTypes>::ParamType... MetaData,
211 typename TCallTraits<CompositeTypes>::ParamType... CompositeResults) const
212{
213 StorageType Result = Traits->CombineComposites(MetaData..., CompositeResults...);
214 Traits->SetObjectPropertyValue(InObject, MetaData..., CustomAccessors[CustomPropertyIndex.Value], Result);
215}
216
217template<typename PropertyTraits, typename... MetaDataTypes, typename... CompositeTypes>
218void TSetCompositePropertyValuesImpl<PropertyTraits, TPropertyMetaData<MetaDataTypes...>, CompositeTypes...>::ForEachEntity(
219 UObject* InObject,
220 uint16 PropertyOffset,
221 typename TCallTraits<MetaDataTypes>::ParamType... MetaData,
222 typename TCallTraits<CompositeTypes>::ParamType... CompositeResults) const
223{
224 // Would really like to avoid branching here, but if we encounter this data the options are either handle it gracefully, stomp a vtable, or report a fatal error.
225 if (ensureAlwaysMsgf(PropertyOffset != 0, TEXT("Invalid property offset specified (ptr+%d bytes) for property on object %s. This would otherwise overwrite the object's vfptr."), PropertyOffset, *InObject->GetName()))
226 {
227 StorageType Result = Traits->CombineComposites(MetaData..., CompositeResults...);
228 Traits->SetObjectPropertyValue(InObject, MetaData..., PropertyOffset, Result);
229 }
230}
231
232template<typename PropertyTraits, typename... MetaDataTypes, typename... CompositeTypes>
233void TSetCompositePropertyValuesImpl<PropertyTraits, TPropertyMetaData<MetaDataTypes...>, CompositeTypes...>::ForEachEntity(
234 UObject* InObject,
235 const TSharedPtr<FTrackInstancePropertyBindings>& PropertyBindings,
236 typename TCallTraits<MetaDataTypes>::ParamType... MetaData,
237 typename TCallTraits<CompositeTypes>::ParamType... CompositeResults) const
238{
239 StorageType Result = Traits->CombineComposites(MetaData..., CompositeResults...);
240 Traits->SetObjectPropertyValue(InObject, MetaData..., PropertyBindings.Get(), Result);
241}
242
243template<typename PropertyTraits, typename... MetaDataTypes, typename... CompositeTypes>
244void TSetCompositePropertyValuesImpl<PropertyTraits, TPropertyMetaData<MetaDataTypes...>, CompositeTypes...>::ForEachAllocation(
245 const FEntityAllocation* Allocation,
246 TRead<UObject*> BoundObjectComponents,
247 FThreeWayAccessor ResolvedPropertyComponents,
248 TRead<MetaDataTypes>... InMetaData,
249 TRead<CompositeTypes>... VariadicComponents) const
250{
251 const int32 Num = Allocation->Num();
252 if (const FCustomPropertyIndex* Custom = ResolvedPropertyComponents.template Get<0>())
253 {
254 for (int32 Index = 0; Index < Num; ++Index )
255 {
256 ForEachEntity( BoundObjectComponents[Index], Custom[Index], InMetaData[Index]..., VariadicComponents[Index]... );
257 }
258 }
259 else if (const uint16* Fast = ResolvedPropertyComponents.template Get<1>())
260 {
261 for (int32 Index = 0; Index < Num; ++Index )
262 {
263 ForEachEntity( BoundObjectComponents[Index], Fast[Index], InMetaData[Index]..., VariadicComponents[Index]... );
264 }
265 }
266 else if (const TSharedPtr<FTrackInstancePropertyBindings>* Slow = ResolvedPropertyComponents.template Get<2>())
267 {
268 for (int32 Index = 0; Index < Num; ++Index )
269 {
270 ForEachEntity( BoundObjectComponents[Index], Slow[Index], InMetaData[Index]..., VariadicComponents[Index]... );
271 }
272 }
273}
274
275template<typename PropertyTraits, typename... MetaDataTypes, typename... CompositeTypes>
276void TSetCompositePropertyValuesImpl<PropertyTraits, TPropertyMetaData<MetaDataTypes...>, CompositeTypes...>::ForEachAllocation(
277 const FEntityAllocation* Allocation,
278 TRead<UObject*> BoundObjectComponents,
279 FTwoWayAccessor ResolvedPropertyComponents,
280 TRead<MetaDataTypes>... InMetaData,
281 TRead<CompositeTypes>... VariadicComponents) const
282{
283 const int32 Num = Allocation->Num();
284 if (const uint16* Fast = ResolvedPropertyComponents.template Get<0>())
285 {
286 for (int32 Index = 0; Index < Num; ++Index )
287 {
288 ForEachEntity( BoundObjectComponents[Index], Fast[Index], InMetaData[Index]..., VariadicComponents[Index]... );
289 }
290 }
291 else if (const TSharedPtr<FTrackInstancePropertyBindings>* Slow = ResolvedPropertyComponents.template Get<1>())
292 {
293 for (int32 Index = 0; Index < Num; ++Index )
294 {
295 ForEachEntity( BoundObjectComponents[Index], Slow[Index], InMetaData[Index]..., VariadicComponents[Index]... );
296 }
297 }
298}
299
300} // namespace UE::MovieScene
ensureAlwaysMsgf
#define ensureAlwaysMsgf(InExpression, InFormat,...)
Definition AssertionMacros.h:467
TEXT
#define TEXT(x)
Definition Platform.h:1272
int32
FPlatformTypes::int32 int32
A 32-bit signed integer.
Definition Platform.h:1125
StaticCastSharedRef
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127
Num
@ Num
Definition MetalRHIPrivate.h:234
uint16
uint16_t uint16
Definition binka_ue_file_header.h:7
TSharedPtr
Definition SharedPointer.h:692
TSharedPtr::Get
UE_FORCEINLINE_HINT ObjectType * Get() const
Definition SharedPointer.h:1065
UObjectBaseUtility::GetName
UE_FORCEINLINE_HINT FString GetName() const
Definition UObjectBaseUtility.h:439
UObject
Definition Object.h:95
UE::MovieScene
Definition ConstraintsManager.h:14
Index
U16 Index
Definition radfft.cpp:71
TCallTraitsBase::ParamType
TCallTraitsParamTypeHelper< T, PassByValue >::ParamType ParamType
Definition UnrealTypeTraits.h:275
UE::MovieScene::FCustomPropertyIndex
Definition MovieScenePropertySystemTypes.h:23
UE::MovieScene::FCustomPropertyIndex::Value
uint16 Value
Definition MovieScenePropertySystemTypes.h:24
UE::MovieScene::FEntityAllocation
Definition MovieSceneEntitySystemTypes.h:624
UE::MovieScene::FEntityAllocation::Num
int32 Num() const
Definition MovieSceneEntitySystemTypes.h:813
UE::MovieScene::TGetPropertyValuesImpl< PropertyTraits, TPropertyMetaData< MetaDataTypes... > >::StorageType
typename PropertyTraits::StorageType StorageType
Definition MovieScenePropertySystemTypes.h:455
UE::MovieScene::TGetPropertyValuesImpl
Definition MovieScenePropertySystemTypes.h:448
UE::MovieScene::TMultiComponentData
Definition MovieSceneComponentPtr.h:439
UE::MovieScene::TPropertyMetaData
Definition MovieScenePropertyMetaData.h:19
UE::MovieScene::TRead
Definition MovieSceneComponentPtr.h:195
UE::MovieScene::TSetCompositePropertyValuesImpl< PropertyTraits, TPropertyMetaData< MetaDataTypes... >, CompositeTypes... >::StorageType
typename PropertyTraits::StorageType StorageType
Definition MovieScenePropertySystemTypes.h:592
UE::MovieScene::TSetCompositePropertyValuesImpl
Definition MovieScenePropertySystemTypes.h:587
UE::MovieScene::TSetPropertyValuesImpl< PropertyTraits, TPropertyMetaData< MetaDataTypes... > >::InParamType
typename TCallTraits< typename PropertyTraits::StorageType >::ParamType InParamType
Definition MovieScenePropertySystemTypes.h:321
UE::MovieScene::TSetPropertyValuesImpl
Definition MovieScenePropertySystemTypes.h:313
UE::MovieScene::TWrite
Definition MovieSceneComponentPtr.h:288