Add ToString to CesiumPropertyArray and CesiumMetadataValueType

Author: j9liu

Source/CesiumRuntime/Private/CesiumMetadataValueType.cpp

@@ -0,0 +1,39 @@
+// Copyright 2020-2025 CesiumGS, Inc. and Contributors
+
+#include "CesiumMetadataValueType.h"
+
+#include <Cesium3DTiles/ClassProperty.h>
+
+using namespace CesiumGltf;
+
+FCesiumMetadataValueType::FCesiumMetadataValueType()
+    : Type(ECesiumMetadataType::Invalid),
+      ComponentType(ECesiumMetadataComponentType::None),
+      bIsArray(false) {}
+
+FCesiumMetadataValueType::FCesiumMetadataValueType(
+    ECesiumMetadataType InType,
+    ECesiumMetadataComponentType InComponentType,
+    bool IsArray)
+    : Type(InType), ComponentType(InComponentType), bIsArray(IsArray) {}
+
+FString FCesiumMetadataValueType::ToString() const {
+  if (Type == ECesiumMetadataType::Invalid) {
+    return TEXT("Invalid Type");
+  }
+
+  TArray<FString> strings;
+  strings.Reserve(3);
+
+  if (ComponentType != ECesiumMetadataComponentType::None) {
+    strings.Emplace(MetadataComponentTypeToString(ComponentType));
+  }
+
+  strings.Emplace(MetadataTypeToString(Type));
+
+  if (bIsArray) {
+    strings.Emplace("Array");
+  }
+
+  return FString::Join(strings, TEXT(" "));
+}

Source/CesiumRuntime/Private/CesiumPropertyArrayBlueprintLibrary.cpp

@@ -66,6 +66,21 @@ FCesiumMetadataValue UCesiumPropertyArrayBlueprintLibrary::GetValue(
       Array._valueView);
 }
 
+FString UCesiumPropertyArrayBlueprintLibrary::ToString(
+    UPARAM(ref) const FCesiumPropertyArray& Array) {
+  TArray<FString> results;
+
+  const int64 size = UCesiumPropertyArrayBlueprintLibrary::GetArraySize(Array);
+  for (int64 i = 0; i < size; i++) {
+    FCesiumMetadataValue value =
+        UCesiumPropertyArrayBlueprintLibrary::GetValue(Array, i);
+    results.Add(
+        UCesiumMetadataValueBlueprintLibrary::GetString(value, FString("")));
+  }
+
+  return "[" + FString::Join(results, TEXT(", ")) + "]";
+}
+
 PRAGMA_DISABLE_DEPRECATION_WARNINGS
 ECesiumMetadataTrueType_DEPRECATED
 UCesiumPropertyArrayBlueprintLibrary::GetTrueComponentType(

Source/CesiumRuntime/Private/Tests/CesiumPropertyArray.spec.cpp

@@ -225,8 +225,32 @@ void FCesiumPropertyArraySpec::Define() {
     });
   });
 
-  Describe("UCesiumPropertyArrayBlueprintLibrary::GetString", [this]() {
-    It("handles an int array correctly", [this]() {
+  Describe("ToString", [this]() {
+    It("handles bool elements", [this]() {
+      std::vector<bool> values{true, false, false, true, true};
+      // Extraneous bool constructor is needed to avoid implicit conversion
+      // under the hood.
+      TArray<FCesiumMetadataValue> valuesArray{
+          FCesiumMetadataValue(bool(values[0])),
+          FCesiumMetadataValue(bool(values[1])),
+          FCesiumMetadataValue(bool(values[2])),
+          FCesiumMetadataValue(bool(values[3])),
+          FCesiumMetadataValue(bool(values[4]))};
+
+      FCesiumPropertyArray array(std::move(valuesArray));
+      TestEqual(
+          "size",
+          UCesiumPropertyArrayBlueprintLibrary::GetSize(array),
+          int64(values.size()));
+
+      FString expected("[true, false, false, true, true]");
+      TestEqual(
+          "ToString",
+          UCesiumPropertyArrayBlueprintLibrary::ToString(array),
+          expected);
+    });
+
+    It("handles int elements", [this]() {
       std::vector<int32> values{1, 2, 3, -1};
       CesiumGltf::PropertyArrayCopy<int32> arrayView = std::vector(values);
       FCesiumPropertyArray array(arrayView);
@@ -235,15 +259,14 @@ void FCesiumPropertyArraySpec::Define() {
           UCesiumPropertyArrayBlueprintLibrary::GetSize(array),
           int64(values.size()));
 
-      for (size_t i = 0; i < values.size(); i++) {
-        TestEqual(
-            "GetString",
-            UCesiumPropertyArrayBlueprintLibrary::GetString(array, i),
-            FString(UTF8_TO_TCHAR(std::to_string(values[i]).c_str())));
-      }
+      FString expected("[1, 2, 3, -1]");
+      TestEqual(
+          "ToString",
+          UCesiumPropertyArrayBlueprintLibrary::ToString(array),
+          expected);
     });
 
-    It("handles an enum array correctly", [this]() {
+    It("handles enum elements", [this]() {
       TSharedPtr<FCesiumMetadataEnum> enumDef = MakeShared<FCesiumMetadataEnum>(
           StaticEnum<ECesiumMetadataBlueprintType>());
       std::vector<int32> values{
@@ -263,12 +286,31 @@ void FCesiumPropertyArraySpec::Define() {
           UCesiumPropertyArrayBlueprintLibrary::GetSize(array),
           int64(values.size()));
 
-      for (size_t i = 0; i < values.size(); i++) {
-        TestEqual(
-            "GetString",
-            UCesiumPropertyArrayBlueprintLibrary::GetString(array, i),
-            FString(UTF8_TO_TCHAR(valueNames[i].c_str())));
-      }
+      FString expected("[Boolean, Byte, Integer, Integer64]");
+      TestEqual(
+          "ToString",
+          UCesiumPropertyArrayBlueprintLibrary::ToString(array),
+          expected);
+    });
+
+    It("handles string elements", [this]() {
+      std::vector<std::string_view> values{"Test", "These", "Strings"};
+      TArray<FCesiumMetadataValue> valuesArray{
+          FCesiumMetadataValue(values[0]),
+          FCesiumMetadataValue(values[1]),
+          FCesiumMetadataValue(values[2])};
+
+      FCesiumPropertyArray array(std::move(valuesArray));
+      TestEqual(
+          "size",
+          UCesiumPropertyArrayBlueprintLibrary::GetSize(array),
+          int64(values.size()));
+
+      FString expected("[Test, These, Strings]");
+      TestEqual(
+          "ToString",
+          UCesiumPropertyArrayBlueprintLibrary::ToString(array),
+          expected);
     });
   });
 }

Source/CesiumRuntime/Public/CesiumMetadataValueType.h

@@ -1,14 +1,19 @@
-// Copyright 2020-2024 CesiumGS, Inc. and Contributors
+// Copyright 2020-2025 CesiumGS, Inc. and Contributors
 
 #pragma once
 
-#include "CesiumGltf/Enum.h"
-#include "CesiumGltf/PropertyArrayView.h"
-#include "CesiumGltf/PropertyType.h"
-#include "CesiumGltf/PropertyTypeTraits.h"
 #include "CesiumMetadataEnum.h"
+#include <CesiumGltf/Enum.h>
+#include <CesiumGltf/PropertyArrayView.h>
+#include <CesiumGltf/PropertyType.h>
+#include <CesiumGltf/PropertyTypeTraits.h>
+
 #include "CesiumMetadataValueType.generated.h"
 
+namespace Cesium3DTiles {
+struct ClassProperty;
+}
+
 /**
  * The Blueprint type that can losslessly represent values of a given property.
  */
@@ -139,16 +144,12 @@ USTRUCT(BlueprintType)
 struct CESIUMRUNTIME_API FCesiumMetadataValueType {
   GENERATED_USTRUCT_BODY()
 
-  FCesiumMetadataValueType()
-      : Type(ECesiumMetadataType::Invalid),
-        ComponentType(ECesiumMetadataComponentType::None),
-        bIsArray(false) {}
+  FCesiumMetadataValueType();
 
   FCesiumMetadataValueType(
       ECesiumMetadataType InType,
       ECesiumMetadataComponentType InComponentType,
-      bool IsArray = false)
-      : Type(InType), ComponentType(InComponentType), bIsArray(IsArray) {}
+      bool IsArray = false);
 
   /**
    * The type of the metadata property or value.
@@ -186,6 +187,12 @@ struct CESIUMRUNTIME_API FCesiumMetadataValueType {
     return Type != ValueType.Type || ComponentType != ValueType.ComponentType ||
            bIsArray != ValueType.bIsArray;
   }
+
+  /**
+   * Prints the type in the format "(Component Type) (Type) (Array)".
+   * For example, "Int16 Scalar", "Float32 Mat4 Array", "String Array".
+   */
+  FString ToString() const;
 };
 
 template <typename T>

Source/CesiumRuntime/Public/CesiumPropertyArrayBlueprintLibrary.h

@@ -73,6 +73,18 @@ class CESIUMRUNTIME_API UCesiumPropertyArrayBlueprintLibrary
   static FCesiumMetadataValue
   GetValue(UPARAM(ref) const FCesiumPropertyArray& Array, int64 Index);
 
+  /**
+   * Prints the contents of the array to a human-readable string in the format
+   * "[A, B, C, ... Z]".
+   * @param Array The array.
+   * @return A string capturing the contents of the array.
+   */
+  UFUNCTION(
+      BlueprintCallable,
+      BlueprintPure,
+      Category = "Cesium|Metadata|PropertyArray")
+  static FString ToString(UPARAM(ref) const FCesiumPropertyArray& Array);
+
   PRAGMA_DISABLE_DEPRECATION_WARNINGS
   /**
    * Gets the best-fitting Blueprints type for the elements of this array.