SceneCaptureComponent2D.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 "UObject/ScriptInterface.h"
#include "Engine/BlendableInterface.h"
#include "Camera/CameraTypes.h"
#include "Components/SceneCaptureComponent.h"
#include "SceneCaptureComponent2D.generated.h"
 
class ISceneViewExtension;
class FSceneInterface;
 
UENUM()
enum class ESceneCaptureUnlitViewmode : uint8
{
    Disabled,
 
    Capture,
 
    CaptureOrCustomRenderPass
};
 
UCLASS(hidecategories=(Collision, Object, Physics, SceneComponent), ClassGroup=Rendering, editinlinenew, meta=(BlueprintSpawnableComponent), MinimalAPI)
class USceneCaptureComponent2D : public USceneCaptureComponent
{
    GENERATED_UCLASS_BODY()
        
public:
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Projection, meta=(DisplayName = "Projection Type"))
    TEnumAsByte<ECameraProjectionMode::Type> ProjectionType;
 
    UPROPERTY(interp, EditAnywhere, BlueprintReadWrite, Category=Projection, meta=(DisplayName = "Field of View", UIMin = "5.0", UIMax = "170", ClampMin = "0.001", ClampMax = "360.0", editcondition = "ProjectionType==0"))
    float FOVAngle;
 
    UPROPERTY(Interp, EditAnywhere, BlueprintReadWrite, Category=Projection, meta = (UIMin = "5.0", UIMax = "170", ClampMin = "0.001", ClampMax = "360.0", Units = deg, EditCondition = "bEnableFirstPersonFieldOfView"))
    float FirstPersonFieldOfView;
 
    UPROPERTY(Interp, EditAnywhere, BlueprintReadWrite, Category=Projection, meta=(UIMin = "0.001", UIMax = "1.0", ClampMin = "0.001", ClampMax = "1.0", EditCondition = "bEnableFirstPersonScale"))
    float FirstPersonScale;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Projection, meta = (editcondition = "ProjectionType==1"))
    float OrthoWidth;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Projection, meta = (editcondition = "ProjectionType==1"))
    bool bAutoCalculateOrthoPlanes;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Projection, meta = (editcondition = "ProjectionType==1 && bAutoCalculateOrthoPlanes"))
    float AutoPlaneShift;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Projection, meta = (editcondition = "ProjectionType==1"))
    bool bUpdateOrthoPlanes;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Projection, meta = (editcondition = "ProjectionType==1 && bUpdateOrthoPlanes"))
    bool bUseCameraHeightAsViewTarget;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Projection, meta = (UIMin="0.0", ClampMin="0.0", UIMax="1.0", ClampMax="1.0"))
    float Overscan;
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=SceneCapture)
    TObjectPtr<class UTextureRenderTarget2D> TextureTarget;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=SceneCapture)
    TEnumAsByte<enum ESceneCaptureCompositeMode> CompositeMode;
 
    UPROPERTY(interp, Category=PostProcessVolume, meta=(ShowOnlyInnerProperties))
    struct FPostProcessSettings PostProcessSettings;
 
    UPROPERTY(interp, Category=PostProcessVolume, BlueprintReadWrite, meta=(UIMin = "0.0", UIMax = "1.0"))
    float PostProcessBlendWeight;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Projection, meta = (InlineEditConditionToggle))
    uint32 bOverride_CustomNearClippingPlane : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, AdvancedDisplay, Category = Projection, meta = (editcondition = "bOverride_CustomNearClippingPlane"))
    float CustomNearClippingPlane = 0;
 
    UPROPERTY(BlueprintReadWrite, AdvancedDisplay, Category = Projection)
    bool bUseCustomProjectionMatrix;
 
    UPROPERTY(BlueprintReadWrite, AdvancedDisplay, Category = Projection)
    FMatrix CustomProjectionMatrix;
 
    UPROPERTY(meta = (DeprecatedProperty, DeprecationMessage = "5.4 - bUseFauxOrthoViewPos has been deprecated alongside updates to Orthographic camera fixes"))
    bool bUseFauxOrthoViewPos = false;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, AdvancedDisplay, Category = Projection, meta = (editcondition = "ProjectionType==1"))
    bool bEnableOrthographicTiling = false;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, AdvancedDisplay, Category = Projection, meta = (ClampMin = "1", ClampMax = "64", editcondition = "ProjectionType==1 && bEnableOrthographicTiling"))
    int32 NumXTiles = 4;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, AdvancedDisplay, Category = Projection, meta = (ClampMin = "1", ClampMax = "64", editcondition = "ProjectionType==1 && bEnableOrthographicTiling"))
    int32 NumYTiles = 4;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, AdvancedDisplay, Category=SceneCapture)
    bool bEnableClipPlane;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, AdvancedDisplay, Category=SceneCapture)
    FVector ClipPlaneBase;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, AdvancedDisplay, Category=SceneCapture)
    FVector ClipPlaneNormal;
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=PassInfo, meta = (EditCondition = "CaptureSource == ESceneCaptureSource::SCS_SceneDepth || CaptureSource == ESceneCaptureSource::SCS_DeviceDepth || CaptureSource == ESceneCaptureSource::SCS_BaseColor || CaptureSource == ESceneCaptureSource::SCS_Normal || CaptureSource == ESceneCaptureSource::SCS_SceneColorHDR || CaptureSource == ESceneCaptureSource::SCS_SceneColorHDRNoAlpha || CaptureSource == ESceneCaptureSource::SCS_SceneColorSceneDepth"))
    bool bRenderInMainRenderer = false;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=PassInfo)
    ESceneCaptureUnlitViewmode UnlitViewmode = ESceneCaptureUnlitViewmode::Capture;
 
    UPROPERTY(Transient, BlueprintReadWrite, Category = SceneCapture)
    uint32 bCameraCutThisFrame : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Projection)
    uint32 bEnableFirstPersonFieldOfView : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Projection)
    uint32 bEnableFirstPersonScale : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = SceneCapture, meta = (DisplayName = "Fog only on rendered pixels"))
    uint32 bConsiderUnrenderedOpaquePixelAsFullyTranslucent : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=PassInfo)
    uint32 bMainViewFamily : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = PassInfo)
    uint32 bMainViewResolution : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=PassInfo)
    uint32 bMainViewCamera : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = PassInfo, meta = (EditCondition = "bMainViewCamera"))
    uint32 bInheritMainViewCameraPostProcessSettings : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = PassInfo)
    uint32 bIgnoreScreenPercentage : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=PassInfo, meta = (EditCondition = "bMainViewResolution || bMainViewCamera"))
    FIntPoint MainViewResolutionDivisor = { 1, 1 };
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=PassInfo, meta = (EditCondition = "bRenderInMainRenderer && (CaptureSource == ESceneCaptureSource::SCS_SceneDepth || CaptureSource == ESceneCaptureSource::SCS_DeviceDepth || CaptureSource == ESceneCaptureSource::SCS_BaseColor || CaptureSource == ESceneCaptureSource::SCS_Normal || CaptureSource == ESceneCaptureSource::SCS_SceneColorHDR || CaptureSource == ESceneCaptureSource::SCS_SceneColorHDRNoAlpha || CaptureSource == ESceneCaptureSource::SCS_SceneColorSceneDepth)"))
    FName UserSceneTextureBaseColor;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=PassInfo, meta = (EditCondition = "bRenderInMainRenderer && (CaptureSource == ESceneCaptureSource::SCS_SceneDepth || CaptureSource == ESceneCaptureSource::SCS_DeviceDepth || CaptureSource == ESceneCaptureSource::SCS_BaseColor || CaptureSource == ESceneCaptureSource::SCS_Normal || CaptureSource == ESceneCaptureSource::SCS_SceneColorHDR || CaptureSource == ESceneCaptureSource::SCS_SceneColorHDRNoAlpha || CaptureSource == ESceneCaptureSource::SCS_SceneColorSceneDepth)"))
    FName UserSceneTextureNormal;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=PassInfo, meta = (EditCondition = "bRenderInMainRenderer && (CaptureSource == ESceneCaptureSource::SCS_SceneDepth || CaptureSource == ESceneCaptureSource::SCS_DeviceDepth || CaptureSource == ESceneCaptureSource::SCS_BaseColor || CaptureSource == ESceneCaptureSource::SCS_Normal || CaptureSource == ESceneCaptureSource::SCS_SceneColorHDR || CaptureSource == ESceneCaptureSource::SCS_SceneColorHDRNoAlpha || CaptureSource == ESceneCaptureSource::SCS_SceneColorSceneDepth)"))
    FName UserSceneTextureSceneColor;
 
    inline bool ShouldRenderInMainRenderer() const
    {
        return bRenderInMainRenderer && (CaptureSource == ESceneCaptureSource::SCS_SceneDepth || CaptureSource == ESceneCaptureSource::SCS_DeviceDepth || CaptureSource == ESceneCaptureSource::SCS_BaseColor || CaptureSource == ESceneCaptureSource::SCS_Normal || CaptureSource == ESceneCaptureSource::SCS_SceneColorHDR || CaptureSource == ESceneCaptureSource::SCS_SceneColorHDRNoAlpha || CaptureSource == ESceneCaptureSource::SCS_SceneColorSceneDepth);
    }
 
    inline bool ShouldRenderWithMainViewResolution() const
    {
        return bMainViewResolution || bMainViewCamera || (ShouldRenderInMainRenderer() && (!UserSceneTextureBaseColor.IsNone() || !UserSceneTextureNormal.IsNone() || !UserSceneTextureSceneColor.IsNone()));
    }
 
    inline bool ShouldRenderWithMainViewFamily() const
    {
        return bMainViewFamily || ShouldRenderWithMainViewResolution();
    }
 
    inline bool ShouldRenderWithMainViewCamera() const
    {
        return bMainViewCamera;
    }
 
    inline bool ShouldIgnoreScreenPercentage() const
    {
        // User Scene Texture outputs are always in the scaled view resolution, so ignore the bIgnoreScreenPercentage flag if either is set
        return ShouldRenderInMainRenderer() ? bIgnoreScreenPercentage && UserSceneTextureBaseColor.IsNone() && UserSceneTextureNormal.IsNone() && UserSceneTextureSceneColor.IsNone() : bIgnoreScreenPercentage;
    }
 
    TArray< TWeakPtr<ISceneViewExtension, ESPMode::ThreadSafe> > SceneViewExtensions;
 
    int32 TileID = 0;
 
    const FSceneViewFamily* MainViewFamily = nullptr;
 
    //~ Begin UActorComponent Interface
    ENGINE_API virtual void OnComponentDestroyed(bool bDestroyingHierarchy) override;
    ENGINE_API virtual void OnRegister() override;
    ENGINE_API virtual void SendRenderTransform_Concurrent() override;
    virtual bool RequiresGameThreadEndOfFrameUpdates() const override
    {
        // this method could probably be removed allowing them to run on any thread, but it isn't worth the trouble
        return true;
    }
    ENGINE_API virtual void TickComponent(float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction *ThisTickFunction) override;
 
    ENGINE_API void ResetOrthographicTilingCounter();
 
    //~ End UActorComponent Interface
 
    //~ 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
 
    static ENGINE_API void AddReferencedObjects(UObject* InThis, FReferenceCollector& Collector);
    ENGINE_API virtual void Serialize(FArchive& Ar);
 
    //~ End UObject Interface
 
    ENGINE_API void SetCameraView(const FMinimalViewInfo& DesiredView);
 
    ENGINE_API virtual void GetCameraView(float DeltaTime, FMinimalViewInfo& OutDesiredView);
 
    UFUNCTION(BlueprintCallable, Category="Rendering")
    void AddOrUpdateBlendable(TScriptInterface<IBlendableInterface> InBlendableObject, float InWeight = 1.0f) { PostProcessSettings.AddBlendable(InBlendableObject, InWeight); }
 
    UFUNCTION(BlueprintCallable, Category = "Rendering")
    void RemoveBlendable(TScriptInterface<IBlendableInterface> InBlendableObject) { PostProcessSettings.RemoveBlendable(InBlendableObject); }
 
    ENGINE_API void CaptureSceneDeferred();
 
    // For backwards compatibility
    void UpdateContent() { CaptureSceneDeferred(); }
 
    UFUNCTION(BlueprintCallable,Category = "Rendering|SceneCapture")
    ENGINE_API void CaptureScene();
 
    ENGINE_API void UpdateSceneCaptureContents(FSceneInterface* Scene, ISceneRenderBuilder& SceneRenderBuilder) override;
 
    /* Return if orthographic tiling rendering is enabled or not */
    ENGINE_API bool GetEnableOrthographicTiling() const;
 
    /* Return number of X tiles to render (to be used when orthographic tiling rendering is enabled) */
    ENGINE_API int32 GetNumXTiles() const;
 
    /* Return number of Y tiles to render (to be used when orthographic tiling rendering is enabled) */
    ENGINE_API int32 GetNumYTiles() const;
 
    virtual bool Is2D() const override { return true; }
 
#if WITH_EDITORONLY_DATA
    ENGINE_API void UpdateDrawFrustum();
 
    TObjectPtr<class UDrawFrustumComponent> DrawFrustum;
#endif
};