SkyAtmosphereComponent.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Components/SceneComponent.h"
#include "EngineDefines.h"
#include "GameFramework/Info.h"
#include "Misc/Guid.h"
#include "RenderResource.h"
#include "StateStream/SkyAtmosphereStateStreamHandle.h"
 
#include "SkyAtmosphereComponent.generated.h"
 
 
class FSkyAtmosphereSceneProxy;
 
 
USTRUCT(BlueprintType)
struct FTentDistribution
{
    GENERATED_USTRUCT_BODY()
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Tent", meta = (UIMin = 0.0, UIMax = 60.0))
    float TipAltitude = 0.0f;
    
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Tent", meta = (UIMin = 0.0, UIMax = 1.0, ClampMin = 0.0, SliderExponent = 4.0))
    float TipValue = 0.0f;
    
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Tent", meta = (UIMin = 0.01, UIMax = 20.0, ClampMin = 0.0))
    float Width = 1.0f;
};
 
UENUM()
enum class ESkyAtmosphereTransformMode : uint8
{
    PlanetTopAtAbsoluteWorldOrigin,
    PlanetTopAtComponentTransform,
    PlanetCenterAtComponentTransform,
};
 
UCLASS(ClassGroup = Rendering, collapsecategories, hidecategories = (Object, Mobility, Activation, "Components|Activation"), editinlinenew, meta = (BlueprintSpawnableComponent), MinimalAPI)
class USkyAtmosphereComponent : public USceneComponent
{
    GENERATED_UCLASS_BODY()
 
    ~USkyAtmosphereComponent();
 
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Planet", meta = (HideAlphaChannel))
    ESkyAtmosphereTransformMode TransformMode;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Planet", meta = (DisplayName = "Ground Radius", UIMin = 1.0, UIMax = 7000.0, ClampMin = 0.1, ClampMax = 10000.0, SliderExponent = 5.0))
    float BottomRadius;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Planet", meta = (HideAlphaChannel))
    FColor GroundAlbedo;
 
 
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Atmosphere", meta = (UIMin = 1.0, UIMax = 200.0, ClampMin = 0.1, SliderExponent = 2.0))
    float AtmosphereHeight;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Atmosphere", meta = (DisplayName = "MultiScattering", UIMin = 0.0, UIMax = 2.0, ClampMin = 0.0, ClampMax = 100.0))
    float MultiScatteringFactor;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Atmosphere", AdvancedDisplay, meta = (UIMin = "0.25", UIMax = "8", ClampMin = "0.25", SliderExponent = 3.0))
    float TraceSampleCountScale;
    
 
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Atmosphere - Rayleigh", meta = (UIMin = 0.0, UIMax = 2.0, ClampMin = 0.0, SliderExponent = 4.0))
    float RayleighScatteringScale;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Atmosphere - Rayleigh", meta=(HideAlphaChannel))
    FLinearColor RayleighScattering;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Atmosphere - Rayleigh", meta = (UIMin = 0.01, UIMax = 20.0, ClampMin = 0.001, SliderExponent = 5.0))
    float RayleighExponentialDistribution;
 
 
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Atmosphere - Mie", meta = (UIMin = 0.0, UIMax = 5.0, ClampMin = 0.0, SliderExponent = 4.0))
    float MieScatteringScale;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Atmosphere - Mie", meta = (HideAlphaChannel))
    FLinearColor MieScattering;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Atmosphere - Mie", meta = (UIMin = 0.0, UIMax = 5.0, ClampMin = 0.0, SliderExponent = 4.0))
    float MieAbsorptionScale;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Atmosphere - Mie", meta = (HideAlphaChannel))
    FLinearColor MieAbsorption;
    
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Atmosphere - Mie", meta = (UIMin = 0.0, UIMax = 0.999, ClampMin = 0.0, ClampMax = 0.999))
    float MieAnisotropy;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Atmosphere - Mie", meta = (UIMin = 0.01, UIMax = 10.0, ClampMin = 0.001, SliderExponent = 5.0))
    float MieExponentialDistribution;
 
 
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Atmosphere - Absorption", meta = (DisplayName = "Absorption Scale", UIMin = 0.0, UIMax = 0.2, ClampMin = 0.0, SliderExponent = 3.0))
    float OtherAbsorptionScale;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Atmosphere - Absorption", meta = (DisplayName = "Absorption", HideAlphaChannel))
    FLinearColor OtherAbsorption;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Atmosphere - Absorption", meta = (DisplayName = "Tent Distribution"))
    FTentDistribution OtherTentDistribution;
    
 
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Art Direction", meta = (HideAlphaChannel))
    FLinearColor SkyLuminanceFactor;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Art Direction", meta = (HideAlphaChannel))
    FLinearColor SkyAndAerialPerspectiveLuminanceFactor;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Art Direction", meta = (DisplayName = "Aerial Perspective View Distance Scale", UIMin = 0.0, UIMax = 3.0, ClampMin = 0.0, SliderExponent = 2.0))
    float AerialPespectiveViewDistanceScale;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Art Direction", meta = (UIMin = 0.0, UIMax = 1.0, ClampMin = 0.0, SliderExponent = 2.0))
    float HeightFogContribution;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Art Direction", meta = (UIMin = -90.0, UIMax = 90.0, ClampMin = -90.0f, ClampMax = 90.0f))
    float TransmittanceMinLightElevationAngle;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Art Direction", meta = (UIMin = 0.001f, UIMax = 10.0f, ClampMin = 0.001f))
    float AerialPerspectiveStartDepth;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, BlueprintReadOnly, Category = Rendering, Interp)
    uint8 bHoldout : 1;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, BlueprintReadOnly, Category = Rendering)
    uint8 bRenderInMainPass : 1;
 
 
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void OverrideAtmosphereLightDirection(int32 AtmosphereLightIndex, const FVector& LightDirection);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API bool IsAtmosphereLightDirectionOverriden(int32 AtmosphereLightIndex);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API FVector GetOverridenAtmosphereLightDirection(int32 AtmosphereLightIndex);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void ResetAtmosphereLightDirectionOverride(int32 AtmosphereLightIndex);
 
    UFUNCTION(BlueprintCallable, Category = "Rendering", meta = (DisplayName = "Set Ground Radius"))
    ENGINE_API void SetBottomRadius(float NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetGroundAlbedo(const FColor& NewValue);
 
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetAtmosphereHeight(float NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetMultiScatteringFactor(float NewValue);
    
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetRayleighScatteringScale(float NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetRayleighScattering(FLinearColor NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetRayleighExponentialDistribution(float NewValue);
 
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetMieScatteringScale(float NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetMieScattering(FLinearColor NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetMieAbsorptionScale(float NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetMieAbsorption(FLinearColor NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetMieAnisotropy(float NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetMieExponentialDistribution(float NewValue);
 
    UFUNCTION(BlueprintCallable, Category = "Rendering", meta = (DisplayName = "Set Absorption Scale"))
    ENGINE_API void SetOtherAbsorptionScale(float NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering", meta = (DisplayName = "Set Absorption"))
    ENGINE_API void SetOtherAbsorption(FLinearColor NewValue);
 
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetSkyLuminanceFactor(FLinearColor NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetSkyAndAerialPerspectiveLuminanceFactor(FLinearColor NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetAerialPespectiveViewDistanceScale(float NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetAerialPerspectiveStartDepth(float NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetHeightFogContribution(float NewValue);
 
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetTransmittanceMinLightElevationAngle(float NewValue);
 
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetHoldout(bool bNewHoldout);
 
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetRenderInMainPass(bool bValue);
 
    UFUNCTION(BlueprintCallable, Category = "Utilities", meta = (DisplayName = "Get Atmosphere Transmitance On Ground At Planet Top"))
    ENGINE_API FLinearColor GetAtmosphereTransmitanceOnGroundAtPlanetTop(UDirectionalLightComponent* DirectionalLight);
 
    // This function can be used for instance in order to evaluate a directional atmospheric light outer space illuminance for a desired illuminance on ground given a direction. 
    // This is given for the position at the top of the virtual planet. Plus the output outer space illuminance into the light intensity.
    UFUNCTION(BlueprintCallable, Category = "Utilities", meta = (DisplayName = "Get Atmospheric Light To Match Illuminance On Ground"))
    ENGINE_API float GetAtmosphericLightToMatchIlluminanceOnGround(FVector LightDirection = FVector(0.0f, 0.0f, 1.0f), float IlluminanceOnGround = 1.0);
 
    // This is used to position the SkyAtmosphere similarly to the deprecated AtmosphericFog component
    void SetPositionToMatchDeprecatedAtmosphericFog();
 
protected:
    //~ Begin UActorComponent Interface.
    virtual void CreateRenderState_Concurrent(FRegisterComponentContext* Context) override;
    virtual void SendRenderTransform_Concurrent() override;
    virtual void DestroyRenderState_Concurrent() override;
    //~ End UActorComponent Interface.
 
public:
 
    //~ Begin UObject Interface. 
    virtual void Serialize(FArchive& Ar) override;
#if WITH_EDITOR
    virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif // WITH_EDITOR
    //~ End UObject Interface
 
    //~ Begin UActorComponent Interface.
#if WITH_EDITOR
    virtual void CheckForErrors() override;
#endif // WITH_EDITOR
    //~ End UActorComponent Interface.
 
    FGuid GetStaticLightingBuiltGuid() const { return bStaticLightingBuiltGUID; }
 
    void GetOverrideLightStatus(bool* OverrideAtmosphericLight, FVector* OverrideAtmosphericLightDirection) const;
 
private:
 
    FSkyAtmosphereSceneProxy* SkyAtmosphereSceneProxy;
 
    bool OverrideAtmosphericLight[NUM_ATMOSPHERE_LIGHTS];
    FVector OverrideAtmosphericLightDirection[NUM_ATMOSPHERE_LIGHTS];
 
    UPROPERTY()
    FGuid bStaticLightingBuiltGUID;
    void ValidateStaticLightingGUIDs();
    void UpdateStaticLightingGUIDs();
 
    void SendRenderTransformCommand();
 
protected:
    // When true, this means that this SkyAtmosphere is use as replacement for the deprecated AtmosphericFogComponent as a parent class. 
    // This is used to adapt the serialisation.
    bool bIsAtmosphericFog = false;
    
    void SetDummyStaticLightingGUIDs();
 
    #if WITH_STATE_STREAM_ACTOR
    FSkyAtmosphereHandle Handle;
    #endif
};
 
 
UCLASS(showcategories = (Movement, Rendering, Transformation, DataLayers, "Input|MouseInput", "Input|TouchInput"), ClassGroup = Fog, hidecategories = (Info, Object, Input), MinimalAPI)
class ASkyAtmosphere : public AInfo
{
    GENERATED_UCLASS_BODY()
 
private:
#if WITH_EDITOR
    virtual bool ActorTypeSupportsDataLayer() const override { return true; }
#endif
 
    UPROPERTY(BlueprintReadOnly, VisibleAnywhere, Category = Atmosphere, meta = (AllowPrivateAccess = "true"))
    TObjectPtr<class USkyAtmosphereComponent> SkyAtmosphereComponent;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    TObjectPtr<class UArrowComponent> ArrowComponent;
#endif
 
public:
 
    USkyAtmosphereComponent* GetComponent() const { return SkyAtmosphereComponent; }
 
};