VolumetricCloudComponent.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 "VolumetricCloudComponent.generated.h"
 
 
class FVolumetricCloudSceneProxy;
 
UENUM()
enum class EVolumetricCloudTracingMaxDistanceMode : uint8
{
    DistanceFromCloudLayerEntryPoint = 0,
    DistanceFromPointOfView = 1,
};
 
UCLASS(ClassGroup = Rendering, collapsecategories, hidecategories = (Object, Mobility, Activation, "Components|Activation"), editinlinenew, meta = (BlueprintSpawnableComponent), MinimalAPI)
class UVolumetricCloudComponent : public USceneComponent
{
    GENERATED_UCLASS_BODY()
 
    ~UVolumetricCloudComponent();
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Layer", meta = (UIMin = 0.0f, UIMax = 20.0f, SliderExponent = 2.0))
    float LayerBottomAltitude;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Layer", meta = (UIMin = 0.1f, UIMax = 20.0f, ClampMin = 0.1, SliderExponent = 2.0))
    float LayerHeight;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Layer", meta = (UIMin = 100.0f, UIMax = 500.0f, ClampMin = 1.0f, SliderExponent = 2.0))
    float TracingStartMaxDistance;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Layer", meta = (UIMin = 0.0f, UIMax = 100.0f, ClampMin = 0.0f, SliderExponent = 3.0))
    float TracingStartDistanceFromCamera;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Layer")
    EVolumetricCloudTracingMaxDistanceMode TracingMaxDistanceMode;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Layer", meta = (UIMin = 1.0f, UIMax = 500.0f, ClampMin = 0.1f, SliderExponent = 2.0))
    float TracingMaxDistance;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Planet", meta = (UIMin = 100.0f, UIMax = 7000.0f, ClampMin = 0.1, ClampMax = 10000.0f))
    float PlanetRadius;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Planet", meta = (HideAlphaChannel))
    FColor GroundAlbedo;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Cloud Material")
    TSoftObjectPtr<UMaterialInterface> Material;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Cloud Tracing")
    uint32 bUsePerSampleAtmosphericLightTransmittance : 1; 
    // bUsePerSampleAtmosphericLightTransmittance is there on the cloud component and not on the light because otherwise we would need optimization permutations of the cloud shader.
    // And this for the two atmospheric lights ON or OFF. Keeping it simple for now because this changes the look of the cloud, so it is an art/look decision.
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Cloud Tracing", meta = (UIMin = 0.0f, UIMax = 1.0f, ClampMin = 0.0f, ClampMax = 1.0f))
    float SkyLightCloudBottomOcclusion;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Cloud Tracing", meta = (UIMin = "0.05", UIMax = "8", ClampMin = "0.05", SliderExponent = 1.0))
    float ViewSampleCountScale;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Cloud Tracing", meta = (UIMin = "0.05", UIMax = "8", ClampMin = "0.05", SliderExponent = 1.0))
    float ReflectionViewSampleCountScaleValue;
    UPROPERTY()
    float ReflectionViewSampleCountScale_DEPRECATED;
    UPROPERTY()
    float ReflectionSampleCountScale_DEPRECATED;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Cloud Tracing", meta = (UIMin = "0.05", UIMax = "8", ClampMin = "0.05", SliderExponent = 1.0))
    float ShadowViewSampleCountScale;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Cloud Tracing", meta = (UIMin = "0.05", UIMax = "8", ClampMin = "0.05", SliderExponent = 1.0))
    float ShadowReflectionViewSampleCountScaleValue;
    UPROPERTY()
    float ShadowReflectionViewSampleCountScale_DEPRECATED;
    UPROPERTY()
    float ShadowReflectionSampleCountScale_DEPRECATED;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Cloud Tracing", meta = (UIMin = "0.1", UIMax = "50", ClampMin = "0.01", SliderExponent = 3.0))
    float ShadowTracingDistance;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Cloud Tracing", meta = (UIMin = "0.0", UIMax = "1.0", ClampMin = "0.0", ClampMax = "1.0", SliderExponent = 5.0))
    float StopTracingTransmittanceThreshold;
    
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Art Direction", meta = (UIMin = 0.0, UIMax = 100.0, ClampMin = 0.0, SliderExponent = 2.0))
    float AerialPespectiveRayleighScatteringStartDistance;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Art Direction", meta = (UIMin = 0.0, UIMax = 100.0, ClampMin = 0.0, SliderExponent = 2.0))
    float AerialPespectiveRayleighScatteringFadeDistance;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Art Direction", meta = (UIMin = 0.0, UIMax = 100.0, ClampMin = 0.0, SliderExponent = 2.0))
    float AerialPespectiveMieScatteringStartDistance;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Art Direction", meta = (UIMin = 0.0, UIMax = 100.0, ClampMin = 0.0, SliderExponent = 2.0))
    float AerialPespectiveMieScatteringFadeDistance;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, BlueprintReadOnly, Category = Rendering, Interp)
    uint8 bHoldout : 1;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, BlueprintReadOnly, Category = Rendering)
    uint8 bRenderInMainPass : 1;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, BlueprintReadOnly, Category = Rendering)
    uint8 bVisibleInRealTimeSkyCaptures : 1;
 
 
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetLayerBottomAltitude(float NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetLayerHeight(float NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetTracingStartMaxDistance(float NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetTracingStartDistanceFromCamera(float NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetTracingMaxDistance(float NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetPlanetRadius(float NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetGroundAlbedo(FColor NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering", meta = (DisplayName = "Set Use Per Sample Atmospheric Light Transmittance"))
    ENGINE_API void SetbUsePerSampleAtmosphericLightTransmittance(bool NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetSkyLightCloudBottomOcclusion(float NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetViewSampleCountScale(float NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetReflectionViewSampleCountScale(float NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetShadowViewSampleCountScale(float NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetShadowReflectionViewSampleCountScale(float NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetShadowTracingDistance(float NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetStopTracingTransmittanceThreshold(float NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetMaterial(UMaterialInterface* NewValue);
 
    UMaterialInterface* GetMaterial() const { return MaterialLifetimePtr.Get(); }
 
    // Deprecated functions but still valid because they forward data correctly.
    UE_DEPRECATED(5.0, "This function has been replaced by SetReflectionViewSampleCountScale.")
    UFUNCTION(BlueprintCallable, Category = "Rendering", meta = (DeprecatedFunction, DeprecationMessage = "This function has been replaced by SetReflectionViewSampleCountScale."))
    ENGINE_API void SetReflectionSampleCountScale(float NewValue);
    UE_DEPRECATED(5.0, "This function has been replaced by SetShadowReflectionViewSampleCountScale.")
    UFUNCTION(BlueprintCallable, Category = "Rendering", meta = (DeprecatedFunction, DeprecationMessage = "This function has been replaced by SetShadowReflectionViewSampleCountScale."))
    ENGINE_API void SetShadowReflectionSampleCountScale(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 = "Rendering")
    ENGINE_API void SetVisibleInRealTimeSkyCaptures(bool bValue);
 
 
protected:
    //~ Begin UActorComponent Interface.
    virtual void CreateRenderState_Concurrent(FRegisterComponentContext* Context) override;
    virtual void DestroyRenderState_Concurrent() override;
    virtual void OnRegister() override;
    virtual void PrecachePSOs() override;
    //~ End UActorComponent Interface.
 
public:
 
    //~ Begin UObject Interface. 
    virtual void Serialize(FArchive& Ar) override;
    virtual void PostLoad() override;
#if WITH_EDITOR
    virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
    virtual void OnCookEvent(UE::Cook::ECookEvent CookEvent, UE::Cook::FCookEventContext& CookContext) override;
#endif // WITH_EDITOR
    //~ End UObject Interface
 
    //~ Begin UActorComponent Interface.
#if WITH_EDITOR
    virtual void CheckForErrors() override;
#endif // WITH_EDITOR
    //~ End UActorComponent Interface.
 
 
    // Those values should never be changed wihtout data conversion, that in order to maintain performance in case default values are used.
    static constexpr float BaseViewRaySampleCount = 96.0f;
    static constexpr float BaseShadowRaySampleCount = 10.0f;
    // Those values are part of a data conversion and should never be changed. CVars and component sample count controls should be enough.
    static constexpr float OldToNewReflectionViewRaySampleCount = 10.0f / BaseViewRaySampleCount;
    static constexpr float OldToNewReflectionShadowRaySampleCount = 3.0f / BaseShadowRaySampleCount;
 
private:
 
    FVolumetricCloudSceneProxy* VolumetricCloudSceneProxy;
 
    // The material is assigned to a regular pointer so that the garbage collector to not get ride of it.
    UPROPERTY()
    TObjectPtr<UMaterialInterface> MaterialLifetimePtr;
 
};
 
 
UCLASS(showcategories = (Movement, Rendering, Transformation, DataLayers, "Input|MouseInput", "Input|TouchInput"), ClassGroup = Fog, hidecategories = (Info, Object, Input), MinimalAPI)
class AVolumetricCloud : public AInfo
{
    GENERATED_UCLASS_BODY()
 
private:
 
    UPROPERTY(BlueprintReadOnly, VisibleAnywhere, Category = Atmosphere, meta = (AllowPrivateAccess = "true"))
    TObjectPtr<class UVolumetricCloudComponent> VolumetricCloudComponent;
 
#if WITH_EDITOR
    virtual bool ActorTypeSupportsDataLayer() const override { return true; }
#endif
 
};