CesiumSunSky.h

Go to the documentation of this file.

// Copyright 2020-2024 CesiumGS, Inc. and Contributors
 
#pragma once
 
#include "CoreMinimal.h"
 
#include "CesiumGeoreference.h"
#include "Components/DirectionalLightComponent.h"
#include "Components/SkyAtmosphereComponent.h"
#include "Components/SkyLightComponent.h"
#include "Components/StaticMeshComponent.h"
#include "Engine/DirectionalLight.h"
#include "GameFramework/Actor.h"
#include "CesiumSunSky.generated.h"
 
class UCesiumGlobeAnchorComponent;
 
UCLASS()
class CESIUMRUNTIME_API ACesiumSunSky : public AActor {
  GENERATED_BODY()
 
public:
  // Sets default values for this actor's properties
  ACesiumSunSky();
 
  UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = Components)
  USceneComponent* Scene;
 
  UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = Components)
  USkyLightComponent* SkyLight;
 
  UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = Components)
  UDirectionalLightComponent* DirectionalLight;
 
  UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = Components)
  USkyAtmosphereComponent* SkyAtmosphere;
 
  UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = Components)
  UCesiumGlobeAnchorComponent* GlobeAnchor;
 
  UPROPERTY(
      EditAnywhere,
      BlueprintReadWrite,
      Category = "Cesium|Date and Time",
      meta = (ClampMin = -12, ClampMax = 14))
  double TimeZone = -5.0;
 
  UPROPERTY(
      EditAnywhere,
      BlueprintReadWrite,
      Category = "Cesium|Date and Time",
      meta = (UIMin = 4, UIMax = 22, ClampMin = 0, ClampMax = 23.9999))
  double SolarTime = 13.0;
 
  UPROPERTY(
      EditAnywhere,
      BlueprintReadWrite,
      Category = "Cesium|Date and Time",
      meta = (ClampMin = 1, ClampMax = 31))
  int32 Day = 21;
 
  UPROPERTY(
      EditAnywhere,
      BlueprintReadWrite,
      Category = "Cesium|Date and Time",
      meta = (ClampMin = 1, ClampMax = 12))
  int32 Month = 9;
 
  UPROPERTY(
      EditAnywhere,
      BlueprintReadWrite,
      Category = "Cesium|Date and Time",
      meta = (UIMin = 1800, UIMax = 2200, ClampMin = 0, ClampMax = 4000))
  int32 Year = 2019;
 
  UPROPERTY(
      BlueprintReadWrite,
      Category = "Cesium|Date and Time",
      meta = (ClampMin = -360, ClampMax = 360))
  double NorthOffset = -90.0;
 
  UPROPERTY(
      EditAnywhere,
      BlueprintReadWrite,
      Category = "Cesium|Date and Time|Daylight Savings")
  bool UseDaylightSavingTime = true;
 
protected:
  UPROPERTY(
      BlueprintReadOnly,
      Category = "Cesium",
      BlueprintGetter = GetGeoreference,
      Meta =
          (DeprecatedProperty,
           DeprecationMessage =
               "Get the Georeference instance from the Globe Anchor Component instead."))
  ACesiumGeoreference* Georeference_DEPRECATED;
 
  UFUNCTION(BlueprintGetter, Category = "Cesium")
  ACesiumGeoreference* GetGeoreference() const;
 
  UPROPERTY(
      EditAnywhere,
      BlueprintReadWrite,
      Category = "Cesium|Date and Time|Daylight Savings",
      meta = (ClampMin = 1, ClampMax = 12),
      meta = (EditCondition = "UseDaylightSavingTime"))
  int32 DSTStartMonth = 3;
 
  UPROPERTY(
      EditAnywhere,
      BlueprintReadWrite,
      Category = "Cesium|Date and Time|Daylight Savings",
      meta = (ClampMin = 1, ClampMax = 31),
      meta = (EditCondition = "UseDaylightSavingTime"))
  int32 DSTStartDay = 10;
 
  UPROPERTY(
      EditAnywhere,
      BlueprintReadWrite,
      Category = "Cesium|Date and Time|Daylight Savings",
      meta = (ClampMin = 1, ClampMax = 12),
      meta = (EditCondition = "UseDaylightSavingTime"))
  int32 DSTEndMonth = 11;
 
  UPROPERTY(
      EditAnywhere,
      BlueprintReadWrite,
      Category = "Cesium|Date and Time|Daylight Savings",
      meta = (ClampMin = 1, ClampMax = 31),
      meta = (EditCondition = "UseDaylightSavingTime"))
  int32 DSTEndDay = 3;
 
  UPROPERTY(
      EditAnywhere,
      BlueprintReadWrite,
      Category = "Cesium|Date and Time|Daylight Savings",
      meta = (ClampMin = 0, ClampMax = 23),
      meta = (EditCondition = "UseDaylightSavingTime"))
  int32 DSTSwitchHour = 2;
 
  UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Cesium|Atmosphere")
  bool UpdateAtmosphereAtRuntime = true;
 
  UPROPERTY(
      EditAnywhere,
      BlueprintReadWrite,
      meta = (EditCondition = "UpdateAtmosphereAtRuntime"),
      Category = "Cesium|Atmosphere")
  double InscribedGroundThreshold = 30.0;
 
  UPROPERTY(
      EditAnywhere,
      BlueprintReadWrite,
      meta = (EditCondition = "UpdateAtmosphereAtRuntime"),
      Category = "Cesium|Atmosphere")
  double CircumscribedGroundThreshold = 100.0;
 
  UPROPERTY(
      EditAnywhere,
      BlueprintReadWrite,
      meta = (EditCondition = "UpdateAtmosphereAtRuntime"),
      Category = "Cesium|Atmosphere")
  double CircumscribedGroundHeight = 0.0;
 
  UPROPERTY(
      EditAnywhere,
      BlueprintReadOnly,
      interp,
      Category = "Cesium|Atmosphere",
      meta = (UIMin = 1.0, UIMax = 200.0, ClampMin = 0.1, SliderExponent = 2.0))
  float AtmosphereHeight = 60.0f;
 
  UPROPERTY(
      EditAnywhere,
      BlueprintReadOnly,
      interp,
      Category = "Cesium|Atmosphere",
      meta =
          (DisplayName = "Aerial Perspective View Distance Scale",
           UIMin = 0.0,
           UIMax = 3.0,
           ClampMin = 0.0,
           SliderExponent = 2.0))
  float AerialPerspectiveViewDistanceScale = 1.0f;
 
  UPROPERTY(
      EditAnywhere,
      BlueprintReadOnly,
      interp,
      Category = "Cesium|Atmosphere",
      meta =
          (UIMin = 0.01, UIMax = 20.0, ClampMin = 0.001, SliderExponent = 5.0))
  float RayleighExponentialDistribution = 8.0f;
 
  UPROPERTY(
      EditAnywhere,
      BlueprintReadOnly,
      interp,
      Category = "Cesium|Atmosphere",
      meta =
          (UIMin = 0.01, UIMax = 10.0, ClampMin = 0.001, SliderExponent = 5.0))
  float MieExponentialDistribution = 1.2f;
 
  UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Cesium|Sun")
  bool UseLevelDirectionalLight = false;
 
  UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Cesium|Sun")
  ADirectionalLight* LevelDirectionalLight;
 
  UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Sun")
  double Elevation = 0.f;
 
  UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Sun")
  double CorrectedElevation = 0.f;
 
  UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Sun")
  double Azimuth = 0.f;
 
  UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Cesium|Mobile")
  bool UseMobileRendering;
 
  UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Cesium|Mobile")
  TSubclassOf<AActor> SkySphereClass;
 
  UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Cesium|Mobile")
  AActor* SkySphereActor;
 
  UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Cesium|Mobile")
  double MobileDirectionalLightIntensity = 6.f;
 
public:
  UFUNCTION(
      CallInEditor,
      BlueprintCallable,
      BlueprintNativeEvent,
      Category = "Cesium")
  void UpdateSun();
  void UpdateSun_Implementation();
 
  UFUNCTION(CallInEditor, BlueprintCallable, Category = "Cesium")
  void UpdateAtmosphereRadius();
 
  UFUNCTION(BlueprintCallable, BlueprintPure, Category = Sun)
  static void GetHMSFromSolarTime(
      double InSolarTime,
      int32& Hour,
      int32& Minute,
      int32& Second);
 
  UFUNCTION(BlueprintCallable, BlueprintPure, Category = Sun)
  bool IsDST(
      bool DSTEnable,
      int32 InDSTStartMonth,
      int32 InDSTStartDay,
      int32 InDSTEndMonth,
      int32 InDSTEndDay,
      int32 InDSTSwitchHour) const;
 
  // Begin AActor Interface
  virtual void OnConstruction(const FTransform& Transform) override;
  // End AActor Interface
 
protected:
  UFUNCTION(BlueprintCallable, Category = "Cesium")
  void
  SetSkyAtmosphereGroundRadius(USkyAtmosphereComponent* Sky, double Radius);
 
  UFUNCTION(BlueprintCallable, Category = "Mobile")
  void UpdateSkySphere();
 
  virtual void BeginPlay() override;
  virtual void EndPlay(const EEndPlayReason::Type EndPlayReason) override;
  virtual void Serialize(FArchive& Ar) override;
  virtual void Tick(float DeltaSeconds) override;
  virtual void PostLoad() override;
  virtual bool ShouldTickIfViewportsOnly() const override;
 
#if WITH_EDITOR
  virtual void
  PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif
 
private:
  void _spawnSkySphere();
  double _computeScale() const;
 
  // Sets Directional Light Component in Sky Sphere actor
  void _setSkySphereDirectionalLight();
 
  void _setSkyAtmosphereVisibility(bool bVisible);
 
  // Determines whether mobile sky sphere will be spawned during OnConstruction.
  bool _wantsSpawnMobileSkySphere;
 
  void _handleTransformUpdated(
      USceneComponent* InRootComponent,
      EUpdateTransformFlags UpdateTransformFlags,
      ETeleportType Teleport);
 
  FDelegateHandle _transformUpdatedSubscription;
};