UPlanarReflectionComponent

Inheritance Hierarchy

Syntax

class UPlanarReflectionComponent : public USceneCaptureComponent

Remarks

Variables

Name Description

Public variable

float

 

AngleFromPlaneFadeEnd

Receiving pixels whose normal is at this angle from the reflection plane will have completely faded out the planar reflection.

Public variable

float

 

AngleFromPlaneFadeStart

Receiving pixels whose normal is at this angle from the reflection plane will begin to fade out the planar reflection.

Public variable

bool

 

bRenderSceneTwoSided

Whether to render the scene as two-sided, which can be useful to hide artifacts where normal distortion would read 'under' an object that has been clipped by the reflection plane.

Public variable

float

 

DistanceFromPlaneFadeoutEnd

Receiving pixels at this distance from the reflection plane will have completely faded out the planar reflection.

Public variable

float

 

DistanceFromPlaneFadeoutStart

Receiving pixels at this distance from the reflection plane will begin to fade out the planar reflection.

Public variable

float

 

ExtraFOV

Additional FOV used when rendering to the reflection texture.

Public variable

float

 

NormalDistortionStrength

Controls the strength of normals when distorting the planar reflection.

Public variable

float

 

PrefilterRoughness

The roughness value to prefilter the planar reflection texture with, useful for hiding low resolution.

Public variable

float

 

PrefilterRoughnessDistance

The distance at which the prefilter roughness value will be achieved.

Public variable

UBoxComponent &...

 

PreviewBox

Public variable

int32

 

ScreenPercentage

Downsample percent, can be used to reduce GPU time rendering the planar reflection.

Constructors

Name Description

Public function

UPlanarReflectionComponent

(
    const FObjectInitializer & ObjectIn...
)

Functions

Name Description

Public function

int32

 

GetPlanarReflectionId()

Public function

void

 

GetProjectionWithExtraFOV

(
    FMatrix & OutMatrix,
    const uint32 StereoIndex
)

Public function

FVector4

 

GetScreenScaleBias

(
    const uint32 StereoIndex
)

Public function

void

 

UpdatePreviewShape()

Overridden from UActorComponent

Name Description

Public function Virtual

void

 

CreateRenderState_Concurrent()

Used to create any rendering thread information for this component

Public function Virtual

void

 

DestroyRenderState_Concurrent()

Used to shut down any rendering thread structure for this component

Public function Virtual

void

 

SendRenderTransform_Concurrent()

Called to send a transform update for this component to the rendering thread

Overridden from UObject

Name Description

Public function Virtual

void

 

BeginDestroy()

Called before destroying the object.

Public function Virtual

void

 

FinishDestroy()

Called to finish destroying the object.

Public function Virtual

bool

 

IsReadyForFinishDestroy()

Called to check if the object is ready for FinishDestroy.

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent & PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

Serialize

(
    FArchive & Ar
)

UObject serializer.

References

Module

Engine

Header

Runtime/Engine/Classes/Components/PlanarReflectionComponent.h