初始提交: UE5.3项目基础框架

Plugins/CesiumForUnreal/Source/CesiumRuntime/Public/CesiumMetadataPrimitive.h

@@ -0,0 +1,151 @@
+// Copyright 2020-2024 CesiumGS, Inc. and Contributors
+
+#pragma once
+
+#include "CesiumModelMetadata.h"
+#include "CesiumPrimitiveFeatures.h"
+#include "CesiumPrimitiveMetadata.h"
+#include "Kismet/BlueprintFunctionLibrary.h"
+#include "UObject/ObjectMacros.h"
+
+#include "CesiumMetadataPrimitive.generated.h"
+
+struct UE_DEPRECATED(
+    5.0,
+    "FCesiumMetadataPrimitive is deprecated. Instead, use FCesiumPrimitiveFeatures and FCesiumPrimitiveMetadata to retrieve feature IDs and metadata from a glTF primitive.")
+    FCesiumMetadataPrimitive;
+
+/**
+ * A Blueprint-accessible wrapper for a glTF Primitive's EXT_feature_metadata
+ * extension. This class is deprecated and only exists for backwards
+ * compatibility.
+ */
+USTRUCT(BlueprintType)
+struct CESIUMRUNTIME_API FCesiumMetadataPrimitive {
+  GENERATED_USTRUCT_BODY()
+
+public:
+  /**
+   * Construct an empty primitive metadata instance.
+   */
+  FCesiumMetadataPrimitive()
+      : _pPrimitiveFeatures(nullptr),
+        _pPrimitiveMetadata(nullptr),
+        _pModelMetadata(nullptr) {}
+
+  /**
+   * Constructs a primitive metadata instance from the new features / metadata
+   * implementations for backwards compatibility.
+   *
+   * This class exists for backwards compatibility, so it requires a
+   * FCesiumPrimitiveFeatures to have been constructed beforehand. It assumes
+   * the given FCesiumPrimitiveFeatures will have the same lifetime as this
+   * instance.
+   *
+   * @param PrimitiveFeatures The FCesiumPrimitiveFeatures denoting the feature
+   * IDs in the glTF mesh primitive.
+   * @param PrimitiveMetadata The FCesiumPrimitiveMetadata containing references
+   * to the metadata for the glTF mesh primitive.
+   * @param ModelMetadata The FCesiumModelMetadata containing the property
+   * tables and textures contained in a glTF model.
+   */
+  FCesiumMetadataPrimitive(
+      const FCesiumPrimitiveFeatures& PrimitiveFeatures,
+      const FCesiumPrimitiveMetadata& PrimitiveMetadata,
+      const FCesiumModelMetadata& ModelMetadata);
+
+private:
+  const FCesiumPrimitiveFeatures* _pPrimitiveFeatures;
+  const FCesiumPrimitiveMetadata* _pPrimitiveMetadata;
+  const FCesiumModelMetadata* _pModelMetadata;
+
+  friend class UCesiumMetadataPrimitiveBlueprintLibrary;
+};
+
+UCLASS()
+class CESIUMRUNTIME_API UCesiumMetadataPrimitiveBlueprintLibrary
+    : public UBlueprintFunctionLibrary {
+  GENERATED_BODY()
+
+public:
+  PRAGMA_DISABLE_DEPRECATION_WARNINGS
+
+  /**
+   * Get all the feature ID attributes that are associated with the
+   * primitive.
+   *
+   * @param MetadataPrimitive The {@link FCesiumMetadataPrimitive} to obtain the
+   * feature ID attributes from.
+   */
+  UFUNCTION(
+      BlueprintCallable,
+      BlueprintPure,
+      Category = "Cesium|Metadata|Primitive",
+      Meta =
+          (DeprecatedFunction,
+           DeprecationMessage =
+               "CesiumMetadataPrimitive is deprecated. Get feature IDs from CesiumPrimitiveFeatures instead."))
+  static const TArray<FCesiumFeatureIdAttribute>
+  GetFeatureIdAttributes(UPARAM(ref)
+                             const FCesiumMetadataPrimitive& MetadataPrimitive);
+
+  /**
+   * Get all the feature ID textures that are associated with the
+   * primitive.
+   *
+   * @param MetadataPrimitive The {@link FCesiumMetadataPrimitive} to obtain the
+   * feature ID textures from.
+   */
+  UFUNCTION(
+      BlueprintCallable,
+      BlueprintPure,
+      Category = "Cesium|Metadata|Primitive",
+      Meta =
+          (DeprecatedFunction,
+           DeprecationMessage =
+               "CesiumMetadataPrimitive is deprecated. Get feature IDs from CesiumPrimitiveFeatures instead."))
+  static const TArray<FCesiumFeatureIdTexture>
+  GetFeatureIdTextures(UPARAM(ref)
+                           const FCesiumMetadataPrimitive& MetadataPrimitive);
+
+  /**
+   * @brief Get all the feature textures that are associated with the
+   * primitive.
+   *
+   * @param MetadataPrimitive The {@link FCesiumMetadataPrimitive} to obtain the
+   * feature texture names from.
+   */
+  UFUNCTION(
+      BlueprintCallable,
+      BlueprintPure,
+      Category = "Cesium|Metadata|Primitive",
+      Meta =
+          (DeprecatedFunction,
+           DeprecationMessage =
+               "CesiumMetadataPrimitive is deprecated. Get the associated property texture indices from CesiumPrimitiveMetadata instead."))
+  static const TArray<FString>
+  GetFeatureTextureNames(UPARAM(ref)
+                             const FCesiumMetadataPrimitive& MetadataPrimitive);
+
+  /**
+   * Gets the ID of the first vertex that makes up a given face of this
+   * primitive.
+   *
+   * @param MetadataPrimitive The {@link FCesiumMetadataPrimitive} to obtain the
+   * vertex ID from.
+   * @param FaceID The ID of the face.
+   */
+  UFUNCTION(
+      BlueprintCallable,
+      BlueprintPure,
+      Category = "Cesium|Metadata|Primitive",
+      Meta =
+          (DeprecatedFunction,
+           DeprecationMessage =
+               "CesiumMetadataPrimitive is deprecated. Use GetFirstVertexFromFace with CesiumPrimitiveFeatures instead."))
+  static int64 GetFirstVertexIDFromFaceID(
+      UPARAM(ref) const FCesiumMetadataPrimitive& MetadataPrimitive,
+      int64 FaceID);
+
+  PRAGMA_ENABLE_DEPRECATION_WARNINGS
+};