ExponentialHeightFogComponent.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
 
#pragma once
 
#include "CoreMinimal.h"
#include "StateStream/ExponentialHeightFogStateStreamHandle.h"
#include "UObject/ObjectMacros.h"
#include "Components/SceneComponent.h"
#include "Rendering/ExponentialHeightFogData.h"
#include "ExponentialHeightFogComponent.generated.h"
 
UCLASS(ClassGroup=Rendering, collapsecategories, hidecategories=(Object, Mobility), editinlinenew, meta=(BlueprintSpawnableComponent), MinimalAPI)
class UExponentialHeightFogComponent : public USceneComponent
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(BlueprintReadOnly, interp, Category=ExponentialHeightFogComponent, meta=(UIMin = "0", UIMax = ".05"))
    float FogDensity;
 
    UPROPERTY(BlueprintReadOnly, interp, Category = ExponentialHeightFogComponent, meta = (UIMin = "0.001", UIMax = "2"))
    float FogHeightFalloff;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=ExponentialHeightFogComponent)
    FExponentialHeightFogData SecondFogData;
 
    UPROPERTY()
    FLinearColor FogInscatteringColor_DEPRECATED;
 
    UPROPERTY(BlueprintReadOnly, interp, Category=ExponentialHeightFogComponent, meta = (DisplayName = "Fog Inscattering Color"))
    FLinearColor FogInscatteringLuminance;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = ExponentialHeightFogComponent)
    FLinearColor SkyAtmosphereAmbientContributionColorScale;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=InscatteringTexture)
    TObjectPtr<class UTextureCube> InscatteringColorCubemap;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=InscatteringTexture, meta=(UIMin = "0", UIMax = "360"))
    float InscatteringColorCubemapAngle;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=InscatteringTexture)
    FLinearColor InscatteringTextureTint;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=InscatteringTexture, meta=(UIMin = "1000", UIMax = "1000000"))
    float FullyDirectionalInscatteringColorDistance;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=InscatteringTexture, meta=(UIMin = "1000", UIMax = "1000000"))
    float NonDirectionalInscatteringColorDistance;
 
    UPROPERTY(BlueprintReadOnly, interp, Category=DirectionalInscattering, meta=(UIMin = "2", UIMax = "64"))
    float DirectionalInscatteringExponent;
 
    UPROPERTY(BlueprintReadOnly, interp, Category=DirectionalInscattering)
    float DirectionalInscatteringStartDistance;
 
    UPROPERTY()
    FLinearColor DirectionalInscatteringColor_DEPRECATED;
 
    UPROPERTY(BlueprintReadOnly, interp, Category=DirectionalInscattering, meta = (DisplayName = "Directional Inscattering Color"))
    FLinearColor DirectionalInscatteringLuminance;
 
    UPROPERTY(BlueprintReadOnly, interp, Category=ExponentialHeightFogComponent, meta=(UIMin = "0", UIMax = "1"))
    float FogMaxOpacity;
 
    UPROPERTY(BlueprintReadOnly, interp, Category=ExponentialHeightFogComponent, meta=(UIMin = "0", UIMax = "5000"))
    float StartDistance;
 
    UPROPERTY(BlueprintReadOnly, interp, Category = ExponentialHeightFogComponent, meta = (UIMin = "0", UIMax = "500000"))
    float EndDistance;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=ExponentialHeightFogComponent, meta=(UIMin = "100000", UIMax = "20000000"))
    float FogCutoffDistance;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = VolumetricFog, meta=(DisplayName = "Volumetric Fog"))
    bool bEnableVolumetricFog;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = VolumetricFog, meta=(DisplayName = "Scattering Distribution", UIMin = "-.9", UIMax = ".9"))
    float VolumetricFogScatteringDistribution;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = VolumetricFog, meta=(DisplayName = "Albedo"))
    FColor VolumetricFogAlbedo;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = VolumetricFog, meta=(DisplayName = "Emissive"))
    FLinearColor VolumetricFogEmissive;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = VolumetricFog, meta=(DisplayName = "Extinction Scale", UIMin = ".1", UIMax = "10"))
    float VolumetricFogExtinctionScale;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = VolumetricFog, meta=(DisplayName = "View Distance", UIMin = "1000", UIMax = "10000"))
    float VolumetricFogDistance;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category= VolumetricFog, meta=(DisplayName = "Start Distance", UIMin = "0", UIMax = "5000"))
    float VolumetricFogStartDistance;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = VolumetricFog, meta=(DisplayName = "Near Fade In Distance", UIMin = "0", UIMax = "1000"))
    float VolumetricFogNearFadeInDistance;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = VolumetricFog, meta=(DisplayName = "Static Lighting Scattering Intensity", UIMin = "0", UIMax = "10"))
    float VolumetricFogStaticLightingScatteringIntensity;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = VolumetricFog, AdvancedDisplay)
    bool bOverrideLightColorsWithFogInscatteringColors;
 
    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 bVisibleInReflectionCaptures : 1;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, BlueprintReadOnly, Category = Rendering)
    uint8 bVisibleInRealTimeSkyCaptures : 1;
 
 
public:
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|ExponentialHeightFog")
    ENGINE_API void SetFogDensity(float Value);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|ExponentialHeightFog")
    ENGINE_API void SetSecondFogDensity(float Value);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|ExponentialHeightFog")
    ENGINE_API void SetFogInscatteringColor(FLinearColor Value);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|ExponentialHeightFog")
    ENGINE_API void SetInscatteringColorCubemap(UTextureCube* Value);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|ExponentialHeightFog")
    ENGINE_API void SetInscatteringColorCubemapAngle(float Value);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|ExponentialHeightFog")
    ENGINE_API void SetFullyDirectionalInscatteringColorDistance(float Value);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|ExponentialHeightFog")
    ENGINE_API void SetNonDirectionalInscatteringColorDistance(float Value);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|ExponentialHeightFog")
    ENGINE_API void SetInscatteringTextureTint(FLinearColor Value);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|ExponentialHeightFog")
    ENGINE_API void SetDirectionalInscatteringExponent(float Value);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|ExponentialHeightFog")
    ENGINE_API void SetDirectionalInscatteringStartDistance(float Value);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|ExponentialHeightFog")
    ENGINE_API void SetDirectionalInscatteringColor(FLinearColor Value);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|ExponentialHeightFog")
    ENGINE_API void SetSecondFogHeightOffset(float Value);
    
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|ExponentialHeightFog")
    ENGINE_API void SetFogHeightFalloff(float Value);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|ExponentialHeightFog")
    ENGINE_API void SetSecondFogHeightFalloff(float Value);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|ExponentialHeightFog")
    ENGINE_API void SetFogMaxOpacity(float Value);
    
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|ExponentialHeightFog")
    ENGINE_API void SetStartDistance(float Value);
    
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|ExponentialHeightFog")
    ENGINE_API void SetEndDistance(float Value);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|ExponentialHeightFog")
    ENGINE_API void SetFogCutoffDistance(float Value);
    
    UFUNCTION(BlueprintCallable, Category="Rendering|VolumetricFog")
    ENGINE_API void SetVolumetricFog(bool bNewValue);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|VolumetricFog")
    ENGINE_API void SetVolumetricFogScatteringDistribution(float NewValue);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|VolumetricFog")
    ENGINE_API void SetVolumetricFogExtinctionScale(float NewValue);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|VolumetricFog")
    ENGINE_API void SetVolumetricFogAlbedo(FColor NewValue);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|VolumetricFog")
    ENGINE_API void SetVolumetricFogEmissive(FLinearColor NewValue);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|VolumetricFog")
    ENGINE_API void SetVolumetricFogDistance(float NewValue);
 
    UFUNCTION(BlueprintCallable, Category = "Rendering|VolumetricFog")
    ENGINE_API void SetVolumetricFogStartDistance(float NewValue);
 
    UFUNCTION(BlueprintCallable, Category = "Rendering|VolumetricFog")
    ENGINE_API void SetVolumetricFogNearFadeInDistance(float NewValue);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|VolumetricFog")
    ENGINE_API void SetSecondFogData(FExponentialHeightFogData 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|DirectionalInscattering")
    ENGINE_API void SetSkyAtmosphereAmbientContributionColorScale(FLinearColor NewValue);
 
protected:
    //~ Begin UActorComponent Interface.
    ENGINE_API virtual void CreateRenderState_Concurrent(FRegisterComponentContext* Context) override;
    ENGINE_API virtual void SendRenderTransform_Concurrent() override;
    ENGINE_API virtual void DestroyRenderState_Concurrent() override;
    //~ End UActorComponent Interface.
 
    ENGINE_API void AddFogIfNeeded();
 
    #if WITH_STATE_STREAM_ACTOR
    FExponentialHeightFogHandle Handle;
    #endif
 
public:
    //~ Begin UObject Interface
#if WITH_EDITOR
    ENGINE_API virtual bool CanEditChange(const FProperty* InProperty) const override;
    ENGINE_API virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif // WITH_EDITOR
    ENGINE_API virtual void Serialize(FArchive& Ar) override;
    //~ End UObject Interface
};