CesiumFeatureIdAttribute.h

Go to the documentation of this file.

// Copyright 2020-2024 CesiumGS, Inc. and Contributors
 
#pragma once
 
#include "Kismet/BlueprintFunctionLibrary.h"
#include <CesiumGltf/AccessorUtility.h>
#include "CesiumFeatureIdAttribute.generated.h"
 
namespace CesiumGltf {
struct Model;
struct Accessor;
struct Node;
} // namespace CesiumGltf
 
UENUM(BlueprintType)
enum class ECesiumFeatureIdAttributeStatus : uint8 {
  /* The feature ID attribute is valid. */
  Valid = 0,
  /* The feature ID attribute does not exist in the glTF primitive. */
  ErrorInvalidAttribute,
  /* The feature ID attribute uses an invalid accessor in the glTF. */
  ErrorInvalidAccessor
};
 
USTRUCT(BlueprintType)
struct CESIUMRUNTIME_API FCesiumFeatureIdAttribute {
  GENERATED_USTRUCT_BODY()
 
public:
  FCesiumFeatureIdAttribute()
      : _status(ECesiumFeatureIdAttributeStatus::ErrorInvalidAttribute),
        _featureIdAccessor(),
        _attributeIndex(-1) {}
 
  FCesiumFeatureIdAttribute(
      const CesiumGltf::Model& Model,
      const CesiumGltf::MeshPrimitive& Primitive,
      const int64 FeatureIDAttribute,
      const FString& PropertyTableName);
 
  FCesiumFeatureIdAttribute(
      const CesiumGltf::Model& Model,
      const CesiumGltf::Node& Node,
      const int64 FeatureIDAttribute,
      const FString& PropertyTableName);
 
  int64 getAttributeIndex() const { return this->_attributeIndex; }
 
private:
  ECesiumFeatureIdAttributeStatus _status;
  CesiumGltf::FeatureIdAccessorType _featureIdAccessor;
  int64 _attributeIndex;
 
  // For backwards compatibility.
  FString _propertyTableName;
 
  friend class UCesiumFeatureIdAttributeBlueprintLibrary;
};
 
UCLASS()
class CESIUMRUNTIME_API UCesiumFeatureIdAttributeBlueprintLibrary
    : public UBlueprintFunctionLibrary {
  GENERATED_BODY()
 
public:
  PRAGMA_DISABLE_DEPRECATION_WARNINGS
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Meta =
          (DeprecatedFunction,
           DeprecationMessage =
               "Use GetPropertyTableIndex on a CesiumFeatureIdSet instead."))
  static const FString&
  GetFeatureTableName(UPARAM(ref)
                          const FCesiumFeatureIdAttribute& FeatureIDAttribute);
  PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Features|FeatureIDAttribute")
  static ECesiumFeatureIdAttributeStatus GetFeatureIDAttributeStatus(
      UPARAM(ref) const FCesiumFeatureIdAttribute& FeatureIDAttribute);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Features|FeatureIDAttribute")
  static int64
  GetCount(UPARAM(ref) const FCesiumFeatureIdAttribute& FeatureIDAttribute);
 
  UFUNCTION(
      BlueprintCallable,
      BlueprintPure,
      Category = "Cesium|Features|FeatureIDAttribute")
  static int64 GetFeatureID(
      UPARAM(ref) const FCesiumFeatureIdAttribute& FeatureIDAttribute,
      int64 Index);
};