CesiumPropertyTexture.h

Go to the documentation of this file.

// Copyright 2020-2024 CesiumGS, Inc. and Contributors
 
#pragma once
 
#include "CesiumGltf/PropertyTextureView.h"
#include "CesiumPropertyTextureProperty.h"
#include "Containers/Array.h"
#include "Kismet/BlueprintFunctionLibrary.h"
#include "Kismet/GameplayStatics.h"
#include "CesiumPropertyTexture.generated.h"
 
namespace CesiumGltf {
struct Model;
struct PropertyTexture;
}; // namespace CesiumGltf
 
UENUM(BlueprintType)
enum class ECesiumPropertyTextureStatus : uint8 {
  /* The property texture is valid. */
  Valid = 0,
  /* The property texture instance was not initialized from an actual glTF
   property texture. */
  ErrorInvalidPropertyTexture,
  /* The property texture's class could be found in the schema of the metadata
   extension. */
  ErrorInvalidPropertyTextureClass
};
 
USTRUCT(BlueprintType)
struct CESIUMRUNTIME_API FCesiumPropertyTexture {
  GENERATED_USTRUCT_BODY()
 
public:
  FCesiumPropertyTexture()
      : _status(ECesiumPropertyTextureStatus::ErrorInvalidPropertyTexture) {}
 
  FCesiumPropertyTexture(
      const CesiumGltf::Model& model,
      const CesiumGltf::PropertyTexture& PropertyTexture);
 
  FString getClassName() const { return _className; }
 
private:
  ECesiumPropertyTextureStatus _status;
  FString _name;
  FString _className;
 
  TMap<FString, FCesiumPropertyTextureProperty> _properties;
 
  friend class UCesiumPropertyTextureBlueprintLibrary;
};
 
UCLASS()
class CESIUMRUNTIME_API UCesiumPropertyTextureBlueprintLibrary
    : public UBlueprintFunctionLibrary {
  GENERATED_BODY()
 
public:
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTexture")
  static const ECesiumPropertyTextureStatus
  GetPropertyTextureStatus(UPARAM(ref)
                               const FCesiumPropertyTexture& PropertyTexture);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTexture")
  static const FString&
  GetPropertyTextureName(UPARAM(ref)
                             const FCesiumPropertyTexture& PropertyTexture);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTexture")
  static const TMap<FString, FCesiumPropertyTextureProperty>
  GetProperties(UPARAM(ref) const FCesiumPropertyTexture& PropertyTexture);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTexture")
  static const TArray<FString>
  GetPropertyNames(UPARAM(ref) const FCesiumPropertyTexture& PropertyTexture);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTexture")
  static const FCesiumPropertyTextureProperty& FindProperty(
      UPARAM(ref) const FCesiumPropertyTexture& PropertyTexture,
      const FString& PropertyName);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTexture")
  static TMap<FString, FCesiumMetadataValue> GetMetadataValuesForUV(
      UPARAM(ref) const FCesiumPropertyTexture& PropertyTexture,
      const FVector2D& UV);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Metadata|PropertyTexture")
  static TMap<FString, FCesiumMetadataValue> GetMetadataValuesFromHit(
      UPARAM(ref) const FCesiumPropertyTexture& PropertyTexture,
      const FHitResult& Hit);
};