DirectionalLightComponent.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Engine/EngineTypes.h"
#include "Components/LightComponent.h"
 
#include "DirectionalLightComponent.generated.h"
 
class FLightSceneProxy;
 
UCLASS(Blueprintable, ClassGroup=Lights, hidecategories=(Object, LightProfiles), editinlinenew, meta=(BlueprintSpawnableComponent), MinimalAPI)
class UDirectionalLightComponent : public ULightComponent
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = Light, AdvancedDisplay, meta = (UIMin = "0", UIMax = "1"))
    float ShadowCascadeBiasDistribution;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category=LightShafts, meta=(DisplayName = "Light Shaft Occlusion"))
    uint32 bEnableLightShaftOcclusion:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category=LightShafts, meta=(UIMin = "0", UIMax = "1"))
    float OcclusionMaskDarkness;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category=LightShafts, meta=(UIMin = "0", UIMax = "500000"))
    float OcclusionDepthRange;
 
    UPROPERTY(EditAnywhere, interp, AdvancedDisplay, BlueprintReadOnly, Category=LightShafts)
    FVector LightShaftOverrideDirection;
 
    UPROPERTY()
    float WholeSceneDynamicShadowRadius_DEPRECATED;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category=CascadedShadowMaps, meta=(UIMin = "0", UIMax = "20000", DisplayName = "Dynamic Shadow Distance MovableLight"))
    float DynamicShadowDistanceMovableLight;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category=CascadedShadowMaps, meta=(UIMin = "0", UIMax = "20000", DisplayName = "Dynamic Shadow Distance StationaryLight"))
    float DynamicShadowDistanceStationaryLight;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category=CascadedShadowMaps, meta=(UIMin = "0", UIMax = "4", DisplayName = "Num Dynamic Shadow Cascades"))
    int32 DynamicShadowCascades;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category=CascadedShadowMaps, meta=(UIMin = "1", UIMax = "4", DisplayName = "Distribution Exponent"))
    float CascadeDistributionExponent;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category=CascadedShadowMaps, meta=(UIMin = "0", UIMax = "0.3", DisplayName = "Transition Fraction"))
    float CascadeTransitionFraction;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category=CascadedShadowMaps, meta=(UIMin = "0", UIMax = "1.0", DisplayName = "Distance Fadeout Fraction"))
    float ShadowDistanceFadeoutFraction;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, BlueprintReadOnly, Category=CascadedShadowMaps, DisplayName = "Inset Shadows For Movable Objects")
    uint32 bUseInsetShadowsForMovableObjects : 1;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, BlueprintReadOnly, Category=CascadedShadowMaps, meta=(UIMin = "0", UIMax = "4"), DisplayName = "Far Shadow Cascade Count")
    int32 FarShadowCascadeCount;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, BlueprintReadOnly, Category=CascadedShadowMaps, meta=(UIMin = "0", UIMax = "800000"), DisplayName = "Far Shadow Distance")
    float FarShadowDistance;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=DistanceFieldShadows, meta=(UIMin = "0", UIMax = "100000"), DisplayName = "DistanceField Shadow Distance")
    float DistanceFieldShadowDistance;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, BlueprintReadOnly, Category = Light, meta = (UIMin = "0", ClampMin = "0"))
    int32 ForwardShadingPriority;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category=Light, meta=(UIMin = "0", UIMax = "5"), DisplayName = "Source Angle")
    float LightSourceAngle;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category=Light, meta=(UIMin = "0", UIMax = "5"), DisplayName = "Source Soft Angle")
    float LightSourceSoftAngle;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = RayTracing, meta = (UIMin = "0", UIMax = "5"), DisplayName = "Shadow Source Angle Factor")
    float ShadowSourceAngleFactor;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, BlueprintReadOnly, Category=DistanceFieldShadows, meta=(UIMin = "1000", UIMax = "100000"), DisplayName = "DistanceField Trace Distance")
    float TraceDistance;
 
    UPROPERTY()
    uint32 bUsedAsAtmosphereSunLight_DEPRECATED : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category= AtmosphereAndCloud, meta=(DisplayName = "Atmosphere Sun Light", ShouldShowInViewport = true))
    uint32 bAtmosphereSunLight : 1;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, BlueprintReadOnly, Category = AtmosphereAndCloud, meta = (DisplayName = "Atmosphere Sun Light Index", UIMin = "0", UIMax = "1", ClampMin = "0", ClampMax= "1"))
    int32 AtmosphereSunLightIndex;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = AtmosphereAndCloud, AdvancedDisplay, meta = (DisplayName = "Atmosphere Sun Disk Color Scale"))
    FLinearColor AtmosphereSunDiskColorScale;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = AtmosphereAndCloud, AdvancedDisplay)
    uint32 bPerPixelAtmosphereTransmittance : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = AtmosphereAndCloud)
    uint32 bCastShadowsOnClouds : 1;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = AtmosphereAndCloud)
    uint32 bCastShadowsOnAtmosphere : 1;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = AtmosphereAndCloud)
    uint32 bCastCloudShadows : 1;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = AtmosphereAndCloud, AdvancedDisplay, meta = (UIMin = "0", UIMax = "1", ClampMin = "0", SliderExponent = 1.0))
    float CloudShadowStrength;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = AtmosphereAndCloud, AdvancedDisplay, meta = (UIMin = "0", UIMax = "1", ClampMin = "0", SliderExponent = 1.0))
    float CloudShadowOnAtmosphereStrength;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = AtmosphereAndCloud, AdvancedDisplay, meta = (UIMin = "0", UIMax = "1", ClampMin = "0", SliderExponent = 1.0))
    float CloudShadowOnSurfaceStrength;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = AtmosphereAndCloud, AdvancedDisplay, meta = (UIMin = "-1", UIMax = "1"))
    float CloudShadowDepthBias;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = AtmosphereAndCloud, AdvancedDisplay, meta = (UIMin = "1", ClampMin = "1"))
    float CloudShadowExtent;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = AtmosphereAndCloud, AdvancedDisplay, meta = (UIMin = "0.25", UIMax = "8", ClampMin = "0.25", SliderExponent = 1.0))
    float CloudShadowMapResolutionScale;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = AtmosphereAndCloud, AdvancedDisplay, meta = (UIMin = "0.25", UIMax = "8", ClampMin = "0.25", SliderExponent = 1.0))
    float CloudShadowRaySampleCountScale;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, interp, Category = AtmosphereAndCloud, meta = (HideAlphaChannel))
    FLinearColor CloudScatteredLuminanceScale;
 
    UPROPERTY(EditAnywhere, Category=Light, meta=(ShowOnlyInnerProperties))
    struct FLightmassDirectionalLightSettings LightmassSettings;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Light, AdvancedDisplay, meta = (EditCondition = "Mobility == EComponentMobility::Stationary"))
    uint32 bCastModulatedShadows : 1;
 
    UPROPERTY(BlueprintReadOnly, interp, Category = Light, meta = (HideAlphaChannel), AdvancedDisplay)
    FColor ModulatedShadowColor;
    
    UPROPERTY(BlueprintReadOnly, interp, Category = Light, meta = (HideAlphaChannel, UIMin = "0", UIMax = "1", ClampMin = "0", ClampMax = "1"), AdvancedDisplay)
    float ShadowAmount;
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Lighting")
    ENGINE_API void SetDynamicShadowDistanceMovableLight(float NewValue);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Lighting")
    ENGINE_API void SetDynamicShadowDistanceStationaryLight(float NewValue);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Lighting")
    ENGINE_API void SetDynamicShadowCascades(int32 NewValue);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Lighting")
    ENGINE_API void SetCascadeDistributionExponent(float NewValue);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Lighting")
    ENGINE_API void SetCascadeTransitionFraction(float NewValue);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Lighting")
    ENGINE_API void SetShadowDistanceFadeoutFraction(float NewValue);
 
    UFUNCTION(BlueprintCallable, Category = "Rendering|Lighting")
    ENGINE_API void SetShadowCascadeBiasDistribution(float NewValue);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Lighting")
    ENGINE_API void SetEnableLightShaftOcclusion(bool bNewValue);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Lighting")
    ENGINE_API void SetOcclusionMaskDarkness(float NewValue);
 
    UFUNCTION(BlueprintCallable, Category = "Rendering|Lighting")
    ENGINE_API void SetOcclusionDepthRange(float NewValue);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Lighting")
    ENGINE_API void SetLightShaftOverrideDirection(FVector NewValue);
 
    UFUNCTION(BlueprintCallable, Category = "Rendering|Lighting")
    ENGINE_API void SetLightSourceAngle(float NewValue);
 
    UFUNCTION(BlueprintCallable, Category = "Rendering|Lighting")
    ENGINE_API void SetLightSourceSoftAngle(float NewValue);
 
    UFUNCTION(BlueprintCallable, Category = "Rendering|Lighting")
    ENGINE_API void SetShadowSourceAngleFactor(float NewValue);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Lighting")
    ENGINE_API void SetShadowAmount(float NewValue);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Lighting")
    ENGINE_API void SetAtmosphereSunLight(bool bNewValue);
 
    UFUNCTION(BlueprintCallable, Category = "Rendering|Lighting")
    ENGINE_API void SetAtmosphereSunLightIndex(int32 NewValue);
 
    UFUNCTION(BlueprintCallable, Category = "Rendering|Lighting")
    ENGINE_API void SetAtmosphereSunDiskColorScale(FLinearColor NewValue);
 
    UFUNCTION(BlueprintCallable, Category = "Rendering|Lighting")
    ENGINE_API void SetForwardShadingPriority(int32 NewValue);
 
    //~ Begin ULightComponent Interface
    ENGINE_API virtual FVector4 GetLightPosition() const override;
    ENGINE_API virtual ELightComponentType GetLightType() const override;
    virtual FLightmassLightSettings GetLightmassSettings() const override
    {
        return LightmassSettings;
    }
 
    ENGINE_API virtual float GetUniformPenumbraSize() const override;
 
    ENGINE_API virtual FLightSceneProxy* CreateSceneProxy() const override;
    virtual bool IsUsedAsAtmosphereSunLight() const override
    {
        return bAtmosphereSunLight; 
    }
    virtual uint8 GetAtmosphereSunLightIndex() const override
    {
        return static_cast<uint8>(AtmosphereSunLightIndex);
    }
    virtual FLinearColor GetAtmosphereSunDiskColorScale() const override
    {
        return AtmosphereSunDiskColorScale;
    }
    ENGINE_API virtual ELightUnits GetLightUnits() const;
    //~ End ULightComponent Interface
 
    //~ Begin UObject Interface
#if WITH_EDITOR
    ENGINE_API virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
    ENGINE_API virtual bool CanEditChange(const FProperty* InProperty) const override;
    virtual bool ForceActorNonSpatiallyLoaded() const override { return true; }
#endif // WITH_EDITOR
    ENGINE_API virtual void Serialize(FArchive& Ar) override;
    //~ Begin UObject Interface
 
    ENGINE_API virtual void InvalidateLightingCacheDetailed(bool bInvalidateBuildEnqueuedLighting, bool bTranslationOnly) override;
};