LocalFogVolumeComponent.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 "Math/Color.h"
#include "LocalFogVolumeComponent.generated.h"
 
class FLocalFogVolumeSceneProxy;
 
UCLASS(ClassGroup = Rendering, collapsecategories, hidecategories = (Object, Mobility, Activation, "Components|Activation"), editinlinenew, meta = (BlueprintSpawnableComponent), MinimalAPI)
class ULocalFogVolumeComponent : public USceneComponent
{
    GENERATED_UCLASS_BODY()
 
    ~ULocalFogVolumeComponent();
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Radial Fog Distribution", meta = (DisplayName = "Radial Fog Density", UIMin = "0", UIMax = "2.0", SliderExponent = 2.0, ClampMin = 0.0))
    float RadialFogExtinction = 1.0f;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Height Fog Distribution", meta = (DisplayName = "Height Fog Density", UIMin = "0", UIMax = "2.0", SliderExponent = 2.0, ClampMin = 0.0))
    float HeightFogExtinction = 1.0f;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Height Fog Distribution", meta = (UIMin = "1.0", UIMax = "5000", SliderExponent = 2.0, ClampMin = 1.0))
    float HeightFogFalloff = 1000.0f;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Height Fog Distribution", meta = (UIMin = "-2.0", UIMax = "2.0"))
    float HeightFogOffset = 0.0f;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Shading", meta = (DisplayName = "Scattering Distribution", UIMin = "0.0", UIMax = "0.999", ClampMin = 0.0, ClampMax = 0.999))
    float FogPhaseG = 0.2f;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Shading", meta = (ClampMin = 0.0, ClampMax = 1.0))
    FLinearColor FogAlbedo = FLinearColor::White;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = "Shading", meta = (ClampMin = 0.0, ClampMax = 1.0))
    FLinearColor FogEmissive = FLinearColor::Black;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Sorting", meta = (UIMin = "-127", UIMax = "127", ClampMin = -127, ClampMax = 127))
    int32 FogSortPriority = 0;
    
    UFUNCTION(BlueprintCallable, Category = "Rendering", meta = (DisplayName = "Set Radial Fog Density"))
    ENGINE_API void SetRadialFogExtinction(float NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering", meta = (DisplayName = "Set Height Fog Density"))
    ENGINE_API void SetHeightFogExtinction(float NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetHeightFogFalloff(float NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetHeightFogOffset(float NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering", meta = (DisplayName = "Set Scattering Distribution"))
    ENGINE_API void SetFogPhaseG(float NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetFogAlbedo(FLinearColor NewValue);
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    ENGINE_API void SetFogEmissive(FLinearColor NewValue);
 
public:
 
    static float GetBaseVolumeSize()
    {
        return 500.0f; // This is immutable and cannot be changed without transform data conversion of the component.
    }
 
    //~ Begin UObject Interface
#if WITH_EDITOR
    virtual bool CanEditChange(const FProperty* InProperty) const override;
    virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif // WITH_EDITOR
    //~ End UObject Interface
 
    ENGINE_API FLocalFogVolumeSceneProxy* CreateSceneProxy();
 
protected:
    //~ Begin UActorComponent Interface.
    virtual void CreateRenderState_Concurrent(FRegisterComponentContext* Context) override;
    virtual void SendRenderTransform_Concurrent() override;
    virtual void DestroyRenderState_Concurrent() override;
    //~ End UActorComponent Interface.
 
    void SendRenderTransformCommand();
 
private:
 
    FLocalFogVolumeSceneProxy* LocalFogVolumeSceneProxy;
};