PlanarReflectionComponent.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 "RenderCommandFence.h"
#include "Components/SceneCaptureComponent.h"
#include "PlanarReflectionComponent.generated.h"
 
UCLASS(hidecategories=(Collision, Object, Physics, SceneComponent), ClassGroup=Rendering, MinimalAPI, editinlinenew, meta=(BlueprintSpawnableComponent))
class UPlanarReflectionComponent : public USceneCaptureComponent
{
    GENERATED_UCLASS_BODY()
 
    UPROPERTY()
    TObjectPtr<class UBoxComponent> PreviewBox;
 
public:
 
    UPROPERTY(EditAnywhere, Category=PlanarReflection, meta=(UIMin = "0", UIMax = "1000.0"))
    float NormalDistortionStrength;
 
    UPROPERTY(EditAnywhere, Category=PlanarReflection, meta=(UIMin = "0", UIMax = ".04"))
    float PrefilterRoughness;
 
    UPROPERTY(EditAnywhere, Category=PlanarReflection, meta=(UIMin = "0", UIMax = "100000"), AdvancedDisplay)
    float PrefilterRoughnessDistance;
 
    UPROPERTY(EditAnywhere, Category=PlanarReflection, meta=(UIMin = "25", UIMax = "100"), AdvancedDisplay)
    int32 ScreenPercentage;
 
    UPROPERTY(EditAnywhere, Category=PlanarReflection, meta=(UIMin = "0", UIMax = "10.0"), AdvancedDisplay)
    float ExtraFOV;
 
    UPROPERTY()
    float DistanceFromPlaneFadeStart_DEPRECATED;
 
    UPROPERTY()
    float DistanceFromPlaneFadeEnd_DEPRECATED;
 
    UPROPERTY(EditAnywhere, Category=PlanarReflection, meta=(UIMin = "0", UIMax = "1500.0"))
    float DistanceFromPlaneFadeoutStart;
 
    UPROPERTY(EditAnywhere, Category=PlanarReflection, meta=(UIMin = "0", UIMax = "1500.0"))
    float DistanceFromPlaneFadeoutEnd;
 
    UPROPERTY(EditAnywhere, Category=PlanarReflection, meta=(UIMin = "0", UIMax = "90.0"))
    float AngleFromPlaneFadeStart;
 
    UPROPERTY(EditAnywhere, Category = PlanarReflection, meta = (UIMin = "0", UIMax = "90.0"))
    float AngleFromPlaneFadeEnd;
 
    UPROPERTY(EditAnywhere, Category = PlanarReflection)
    bool bShowPreviewPlane;
 
    UPROPERTY(EditAnywhere, Category = PlanarReflection, AdvancedDisplay)
    bool bRenderSceneTwoSided;
 
    //~ Begin UObject Interface
    virtual void Serialize(FArchive& Ar) override;
    virtual void BeginDestroy() override;
    virtual bool IsReadyForFinishDestroy() override;
    virtual void FinishDestroy() override;
    //~ End UObject Interface
 
    //~ Begin UActorComponent Interface
    virtual void CreateRenderState_Concurrent(FRegisterComponentContext* Context) override;
    virtual void SendRenderTransform_Concurrent() override;
    virtual void DestroyRenderState_Concurrent() override;
    virtual void OnRegister() override;
    //~ Begin UActorComponent Interface
 
#if WITH_EDITOR
    virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif
 
    void UpdatePreviewShape();
 
    void GetProjectionWithExtraFOV(FMatrix& OutMatrix, const uint32 StereoIndex) const
    {
        check(StereoIndex < 2);
        OutMatrix = ProjectionWithExtraFOV[StereoIndex];
    }
 
    int32 GetPlanarReflectionId() const
    {
        return PlanarReflectionId;
    }
 
    bool ShouldComponentAddToScene() const;
 
protected:
#if WITH_EDITORONLY_DATA
    FSoftObjectPath CaptureMaterialPath;
 
#endif
 
private:
 
    FRenderCommandFence ReleaseResourcesFence;
 
    class FPlanarReflectionSceneProxy* SceneProxy;
 
    class FPlanarReflectionRenderTarget* RenderTarget;
 
    FMatrix ProjectionWithExtraFOV[2];
 
    int32 PlanarReflectionId;
 
    friend class FScene;
};