CesiumRasterOverlay.h

Go to the documentation of this file.

// Copyright 2020-2024 CesiumGS, Inc. and Contributors
 
#pragma once
 
#include "CesiumRasterOverlayLoadFailureDetails.h"
#include "CesiumRasterOverlays/RasterOverlay.h"
#include "Components/ActorComponent.h"
#include "CoreMinimal.h"
#include "Engine/Texture.h"
#include "Engine/TextureDefines.h"
#include <memory>
#include "CesiumRasterOverlay.generated.h"
 
namespace Cesium3DTilesSelection {
class Tileset;
}
 
DECLARE_MULTICAST_DELEGATE_OneParam(
    FCesiumRasterOverlayLoadFailure,
    const FCesiumRasterOverlayLoadFailureDetails&);
 
CESIUMRUNTIME_API extern FCesiumRasterOverlayLoadFailure
    OnCesiumRasterOverlayLoadFailure;
 
USTRUCT(BlueprintType)
struct FRasterOverlayRendererOptions {
  GENERATED_BODY()
 
  UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Cesium")
  TEnumAsByte<TextureFilter> filter = TextureFilter::TF_Default;
 
  UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Cesium")
  TEnumAsByte<TextureGroup> group = TextureGroup::TEXTUREGROUP_World;
 
  UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Cesium")
  bool useMipmaps = true;
};
 
UCLASS(Abstract)
class CESIUMRUNTIME_API UCesiumRasterOverlay : public UActorComponent {
  GENERATED_BODY()
 
public:
  UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Cesium")
  FString MaterialLayerKey = "Overlay0";
 
  UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Cesium")
  FRasterOverlayRendererOptions rendererOptions;
 
  // Sets default values for this component's properties
  UCesiumRasterOverlay();
 
  UFUNCTION(BlueprintCallable, Category = "Cesium")
  void AddToTileset();
 
  UFUNCTION(BlueprintCallable, Category = "Cesium")
  void RemoveFromTileset();
 
  UFUNCTION(BlueprintCallable, Category = "Cesium")
  void Refresh();
 
  UFUNCTION(BlueprintCallable, Category = "Cesium")
  double GetMaximumScreenSpaceError() const;
 
  UFUNCTION(BlueprintCallable, Category = "Cesium")
  void SetMaximumScreenSpaceError(double Value);
 
  UFUNCTION(BlueprintCallable, Category = "Cesium")
  int32 GetMaximumTextureSize() const;
 
  UFUNCTION(BlueprintCallable, Category = "Cesium")
  void SetMaximumTextureSize(int32 Value);
 
  UFUNCTION(BlueprintCallable, Category = "Cesium")
  int32 GetMaximumSimultaneousTileLoads() const;
 
  UFUNCTION(BlueprintCallable, Category = "Cesium")
  void SetMaximumSimultaneousTileLoads(int32 Value);
 
  UFUNCTION(BlueprintCallable, Category = "Cesium")
  int64 GetSubTileCacheBytes() const;
 
  UFUNCTION(BlueprintCallable, Category = "Cesium")
  void SetSubTileCacheBytes(int64 Value);
 
  virtual void Activate(bool bReset) override;
 
  virtual void Deactivate() override;
 
  virtual void OnComponentDestroyed(bool bDestroyingHierarchy) override;
  virtual bool IsReadyForFinishDestroy() override;
 
protected:
  UPROPERTY(
      EditAnywhere,
      BlueprintReadWrite,
      BlueprintGetter = GetMaximumScreenSpaceError,
      BlueprintSetter = SetMaximumScreenSpaceError,
      Category = "Cesium")
  double MaximumScreenSpaceError = 2.0;
 
  UPROPERTY(
      EditAnywhere,
      BlueprintReadWrite,
      BlueprintGetter = GetMaximumTextureSize,
      BlueprintSetter = SetMaximumTextureSize,
      Category = "Cesium")
  int32 MaximumTextureSize = 2048;
 
  UPROPERTY(
      EditAnywhere,
      BlueprintReadWrite,
      BlueprintGetter = GetMaximumSimultaneousTileLoads,
      BlueprintSetter = SetMaximumSimultaneousTileLoads,
      Category = "Cesium")
  int32 MaximumSimultaneousTileLoads = 20;
 
  UPROPERTY(
      EditAnywhere,
      BlueprintReadWrite,
      BlueprintGetter = GetSubTileCacheBytes,
      BlueprintSetter = SetSubTileCacheBytes,
      Category = "Cesium")
  int64 SubTileCacheBytes = 16 * 1024 * 1024;
 
  UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Cesium")
  bool ShowCreditsOnScreen;
 
#if WITH_EDITOR
  // Called when properties are changed in the editor
  virtual void
  PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif
 
  Cesium3DTilesSelection::Tileset* FindTileset() const;
 
  virtual std::unique_ptr<CesiumRasterOverlays::RasterOverlay>
  CreateOverlay(const CesiumRasterOverlays::RasterOverlayOptions& options = {})
      PURE_VIRTUAL(UCesiumRasterOverlay::CreateOverlay, return nullptr;);
 
  virtual void OnAdd(
      Cesium3DTilesSelection::Tileset* pTileset,
      CesiumRasterOverlays::RasterOverlay* pOverlay) {}
  virtual void OnRemove(
      Cesium3DTilesSelection::Tileset* pTileset,
      CesiumRasterOverlays::RasterOverlay* pOverlay) {}
 
private:
  CesiumRasterOverlays::RasterOverlay* _pOverlay;
  int32 _overlaysBeingDestroyed;
};