CesiumPropertyTableProperty.h

Go to the documentation of this file.

// Copyright 2020-2024 CesiumGS, Inc. and Contributors
 
#pragma once
 
#include "CesiumGltf/PropertyTablePropertyView.h"
#include "CesiumGltf/PropertyTypeTraits.h"
#include "CesiumMetadataValue.h"
#include "CesiumMetadataValueType.h"
#include "CesiumPropertyArray.h"
#include "Kismet/BlueprintFunctionLibrary.h"
#include "UObject/ObjectMacros.h"
#include <any>
#include <glm/glm.hpp>
#include <string_view>
#include <variant>
#include "CesiumPropertyTableProperty.generated.h"
 
UENUM(BlueprintType)
enum class ECesiumPropertyTablePropertyStatus : uint8 {
  /* The property table property is valid. */
  Valid = 0,
  /* The property table property is empty but has a specified default value. */
  EmptyPropertyWithDefault,
  /* The property table property does not exist in the glTF, or the property
     definition itself contains errors. */
  ErrorInvalidProperty,
  /* The data associated with the property table property is malformed and
     cannot be retrieved. */
  ErrorInvalidPropertyData
};
 
USTRUCT(BlueprintType)
struct CESIUMRUNTIME_API FCesiumPropertyTableProperty {
  GENERATED_USTRUCT_BODY()
 
private:
public:
  FCesiumPropertyTableProperty()
      : _status(ECesiumPropertyTablePropertyStatus::ErrorInvalidProperty),
        _property(),
        _valueType(),
        _normalized(false) {}
 
  template <typename T, bool Normalized>
  FCesiumPropertyTableProperty(
      const CesiumGltf::PropertyTablePropertyView<T, Normalized>& Property)
      : _status(ECesiumPropertyTablePropertyStatus::ErrorInvalidProperty),
        _property(Property),
        _valueType(),
        _normalized(Normalized) {
    switch (Property.status()) {
    case CesiumGltf::PropertyTablePropertyViewStatus::Valid:
      _status = ECesiumPropertyTablePropertyStatus::Valid;
      break;
    case CesiumGltf::PropertyTablePropertyViewStatus::EmptyPropertyWithDefault:
      _status = ECesiumPropertyTablePropertyStatus::EmptyPropertyWithDefault;
      break;
    case CesiumGltf::PropertyTablePropertyViewStatus::ErrorInvalidPropertyTable:
    case CesiumGltf::PropertyTablePropertyViewStatus::ErrorNonexistentProperty:
    case CesiumGltf::PropertyTablePropertyViewStatus::ErrorTypeMismatch:
    case CesiumGltf::PropertyTablePropertyViewStatus::
        ErrorComponentTypeMismatch:
    case CesiumGltf::PropertyTablePropertyViewStatus::ErrorArrayTypeMismatch:
    case CesiumGltf::PropertyTablePropertyViewStatus::ErrorInvalidNormalization:
    case CesiumGltf::PropertyTablePropertyViewStatus::
        ErrorNormalizationMismatch:
    case CesiumGltf::PropertyTablePropertyViewStatus::ErrorInvalidOffset:
    case CesiumGltf::PropertyTablePropertyViewStatus::ErrorInvalidScale:
    case CesiumGltf::PropertyTablePropertyViewStatus::ErrorInvalidMax:
    case CesiumGltf::PropertyTablePropertyViewStatus::ErrorInvalidMin:
    case CesiumGltf::PropertyTablePropertyViewStatus::ErrorInvalidNoDataValue:
    case CesiumGltf::PropertyTablePropertyViewStatus::ErrorInvalidDefaultValue:
      // The status was already set in the initializer list.
      return;
    default:
      _status = ECesiumPropertyTablePropertyStatus::ErrorInvalidPropertyData;
      return;
    }
 
    _valueType = TypeToMetadataValueType<T>();
    _normalized = Normalized;
  }
 
private:
  ECesiumPropertyTablePropertyStatus _status;
 
  std::any _property;
 
  FCesiumMetadataValueType _valueType;
  bool _normalized;
 
  friend class UCesiumPropertyTablePropertyBlueprintLibrary;
};
 
UCLASS()
class CESIUMRUNTIME_API UCesiumPropertyTablePropertyBlueprintLibrary
    : public UBlueprintFunctionLibrary {
  GENERATED_BODY()
 
public:
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static ECesiumPropertyTablePropertyStatus GetPropertyTablePropertyStatus(
      UPARAM(ref) const FCesiumPropertyTableProperty& Property);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static ECesiumMetadataBlueprintType
  GetBlueprintType(UPARAM(ref) const FCesiumPropertyTableProperty& Property);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static ECesiumMetadataBlueprintType GetArrayElementBlueprintType(
      UPARAM(ref) const FCesiumPropertyTableProperty& Property);
 
  PRAGMA_DISABLE_DEPRECATION_WARNINGS
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Meta =
          (DeprecatedFunction,
           DeprecationMessage = "Use GetArrayElementBlueprintType instead."))
  static ECesiumMetadataBlueprintType
  GetBlueprintComponentType(UPARAM(ref)
                                const FCesiumPropertyTableProperty& Property);
  PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static FCesiumMetadataValueType
  GetValueType(UPARAM(ref) const FCesiumPropertyTableProperty& Property);
 
  PRAGMA_DISABLE_DEPRECATION_WARNINGS
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Meta =
          (DeprecatedFunction,
           DeprecationMessage =
               "CesiumMetadataTrueType is deprecated. Use GetValueType to get the CesiumMetadataValueType instead."))
  static ECesiumMetadataTrueType_DEPRECATED
  GetTrueType(UPARAM(ref) const FCesiumPropertyTableProperty& Value);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Meta =
          (DeprecatedFunction,
           DeprecationMessage =
               "CesiumMetadataTrueType is deprecated. Use GetValueType to get the CesiumMetadataValueType instead."))
  static ECesiumMetadataTrueType_DEPRECATED
  GetTrueComponentType(UPARAM(ref) const FCesiumPropertyTableProperty& Value);
 
  PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static int64
  GetPropertySize(UPARAM(ref) const FCesiumPropertyTableProperty& Property);
 
  PRAGMA_DISABLE_DEPRECATION_WARNINGS
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Meta =
          (DeprecatedFunction,
           DeprecationMessage = "Use GetPropertySize instead."))
  static int64
  GetNumberOfFeatures(UPARAM(ref) const FCesiumPropertyTableProperty& Property);
  PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static int64 GetArraySize(UPARAM(ref)
                                const FCesiumPropertyTableProperty& Property);
 
  PRAGMA_DISABLE_DEPRECATION_WARNINGS
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Meta =
          (DeprecatedFunction,
           DeprecationMessage = "Use GetArraySize instead."))
  static int64
  GetComponentCount(UPARAM(ref) const FCesiumPropertyTableProperty& Property);
  PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static bool GetBoolean(
      UPARAM(ref) const FCesiumPropertyTableProperty& Property,
      int64 FeatureID,
      bool DefaultValue = false);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static uint8 GetByte(
      UPARAM(ref) const FCesiumPropertyTableProperty& Property,
      int64 FeatureID,
      uint8 DefaultValue = 0);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static int32 GetInteger(
      UPARAM(ref) const FCesiumPropertyTableProperty& Property,
      int64 FeatureID,
      int32 DefaultValue = 0);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static int64 GetInteger64(
      UPARAM(ref) const FCesiumPropertyTableProperty& Property,
      int64 FeatureID,
      int64 DefaultValue = 0);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static float GetFloat(
      UPARAM(ref) const FCesiumPropertyTableProperty& Property,
      int64 FeatureID,
      float DefaultValue = 0.0f);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static double GetFloat64(
      UPARAM(ref) const FCesiumPropertyTableProperty& Property,
      int64 FeatureID,
      double DefaultValue = 0.0);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static FIntPoint GetIntPoint(
      UPARAM(ref) const FCesiumPropertyTableProperty& Property,
      int64 FeatureID,
      const FIntPoint& DefaultValue);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static FVector2D GetVector2D(
      UPARAM(ref) const FCesiumPropertyTableProperty& Property,
      int64 FeatureID,
      const FVector2D& DefaultValue);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static FIntVector GetIntVector(
      UPARAM(ref) const FCesiumPropertyTableProperty& Property,
      int64 FeatureID,
      const FIntVector& DefaultValue);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static FVector3f GetVector3f(
      UPARAM(ref) const FCesiumPropertyTableProperty& Property,
      int64 FeatureID,
      const FVector3f& DefaultValue);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static FVector GetVector(
      UPARAM(ref) const FCesiumPropertyTableProperty& Property,
      int64 FeatureID,
      const FVector& DefaultValue);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static FVector4 GetVector4(
      UPARAM(ref) const FCesiumPropertyTableProperty& Property,
      int64 FeatureID,
      const FVector4& DefaultValue);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static FMatrix GetMatrix(
      UPARAM(ref) const FCesiumPropertyTableProperty& Property,
      int64 FeatureID,
      const FMatrix& DefaultValue);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static FString GetString(
      UPARAM(ref) const FCesiumPropertyTableProperty& Property,
      int64 FeatureID,
      const FString& DefaultValue = "");
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static FCesiumPropertyArray GetArray(
      UPARAM(ref) const FCesiumPropertyTableProperty& Property,
      int64 FeatureID);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static FCesiumMetadataValue GetValue(
      UPARAM(ref) const FCesiumPropertyTableProperty& Property,
      int64 FeatureID);
 
  PRAGMA_DISABLE_DEPRECATION_WARNINGS
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Meta = (DeprecatedFunction, DeprecatedMessage = "Use GetValue instead."))
  static FCesiumMetadataValue GetGenericValue(
      UPARAM(ref) const FCesiumPropertyTableProperty& Property,
      int64 FeatureID);
  PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static FCesiumMetadataValue GetRawValue(
      UPARAM(ref) const FCesiumPropertyTableProperty& Property,
      int64 FeatureID);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static bool IsNormalized(UPARAM(ref)
                               const FCesiumPropertyTableProperty& Property);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static FCesiumMetadataValue
  GetOffset(UPARAM(ref) const FCesiumPropertyTableProperty& Property);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static FCesiumMetadataValue
  GetScale(UPARAM(ref) const FCesiumPropertyTableProperty& Property);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static FCesiumMetadataValue
  GetMinimumValue(UPARAM(ref) const FCesiumPropertyTableProperty& Property);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static FCesiumMetadataValue
  GetMaximumValue(UPARAM(ref) const FCesiumPropertyTableProperty& Property);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static FCesiumMetadataValue
  GetNoDataValue(UPARAM(ref) const FCesiumPropertyTableProperty& Property);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTableProperty")
  static FCesiumMetadataValue
  GetDefaultValue(UPARAM(ref) const FCesiumPropertyTableProperty& Property);
};