CesiumPropertyTextureProperty.h

Go to the documentation of this file.

// Copyright 2020-2024 CesiumGS, Inc. and Contributors
 
#pragma once
 
#include "CesiumMetadataValue.h"
#include "GenericPlatform/GenericPlatform.h"
#include "Kismet/BlueprintFunctionLibrary.h"
#include <CesiumGltf/KhrTextureTransform.h>
#include <CesiumGltf/PropertyTexturePropertyView.h>
#include <any>
#include <optional>
#include "CesiumPropertyTextureProperty.generated.h"
 
UENUM(BlueprintType)
enum class ECesiumPropertyTexturePropertyStatus : uint8 {
  /* The property texture property is valid. */
  Valid = 0,
  /* The property texture property is empty but has a specified default value.
   */
  EmptyPropertyWithDefault,
  /* The property texture property does not exist in the glTF, or the property
     definition itself contains errors. */
  ErrorInvalidProperty,
  /* The data associated with the property texture property is malformed and
     cannot be retrieved. */
  ErrorInvalidPropertyData,
  /* The type of this property texture property is not supported. */
  ErrorUnsupportedProperty
};
 
USTRUCT(BlueprintType)
struct CESIUMRUNTIME_API FCesiumPropertyTextureProperty {
  GENERATED_USTRUCT_BODY()
 
public:
  FCesiumPropertyTextureProperty()
      : _status(ECesiumPropertyTexturePropertyStatus::ErrorInvalidProperty),
        _property(),
        _valueType(),
        _normalized(false) {}
 
  template <typename T, bool Normalized>
  FCesiumPropertyTextureProperty(
      const CesiumGltf::PropertyTexturePropertyView<T, Normalized>& Property)
      : _status(ECesiumPropertyTexturePropertyStatus::ErrorInvalidProperty),
        _property(Property),
        _valueType(),
        _normalized(Normalized) {
    switch (Property.status()) {
    case CesiumGltf::PropertyTexturePropertyViewStatus::Valid:
      _status = ECesiumPropertyTexturePropertyStatus::Valid;
      break;
    case CesiumGltf::PropertyTexturePropertyViewStatus::
        EmptyPropertyWithDefault:
      _status = ECesiumPropertyTexturePropertyStatus::EmptyPropertyWithDefault;
      break;
    case CesiumGltf::PropertyTexturePropertyViewStatus::
        ErrorUnsupportedProperty:
      _status = ECesiumPropertyTexturePropertyStatus::ErrorUnsupportedProperty;
      return;
    case CesiumGltf::PropertyTexturePropertyViewStatus::
        ErrorInvalidPropertyTexture:
    case CesiumGltf::PropertyTexturePropertyViewStatus::
        ErrorNonexistentProperty:
    case CesiumGltf::PropertyTexturePropertyViewStatus::ErrorTypeMismatch:
    case CesiumGltf::PropertyTexturePropertyViewStatus::
        ErrorComponentTypeMismatch:
    case CesiumGltf::PropertyTexturePropertyViewStatus::ErrorArrayTypeMismatch:
    case CesiumGltf::PropertyTexturePropertyViewStatus::
        ErrorInvalidNormalization:
    case CesiumGltf::PropertyTexturePropertyViewStatus::
        ErrorNormalizationMismatch:
    case CesiumGltf::PropertyTexturePropertyViewStatus::ErrorInvalidOffset:
    case CesiumGltf::PropertyTexturePropertyViewStatus::ErrorInvalidScale:
    case CesiumGltf::PropertyTexturePropertyViewStatus::ErrorInvalidMax:
    case CesiumGltf::PropertyTexturePropertyViewStatus::ErrorInvalidMin:
    case CesiumGltf::PropertyTexturePropertyViewStatus::ErrorInvalidNoDataValue:
    case CesiumGltf::PropertyTexturePropertyViewStatus::
        ErrorInvalidDefaultValue:
      // The status was already set in the initializer list.
      return;
    default:
      _status = ECesiumPropertyTexturePropertyStatus::ErrorInvalidPropertyData;
      return;
    }
 
    _valueType = TypeToMetadataValueType<T>();
    _normalized = Normalized;
  }
 
  const int64 getTexCoordSetIndex() const;
  const CesiumGltf::Sampler* getSampler() const;
  const CesiumGltf::ImageAsset* getImage() const;
  const std::optional<CesiumGltf::KhrTextureTransform>
  getTextureTransform() const;
 
private:
  ECesiumPropertyTexturePropertyStatus _status;
 
  std::any _property;
 
  FCesiumMetadataValueType _valueType;
  bool _normalized;
 
  friend class UCesiumPropertyTexturePropertyBlueprintLibrary;
};
 
UCLASS()
class CESIUMRUNTIME_API UCesiumPropertyTexturePropertyBlueprintLibrary
    : public UBlueprintFunctionLibrary {
  GENERATED_BODY()
 
public:
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTextureProperty")
  static ECesiumPropertyTexturePropertyStatus GetPropertyTexturePropertyStatus(
      UPARAM(ref) const FCesiumPropertyTextureProperty& Property);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTextureProperty")
  static ECesiumMetadataBlueprintType
  GetBlueprintType(UPARAM(ref) const FCesiumPropertyTextureProperty& Property);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTextureProperty")
  static ECesiumMetadataBlueprintType GetArrayElementBlueprintType(
      UPARAM(ref) const FCesiumPropertyTextureProperty& Property);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTextureProperty")
  static FCesiumMetadataValueType
  GetValueType(UPARAM(ref) const FCesiumPropertyTextureProperty& Property);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTextureProperty")
  static int64 GetArraySize(UPARAM(ref)
                                const FCesiumPropertyTextureProperty& Property);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTextureProperty")
  static int64 GetGltfTextureCoordinateSetIndex(
      UPARAM(ref) const FCesiumPropertyTextureProperty& Property);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTextureProperty")
  static int64 GetUnrealUVChannel(
      const UPrimitiveComponent* Component,
      UPARAM(ref) const FCesiumPropertyTextureProperty& Property);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTextureProperty")
  static TArray<int64>
  GetChannels(UPARAM(ref) const FCesiumPropertyTextureProperty& Property);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTextureProperty")
  static uint8 GetByte(
      UPARAM(ref) const FCesiumPropertyTextureProperty& Property,
      const FVector2D& UV,
      uint8 DefaultValue = 0);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTextureProperty")
  static int32 GetInteger(
      UPARAM(ref) const FCesiumPropertyTextureProperty& Property,
      const FVector2D& UV,
      int32 DefaultValue = 0);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTextureProperty")
  static float GetFloat(
      UPARAM(ref) const FCesiumPropertyTextureProperty& Property,
      const FVector2D& UV,
      float DefaultValue = 0.0f);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTextureProperty")
  static double GetFloat64(
      UPARAM(ref) const FCesiumPropertyTextureProperty& Property,
      const FVector2D& UV,
      double DefaultValue = 0.0);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTextureProperty")
  static FIntPoint GetIntPoint(
      UPARAM(ref) const FCesiumPropertyTextureProperty& Property,
      const FVector2D& UV,
      const FIntPoint& DefaultValue);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTextureProperty")
  static FVector2D GetVector2D(
      UPARAM(ref) const FCesiumPropertyTextureProperty& Property,
      const FVector2D& UV,
      const FVector2D& DefaultValue);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTextureProperty")
  static FIntVector GetIntVector(
      UPARAM(ref) const FCesiumPropertyTextureProperty& Property,
      const FVector2D& UV,
      const FIntVector& DefaultValue);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTextureProperty")
  static FVector GetVector(
      UPARAM(ref) const FCesiumPropertyTextureProperty& Property,
      const FVector2D& UV,
      const FVector& DefaultValue);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTextureProperty")
  static FVector4 GetVector4(
      UPARAM(ref) const FCesiumPropertyTextureProperty& Property,
      const FVector2D& UV,
      const FVector4& DefaultValue);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTextureProperty")
  static FCesiumPropertyArray GetArray(
      UPARAM(ref) const FCesiumPropertyTextureProperty& Property,
      const FVector2D& UV);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTextureProperty")
  static FCesiumMetadataValue GetValue(
      UPARAM(ref) const FCesiumPropertyTextureProperty& Property,
      const FVector2D& UV);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTextureProperty")
  static FCesiumMetadataValue GetRawValue(
      UPARAM(ref) const FCesiumPropertyTextureProperty& Property,
      const FVector2D& UV);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTextureProperty")
  static bool IsNormalized(UPARAM(ref)
                               const FCesiumPropertyTextureProperty& Property);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTextureProperty")
  static FCesiumMetadataValue
  GetOffset(UPARAM(ref) const FCesiumPropertyTextureProperty& Property);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTextureProperty")
  static FCesiumMetadataValue
  GetScale(UPARAM(ref) const FCesiumPropertyTextureProperty& Property);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTextureProperty")
  static FCesiumMetadataValue
  GetMinimumValue(UPARAM(ref) const FCesiumPropertyTextureProperty& Property);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTextureProperty")
  static FCesiumMetadataValue
  GetMaximumValue(UPARAM(ref) const FCesiumPropertyTextureProperty& Property);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTextureProperty")
  static FCesiumMetadataValue
  GetNoDataValue(UPARAM(ref) const FCesiumPropertyTextureProperty& Property);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTextureProperty")
  static FCesiumMetadataValue
  GetDefaultValue(UPARAM(ref) const FCesiumPropertyTextureProperty& Property);
 
  PRAGMA_DISABLE_DEPRECATION_WARNINGS
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Meta =
          (DeprecatedFunction,
           DeprecationMessage =
               "Swizzles are no longer hardcoded in Unreal materials. To see what channels the property uses, use GetChannels instead."))
  static FString GetSwizzle(UPARAM(ref)
                                const FCesiumPropertyTextureProperty& Property);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Meta =
          (DeprecatedFunction,
           DeprecationMessage =
               "Use GetChannels to get the channels array of a property texture property instead."))
  static int64
  GetComponentCount(UPARAM(ref) const FCesiumPropertyTextureProperty& Property);
  PRAGMA_ENABLE_DEPRECATION_WARNINGS
};