Cesium for Unreal 2.12.0
Loading...
Searching...
No Matches
CesiumPropertyArrayBlueprintLibrary.h
Go to the documentation of this file.
1// Copyright 2020-2024 CesiumGS, Inc. and Contributors
2
3#pragma once
4
5#include "CesiumMetadataValue.h"
6#include "CesiumPropertyArray.h"
7#include "CesiumPropertyArrayBlueprintLibrary.generated.h"
8
13UCLASS()
14class CESIUMRUNTIME_API UCesiumPropertyArrayBlueprintLibrary
15 : public UBlueprintFunctionLibrary {
16 GENERATED_BODY()
17
18public:
24 UFUNCTION(
25 BlueprintCallable,
26 BlueprintPure,
27 Category = "Cesium|Metadata|PropertyArray")
28 static ECesiumMetadataBlueprintType
29 GetElementBlueprintType(UPARAM(ref) const FCesiumPropertyArray& array);
30
38 UFUNCTION(
39 BlueprintCallable,
40 BlueprintPure,
41 Category = "Cesium|Metadata|PropertyArray")
42 static FCesiumMetadataValueType
43 GetElementValueType(UPARAM(ref) const FCesiumPropertyArray& array);
44
52 UFUNCTION(
53 BlueprintCallable,
54 BlueprintPure,
55 Category = "Cesium|Metadata|PropertyArray")
56 static int64 GetArraySize(UPARAM(ref) const FCesiumPropertyArray& Array);
57
69 UFUNCTION(
70 BlueprintCallable,
71 BlueprintPure,
72 Category = "Cesium|Metadata|PropertyArray")
73 static FCesiumMetadataValue
74 GetValue(UPARAM(ref) const FCesiumPropertyArray& Array, int64 Index);
75
76 PRAGMA_DISABLE_DEPRECATION_WARNINGS
82 UFUNCTION(
83 BlueprintCallable,
84 BlueprintPure,
85 Meta =
86 (DeprecatedFunction,
87 DeprecationMessage = "Use GetElementBlueprintType instead."))
88 static ECesiumMetadataBlueprintType
89 GetBlueprintComponentType(UPARAM(ref) const FCesiumPropertyArray& array);
90
98 UFUNCTION(
99 BlueprintCallable,
100 BlueprintPure,
101 Meta =
102 (DeprecatedFunction,
103 DeprecationMessage =
104 "CesiumMetadataTrueType is deprecated. Use GetElementValueType instead."))
105 static ECesiumMetadataTrueType_DEPRECATED
106 GetTrueComponentType(UPARAM(ref) const FCesiumPropertyArray& array);
107
115 UFUNCTION(
116 BlueprintCallable,
117 BlueprintPure,
118 Meta =
119 (DeprecatedFunction,
120 DeprecationMessage = "Use GetArraySize instead."))
121 static int64 GetSize(UPARAM(ref) const FCesiumPropertyArray& Array);
122
145 UFUNCTION(
146 BlueprintCallable,
147 BlueprintPure,
148 Meta =
149 (DeprecatedFunction,
150 DeprecationMessage =
151 "GetBoolean is deprecated for metadata arrays. Use GetValue instead."))
152 static bool GetBoolean(
153 UPARAM(ref) const FCesiumPropertyArray& Array,
154 int64 Index,
155 bool DefaultValue = false);
156
182 UFUNCTION(
183 BlueprintCallable,
184 BlueprintPure,
185 Meta =
186 (DeprecatedFunction,
187 DeprecationMessage =
188 "GetByte is deprecated on arrays. Use GetValue instead."))
189 static uint8 GetByte(
190 UPARAM(ref) const FCesiumPropertyArray& Array,
191 int64 Index,
192 uint8 DefaultValue = 0);
193
220 UFUNCTION(
221 BlueprintCallable,
222 BlueprintPure,
223 Meta =
224 (DeprecatedFunction,
225 DeprecationMessage =
226 "GetInteger is deprecated for metadata arrays. Use GetValue instead."))
227 static int32 GetInteger(
228 UPARAM(ref) const FCesiumPropertyArray& Array,
229 int64 Index,
230 int32 DefaultValue = 0);
231
261 UFUNCTION(
262 BlueprintCallable,
263 BlueprintPure,
264 Meta =
265 (DeprecatedFunction,
266 DeprecationMessage =
267 "GetInteger64 is deprecated for metadata arrays. Use GetValue instead."))
268 static int64 GetInteger64(
269 UPARAM(ref) const FCesiumPropertyArray& Array,
270 int64 Index,
271 int64 DefaultValue = 0);
272
298 UFUNCTION(
299 BlueprintCallable,
300 BlueprintPure,
301 Meta =
302 (DeprecatedFunction,
303 DeprecationMessage =
304 "GetFloat is deprecated for metadata arrays. Use GetValue instead."))
305 static float GetFloat(
306 UPARAM(ref) const FCesiumPropertyArray& array,
307 int64 index,
308 float DefaultValue = 0.0f);
309
335 UFUNCTION(
336 BlueprintCallable,
337 BlueprintPure,
338 Meta =
339 (DeprecatedFunction,
340 DeprecationMessage =
341 "GetFloat64 is deprecated for metadata arrays. Use GetValue instead."))
342 static double GetFloat64(
343 UPARAM(ref) const FCesiumPropertyArray& array,
344 int64 index,
345 double DefaultValue);
346
364 UFUNCTION(
365 BlueprintCallable,
366 BlueprintPure,
367 Meta =
368 (DeprecatedFunction,
369 DeprecationMessage =
370 "GetString is deprecated for metadata arrays. Use GetValue instead."))
371 static FString GetString(
372 UPARAM(ref) const FCesiumPropertyArray& Array,
373 int64 Index,
374 const FString& DefaultValue = "");
375
376 PRAGMA_ENABLE_DEPRECATION_WARNINGS
377};
ECesiumMetadataTrueType_DEPRECATED
ECesiumMetadataTrueType_DEPRECATED
The type of a metadata property in EXT_feature_metadata.
Definition CesiumMetadataValueType.h:69
ECesiumMetadataBlueprintType
ECesiumMetadataBlueprintType
The Blueprint type that can losslessly represent values of a given property.
Definition CesiumMetadataValueType.h:14
UCesiumPropertyArrayBlueprintLibrary
Blueprint library functions for acting on an array property in EXT_structural_metadata.
Definition CesiumPropertyArrayBlueprintLibrary.h:15
UCesiumPropertyArrayBlueprintLibrary::GetElementBlueprintType
static ECesiumMetadataBlueprintType GetElementBlueprintType(UPARAM(ref) const FCesiumPropertyArray &array)
Gets the best-fitting Blueprints type for the elements of this array.
FCesiumMetadataValueType
Represents the true value type of a metadata value, akin to the property types in EXT_structural_meta...
Definition CesiumMetadataValueType.h:137
FCesiumMetadataValue
A Blueprint-accessible wrapper for a glTF metadata value.
Definition CesiumMetadataValue.h:20
FCesiumPropertyArray
A Blueprint-accessible wrapper for an array property in glTF metadata.
Definition CesiumPropertyArray.h:16