LightComponentBase.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 "Misc/Guid.h"
#include "Components/SceneComponent.h"
#include "LightComponentBase.generated.h"
 
class UTexture2D;
 
UCLASS(abstract, HideCategories=(Trigger,Activation,"Components|Activation",Physics), ShowCategories=(Mobility), MinimalAPI)
class ULightComponentBase : public USceneComponent
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY()
    FGuid OriginalLightGuid;
 
    UPROPERTY()
    FGuid LightGuid;
    
    UPROPERTY()
    float Brightness_DEPRECATED;
 
    UPROPERTY(BlueprintReadOnly, interp, Category=Light, meta=(DisplayName = "Intensity", UIMin = "0.0", UIMax = "20.0", ShouldShowInViewport = true))
    float Intensity;
 
    UPROPERTY(BlueprintReadOnly, interp, Category=Light, meta=(HideAlphaChannel, ShouldShowInViewport = true))
    FColor LightColor;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=Light, meta = (ShouldShowInViewport = true))
    uint32 bAffectsWorld:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=Light)
    uint32 CastShadows:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=Light, AdvancedDisplay)
    uint32 CastStaticShadows:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=Light, AdvancedDisplay)
    uint32 CastDynamicShadows:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=Light, AdvancedDisplay)
    uint32 bAffectTranslucentLighting:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Light, AdvancedDisplay, meta = (EditCondition="Mobility==EComponentMobility::Movable"))
    uint32 bTransmission : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Light, AdvancedDisplay)
    uint32 bCastVolumetricShadow : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Light, AdvancedDisplay)
    uint32 bCastDeepShadow : 1;
 
    UPROPERTY()
    uint32 bCastRaytracedShadow_DEPRECATED : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Light, meta = (DisplayName = "Cast Ray Traced Shadows"), AdvancedDisplay)
    TEnumAsByte<ECastRayTracedShadow::Type> CastRaytracedShadow;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Light, AdvancedDisplay, meta = (DisplayName = "Affect Ray Tracing Reflections"))
    uint32 bAffectReflection : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Light, AdvancedDisplay, meta = (DisplayName = "Affect Ray Tracing Global Illumination"))
    uint32 bAffectGlobalIllumination : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Light, AdvancedDisplay, meta = (ClampMin = "0.0", ClampMax = "1.0", UIMin = "0.0", UIMax = "1.0"))
    float DeepShadowLayerDistribution;
 
    UPROPERTY(BlueprintReadOnly, interp, Category=Light, meta=(UIMin = "0.0", UIMax = "6.0"))
    float IndirectLightingIntensity;
 
    UPROPERTY(BlueprintReadOnly, interp, Category=Light, meta=(UIMin = "0.25", UIMax = "4.0"))
    float VolumetricScatteringIntensity;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = RayTracing)
    int SamplesPerPixel;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(transient)
    TObjectPtr<UTexture2D> StaticEditorTexture;
 
    UPROPERTY(transient)
    float StaticEditorTextureScale;
 
    UPROPERTY(transient)
    TObjectPtr<UTexture2D> DynamicEditorTexture;
 
    UPROPERTY(transient)
    float DynamicEditorTextureScale;
#endif
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|Light")
    ENGINE_API void SetCastShadows(bool bNewValue);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|Light")
    ENGINE_API FLinearColor GetLightColor() const;
 
    UFUNCTION(BlueprintCallable, Category = "Rendering|Components|Light")
    ENGINE_API void SetCastVolumetricShadow(bool bNewValue);
 
    UFUNCTION(BlueprintCallable, Category = "Rendering|Components|Light")
    ENGINE_API void SetCastDeepShadow(bool bNewValue);
 
    UFUNCTION(BlueprintCallable, Category = "Rendering|Components|Light")
    ENGINE_API void SetAffectReflection(bool bNewValue);
 
    UFUNCTION(BlueprintCallable, Category = "Rendering|Components|Light")
    ENGINE_API void SetAffectGlobalIllumination(bool bNewValue);
 
    UFUNCTION(BlueprintCallable, Category = "Rendering|Components|Light", meta = (DeprecatedFunction, DeprecationMessage = "ULightComponentBase::SetCastRaytracedShadow is deprecated. Use ULightComponentBase::SetCastRaytracedShadows instead."))
    ENGINE_API void SetCastRaytracedShadow(bool bNewValue);
 
    UFUNCTION(BlueprintCallable, Category = "Rendering|Components|Light")
    ENGINE_API void SetCastRaytracedShadows(ECastRayTracedShadow::Type bNewValue);
 
    UFUNCTION(BlueprintCallable, Category = "Rendering|Components|Light")
    ENGINE_API void SetSamplesPerPixel(int NewValue);
 
    ENGINE_API virtual void Serialize(FArchive& Ar) override;
 
    ENGINE_API virtual void PostDuplicate(EDuplicateMode::Type DuplicateMode) override;
 
#if WITH_EDITOR
    ENGINE_API virtual void PostEditImport() override;
    ENGINE_API virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
 
    UTexture2D* GetEditorSprite() const
    {
        return (Mobility == EComponentMobility::Movable) ? DynamicEditorTexture : StaticEditorTexture;
    }
 
    float GetEditorSpriteScale() const
    {
        return (Mobility == EComponentMobility::Movable) ? DynamicEditorTextureScale : StaticEditorTextureScale;
    }
 
    ENGINE_API virtual void UpdateLightSpriteTexture();
#endif
 
    ENGINE_API void ValidateLightGUIDs();
 
    ENGINE_API virtual void UpdateLightGUIDs();
 
    bool IsMovable() const
    {
        return (Mobility == EComponentMobility::Movable);
    }
 
    ENGINE_API bool HasStaticLighting() const;
 
    ENGINE_API bool HasStaticShadowing() const;
 
#if WITH_EDITOR
    ENGINE_API virtual void PostLoad() override;
 
    ENGINE_API virtual void OnRegister() override;
    ENGINE_API virtual void OnUnregister() override;
    ENGINE_API virtual bool CanEditChange(const FProperty* InProperty) const override;
#endif
 
    ENGINE_API virtual bool ShouldCollideWhenPlacing() const override;
 
    ENGINE_API virtual FBoxSphereBounds GetPlacementExtent() const override;
};