UCompositeLayerPlanarReflection

Layer that renders a planar reflection of selected actors via a mirrored scene capture.

API > API/Plugins > API/Plugins/Composite

Layer that renders a planar reflection of selected actors via a mirrored scene capture. The result is blended as a reflection contribution onto the layer below.

   
Name UCompositeLayerPlanarReflection
Type class
Header File /Engine/Plugins/Compositing/Composite/Source/Composite/Public/Layers/CompositeLayerPlanarReflection.h
Include Path #include "Layers/CompositeLayerPlanarReflection.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, Blueprintable, EditInlineNew, CollapseCategories,  
       Meta=(DisplayName="Planar Reflection"))  
class UCompositeLayerPlanarReflection : public UCompositeLayerBase

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UCompositeLayerPlanarReflection ( const FObjectInitializer& ObjectInitializer
)

 Constructor. Layers/CompositeLayerPlanarReflection.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~UCompositeLayerPlanarReflection()

 Destructor. Layers/CompositeLayerPlanarReflection.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Actors TArray< TSoftObjectPtr< AActor > > List of actors to be rendered from the planar reflection. Layers/CompositeLayerPlanarReflection.h
  • EditAnywhere
  • BlueprintGetter=GetActors
  • BlueprintSetter=SetActors
  • Category="Composite"
  • Meta=(AllowPrivateAccess=true)
bCustomRenderPass bool Convenience toggle to render the planar reflection as a fast/minimal Custom Render Pass, inlined in the main render & without support for lighting. Layers/CompositeLayerPlanarReflection.h
  • EditAnywhere
  • BlueprintGetter=IsCustomRenderPass
  • BlueprintSetter=SetCustomRenderPass
  • Category="Composite"
  • AdvancedDisplay
  • Meta=(AllowPrivateAccess=true)
PlaneHeight float World-space Z coordinate of the horizontal plane for planar reflection. Layers/CompositeLayerPlanarReflection.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Composite"
  • Meta=(AllowPrivateAccess=true)
ReflectionStrength float Strength of the planar reflection. Layers/CompositeLayerPlanarReflection.h
  • EditAnywhere
  • BlueprintGetter=GetReflectionStrength
  • BlueprintSetter=SetReflectionStrength
  • Interp
  • Category="Composite"
  • Meta=(AllowPrivateAccess=true, ClampMin="0.0", ClampMax="1.0", UIMin="0.0", UIMax="1.0")
RenderTargetResolution FIntPoint Render target resolution for the planar reflection. Layers/CompositeLayerPlanarReflection.h
  • EditAnywhere
  • BlueprintGetter=GetRenderTargetResolution
  • BlueprintSetter=SetRenderTargetResolution
  • Interp
  • Category="Composite"
  • Meta=(AllowPrivateAccess=true)
SpawnableBindings FCompositeSpawnableBindings Parallel spawnable binding data for the Actors array. Layers/CompositeLayerPlanarReflection.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

const TArray< TSoftObjectPtr< AActor > > GetActors()

 Get reflection & shadow caster actors. Layers/CompositeLayerPlanarReflection.h
  • BlueprintGetter

float GetReflectionStrength()

 Get the planar reflection strength. Layers/CompositeLayerPlanarReflection.h
  • BlueprintGetter

FIntPoint GetRenderTargetResolution()

 Get the render target resolution for the planar reflection. Layers/CompositeLayerPlanarReflection.h
  • BlueprintGetter

bool IsCustomRenderPass()

 Get whether the planar reflection is rendered as a custom render pass. Layers/CompositeLayerPlanarReflection.h
  • BlueprintGetter

void SetActors ( TArray< TSoftObjectPtr< AActor > > InActors
)

 Set reflection & shadow caster actors. Layers/CompositeLayerPlanarReflection.h
  • BlueprintSetter

void SetCustomRenderPass ( bool bInIsFastRenderPass
)

 Set whether the planar reflection is rendered as a custom render pass. Layers/CompositeLayerPlanarReflection.h
  • BlueprintSetter

void SetReflectionStrength ( float InReflectionStrength
)

 Set the planar reflection strength. Layers/CompositeLayerPlanarReflection.h
  • BlueprintSetter

void SetRenderTargetResolution ( FIntPoint InRenderTargetResolution
)

 Set the render target resolution for the planar reflection. Layers/CompositeLayerPlanarReflection.h
  • BlueprintSetter

Public Virtual

Overridden from UCompositeLayerBase

Name Remarks Include Path Unreal Specifiers

virtual void OnEndOfFrameUpdate ( UWorld* InWorld
)

 End-of-frame update callback. Layers/CompositeLayerPlanarReflection.h  

virtual void OnRemoved ( ACompositeActor* LastOwner
)

 Called when the layer is removed or composite actor is destroyed. Layers/CompositeLayerPlanarReflection.h  

Overridden from UCompositePassBase

Name Remarks Include Path Unreal Specifiers

virtual bool GetIsActive ()

 Returns true if the pass should participate in rendering this frame. Layers/CompositeLayerPlanarReflection.h  

virtual FCompositeCorePassProxy * GetProxy ( const UE::CompositeCore::FPassInputDecl& InputDecl,
FCompositeTraversalContext& InContext,
FSceneRenderingBulkObjectAllocator& InFrameAllocator
) const

 Override to return a render-thread proxy for this layer. Layers/CompositeLayerPlanarReflection.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   Layers/CompositeLayerPlanarReflection.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Layers/CompositeLayerPlanarReflection.h  

virtual void PostEditUndo()

   Layers/CompositeLayerPlanarReflection.h  

virtual void PostTransacted ( const FTransactionObjectEvent& TransactionEvent
)

   Layers/CompositeLayerPlanarReflection.h  

virtual void PreEditChange ( FProperty* PropertyAboutToChange
)

   Layers/CompositeLayerPlanarReflection.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page