CesiumFeaturesMetadataComponent.h

Go to the documentation of this file.

// Copyright 2020-2026 CesiumGS, Inc. and Contributors
 
#pragma once
 
#include "Cesium3DTilesStyle.h"
#include "CesiumFeaturesMetadataDescription.h"
#include "CesiumMetadataComponent.h"
 
#if WITH_EDITOR
#include "Materials/MaterialFunctionMaterialLayer.h"
#endif
 
#include "CesiumFeaturesMetadataComponent.generated.h"
 
/**
 * @brief A component that can be added to Cesium3DTileset actors to
 * dictate what feature ID sets or metadata to encode for access on the GPU.
 * "Add Properties" allows users to find and select desired feature ID sets and
 * metadata properties. Once a selection is made, "Generate Material" can be
 * used to auto-generated the boiler-plate code to access the selected
 * properties in the Unreal material.
 */
UCLASS(ClassGroup = Cesium, Meta = (BlueprintSpawnableComponent))
class CESIUMRUNTIME_API UCesiumFeaturesMetadataComponent
    : public UCesiumMetadataComponent {
  GENERATED_BODY()
 
public:
#if WITH_EDITOR
  /**
   * Opens a window to add feature ID sets and metadata properties from the
   * current view of the tileset.
   */
  UFUNCTION(
      CallInEditor,
      Category = "Cesium",
      Meta = (DisplayName = "Add Properties"))
  void AddProperties();
 
  /**
   * Creates or overwrites a boiler-plate material layer that exposes the
   * requested metadata properties in the current description. The nodes to
   * access the metadata will be added to TargetMaterialLayer if it is already
   * specified. Otherwise a new material layer will be created in the /Content/
   * folder and TargetMaterialLayer will be set to the new material layer.
   */
  UFUNCTION(
      CallInEditor,
      Category = "Cesium",
      Meta = (DisplayName = "Generate Material"))
  void GenerateMaterial();
#endif
 
#if WITH_EDITORONLY_DATA
  /**
   * This is the target UMaterialFunctionMaterialLayer that the
   * boiler-plate material generation will use. When pressing
   * "Generate Material", nodes will be added to this material to enable access
   * to the requested metadata. If this is left blank, a new material layer
   * will be created in the /Content/ folder.
   */
  UPROPERTY(EditAnywhere, Category = "Cesium")
  UMaterialFunctionMaterialLayer* TargetMaterialLayer = nullptr;
#endif
 
  /**
   * The Blueprint class to instantiate for feature styling. This is used for
   * any feature ID sets with StylingMode set to Blueprint.
   */
  UPROPERTY(
      EditAnywhere,
      BlueprintReadWrite,
      Category = "Cesium",
      meta =
          (MustImplement =
               "/Script/CesiumRuntime.Cesium3DTilesStylingProvider"))
  TSubclassOf<UObject> BlueprintStyleClass;
 
  /**
   * Reapplies the Blueprint style specified in BlueprintStyleClass to the
   * tileset. Use this function to pick up any changes to the Blueprint
   * in-Editor as well as its instance at runtime.
   */
  UFUNCTION(
      CallInEditor,
      BlueprintCallable,
      Category = "Cesium",
      Meta = (DisplayName = "Refresh Style"))
  void RefreshStyle();
 
  /**
   * Description of both feature IDs and metadata from a glTF via the
   * EXT_mesh_features, EXT_instance_features, and EXT_structural_metadata
   * extensions. Indicates what parts of the extension should be uploaded to the
   * GPU for access in Unreal materials.
   */
  UPROPERTY(
      EditAnywhere,
      Category = "Cesium",
      Meta =
          (TitleProperty = "Name",
           DisplayAfter = "TargetMaterialLayer",
           ShowOnlyInnerProperties))
  FCesiumFeaturesMetadataDescription Description;
 
  PRAGMA_DISABLE_DEPRECATION_WARNINGS
  // Previously the properties of FCesiumFeaturesMetadataDescription were
  // deconstructed here in order to flatten the Details panel UI. However, the
  // ShowOnlyInnerProperties attribute accomplishes the same thing. These
  // properties are deprecated but migrated over in PostLoad().
 
  /**
   * Description of the feature ID sets in the visible glTF primitives across
   * the tileset.
   */
  UPROPERTY(
      Meta =
          (DeprecatedProperty,
           DeprecationMessage =
               "Use FeatureIdSets on the CesiumFeaturesMetadataDescription's Features instead."))
  TArray<FCesiumFeatureIdSetDescription> FeatureIdSets;
 
  /**
   * Names of the property textures used by the glTF primitives across the
   * tileset.
   *
   * This should be a subset of the property textures listed in the model
   * metadata. Property textures can be passed to the material even if they are
   * not explicitly used by a glTF primitive, but the primitive may lack the
   * corresponding sets of texture coordinates intended to sample them.
   */
  UPROPERTY(
      Meta =
          (DeprecatedProperty,
           DeprecationMessage =
               "Use PropertyTextureNames on the CesiumFeaturesMetadataDescription's PrimitiveMetadata instead."))
  TSet<FString> PropertyTextureNames;
 
  /**
   * Descriptions of the property tables in the visible glTF
   * models across the tileset.
   */
  UPROPERTY(
      Meta =
          (DeprecatedProperty,
           DeprecationMessage =
               "Use PropertyTables on the CesiumFeaturesMetadataDescription's ModelMetadata instead."))
  TArray<FCesiumPropertyTableDescription> PropertyTables;
 
  /**
   * Descriptions of property textures in the visible glTF models across
   * the tileset.
   */
  UPROPERTY(
      Meta =
          (DeprecatedProperty,
           DeprecationMessage =
               "Use PropertyTextures on the CesiumFeaturesMetadataDescription's ModelMetadata instead."))
  TArray<FCesiumPropertyTextureDescription> PropertyTextures;
  PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
  virtual void PostLoad() override;
 
#if WITH_EDITOR
  virtual void
  PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
  virtual void PostEditChangeChainProperty(
      FPropertyChangedChainEvent& PropertyChangedChainEvent) override;
  virtual void PostEditUndo() override;
#endif
 
  /**
   * Gets the instance of BlueprintStyleClass that has been created to style
   * features in this tileset. If no BlueprintStyleClass was specified, this
   * will be null.
   *
   * This function may be used to modify variables on the instance of the style
   * at runtime.
   */
  UFUNCTION(BlueprintCallable, Category = "Cesium|Styling")
  UObject* GetStyleInstance() const { return this->_pStyleInstance; }
 
protected:
  virtual void OnFetchMetadata(
      ACesium3DTileset* pActor,
      const Cesium3DTilesSelection::TilesetMetadata* pMetadata) override;
  virtual void ClearStatistics() override;
 
private:
  void recreateStyleInstance();
 
  UPROPERTY(Transient)
  UObject* _pStyleInstance;
};