CesiumEncodedMetadataComponent.h

Go to the documentation of this file.

// Copyright 2020-2024 CesiumGS, Inc. and Contributors
 
#pragma once
 
#include "Components/ActorComponent.h"
#include "Containers/Array.h"
#include "Containers/UnrealString.h"
#include "Misc/Guid.h"
 
#if WITH_EDITOR
#include "Materials/MaterialFunctionMaterialLayer.h"
#endif
 
#include "CesiumEncodedMetadataComponent.generated.h"
 
PRAGMA_DISABLE_DEPRECATION_WARNINGS
 
UENUM()
enum class ECesiumPropertyComponentType_DEPRECATED : uint8 {
  Uint8_DEPRECATED,
  Float_DEPRECATED
};
 
UENUM()
enum class ECesiumPropertyType_DEPRECATED : uint8 {
  Scalar_DEPRECATED,
  Vec2_DEPRECATED,
  Vec3_DEPRECATED,
  Vec4_DEPRECATED
};
 
UENUM()
enum class ECesiumFeatureTableAccessType_DEPRECATED : uint8 {
  Unknown_DEPRECATED,
  Texture_DEPRECATED,
  Attribute_DEPRECATED,
  Mixed_DEPRECATED
};
 
// Note that these don't exhaustively cover the possibilities of glTF metadata
// classes, they only cover the subset that can be encoded into textures. For
// example, arbitrary size arrays and enums are excluded. Other un-encoded
// types like strings will be coerced.
 
struct UE_DEPRECATED(
    5.0,
    "CesiumEncodedMetadataComponent and its related description properties have been deprecated. Use CesiumEncodedFeaturesMetadata instead.")
    FPropertyDescription;
 
USTRUCT()
struct CESIUMRUNTIME_API FPropertyDescription {
  GENERATED_USTRUCT_BODY()
 
  
  UPROPERTY(EditAnywhere, Category = "Cesium")
  FString Name;
 
  UPROPERTY(EditAnywhere, Category = "Cesium")
  ECesiumPropertyComponentType_DEPRECATED ComponentType =
      ECesiumPropertyComponentType_DEPRECATED::Float_DEPRECATED;
 
  UPROPERTY(EditAnywhere, Category = "Cesium")
  ECesiumPropertyType_DEPRECATED Type =
      ECesiumPropertyType_DEPRECATED::Scalar_DEPRECATED;
 
  UPROPERTY(
      EditAnywhere,
      Category = "Cesium",
      Meta =
          (EditCondition =
               "ComponentType==ECesiumPropertyComponentType_DEPRECATED::Uint8_DEPRECATED"))
  bool Normalized = false;
};
 
struct UE_DEPRECATED(
    5.0,
    "CesiumEncodedMetadataComponent and its related description properties have been deprecated. Use CesiumEncodedFeaturesMetadata instead.")
    FFeatureTableDescription;
 
USTRUCT()
struct CESIUMRUNTIME_API FFeatureTableDescription {
  GENERATED_USTRUCT_BODY()
 
  
  UPROPERTY(EditAnywhere, Category = "Cesium")
  FString Name;
 
  UPROPERTY(EditAnywhere, Category = "Cesium")
  ECesiumFeatureTableAccessType_DEPRECATED AccessType =
      ECesiumFeatureTableAccessType_DEPRECATED::Unknown_DEPRECATED;
 
  UPROPERTY(
      EditAnywhere,
      Category = "Cesium",
      Meta =
          (EditCondition =
               "AccessType==ECesiumFeatureTableAccessType_DEPRECATED::Texture_DEPRECATED"))
  FString Channel;
 
  UPROPERTY(EditAnywhere, Category = "Cesium", Meta = (TitleProperty = "Name"))
  TArray<FPropertyDescription> Properties;
};
 
struct UE_DEPRECATED(
    5.0,
    "CesiumEncodedMetadataComponent and its related properties have been deprecated. Use CesiumEncodedFeaturesMetadata instead.")
    FFeatureTexturePropertyDescription;
 
USTRUCT()
struct CESIUMRUNTIME_API FFeatureTexturePropertyDescription {
  GENERATED_USTRUCT_BODY()
 
  
  UPROPERTY(EditAnywhere, Category = "Cesium")
  FString Name;
 
  // For now, always assumes it is Uint8
  /*
  UPROPERTY(EditAnywhere, Category = "Cesium")
  ECesiumPropertyComponentType ComponentType =
      ECesiumPropertyComponentType::Uint8;*/
 
  UPROPERTY(EditAnywhere, Category = "Cesium")
  ECesiumPropertyType_DEPRECATED Type =
      ECesiumPropertyType_DEPRECATED::Scalar_DEPRECATED;
 
  UPROPERTY(EditAnywhere, Category = "Cesium")
  bool Normalized = false;
 
  UPROPERTY(EditAnywhere, Category = "Cesium")
  FString Swizzle;
};
 
struct UE_DEPRECATED(
    5.0,
    "CesiumEncodedMetadataComponent and its related description properties have been deprecated. Use CesiumEncodedFeaturesMetadata instead.")
    FFeatureTextureDescription;
 
USTRUCT()
struct CESIUMRUNTIME_API FFeatureTextureDescription {
  GENERATED_USTRUCT_BODY()
 
  
  UPROPERTY(EditAnywhere, Category = "Cesium")
  FString Name;
 
  UPROPERTY(EditAnywhere, Category = "Cesium", Meta = (TitleProperty = "Name"))
  TArray<FFeatureTexturePropertyDescription> Properties;
};
 
struct UE_DEPRECATED(
    5.0,
    "CesiumEncodedMetadataComponent and its related description properties have been deprecated. Use CesiumEncodedFeaturesMetadata instead.")
    FMetadataDescription;
 
struct UE_DEPRECATED(
    5.0,
    "CesiumEncodedMetadataComponent and its related description properties have been deprecated. Use CesiumEncodedFeaturesMetadata instead.")
    FMetadataDescription;
 
USTRUCT()
struct CESIUMRUNTIME_API FMetadataDescription {
  GENERATED_USTRUCT_BODY()
 
  
  UPROPERTY(
      EditAnywhere,
      Category = "EncodeMetadata",
      Meta = (TitleProperty = "Name"))
  TArray<FFeatureTableDescription> FeatureTables;
 
  UPROPERTY(
      EditAnywhere,
      Category = "EncodeMetadata",
      Meta = (TitleProperty = "Name"))
  TArray<FFeatureTextureDescription> FeatureTextures;
};
 
UCLASS(Deprecated)
class CESIUMRUNTIME_API UDEPRECATED_CesiumEncodedMetadataComponent
    : public UActorComponent {
  GENERATED_BODY()
 
public:
#if WITH_EDITORONLY_DATA
  UPROPERTY(
      EditAnywhere,
      Category = "EncodeMetadata",
      Meta =
          (DeprecatedProperty,
           DeprecationMessage =
               "CesiumEncodedMetadataComponent is deprecated. Use CesiumFeaturesMetadataComponent instead."))
  UMaterialFunctionMaterialLayer* TargetMaterialLayer = nullptr;
#endif
 
  // Note: Here, we avoid wrapping the feature tables and feature textures
  // inside a FMetadataDescription to avoid further complicating the details
  // panel UI for editing the hierarchy.
 
  UPROPERTY(
      EditAnywhere,
      Category = "EncodeMetadata",
      Meta =
          (TitleProperty = "Name",
           DeprecatedProperty,
           DeprecationMessage =
               "CesiumEncodedMetadataComponent is deprecated. Use CesiumFeaturesMetadataComponent instead."))
  TArray<FFeatureTableDescription> FeatureTables;
 
  UPROPERTY(
      EditAnywhere,
      Category = "EncodeMetadata",
      Meta =
          (TitleProperty = "Name",
           DeprecatedProperty,
           DeprecationMessage =
               "CesiumEncodedMetadataComponent is deprecated. Use CesiumFeaturesMetadataComponent instead."))
  TArray<FFeatureTextureDescription> FeatureTextures;
 
  // virtual void Serialize(FArchive& Ar) override;
};
 
PRAGMA_ENABLE_DEPRECATION_WARNINGS