1. Epic GamesDeveloper
  3. UPlanarReflectionComponent

UPlanarReflectionComponent

[UPlanarReflectionComponent](API\Runtime\Engine\Components\UPlanarReflectionComponent)

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Components

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Components/PlanarReflectionComponent.h
Include #include "Components/PlanarReflectionComponent.h"

Syntax

UCLASS (HideCategories=(Collision, Object, Physics, SceneComponent), ClassGroup=Rendering,  
       MinimalAPI, EditInlineNew, Meta=(BlueprintSpawnableComponent))  
class UPlanarReflectionComponent : public USceneCaptureComponent

Remarks

UPlanarReflectionComponent

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta float AngleFromPlaneFadeEnd Receiving pixels whose normal is at this angle from the reflection plane will have completely faded out the planar reflection.
Public variable UProperty Category, EditAnywhere, Meta float AngleFromPlaneFadeStart Receiving pixels whose normal is at this angle from the reflection plane will begin to fade out the planar reflection.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay 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 UProperty Category, EditAnywhere bool bShowPreviewPlane  
Protected variable UProperty Transient TObjectPtr< class UMaterial > CaptureMaterial The material to use on ProxyMeshComponent
Public variable UProperty Category, EditAnywhere, Meta float DistanceFromPlaneFadeoutEnd Receiving pixels at this distance from the reflection plane will have completely faded out the planar reflection.
Public variable UProperty Category, EditAnywhere, Meta float DistanceFromPlaneFadeoutStart Receiving pixels at this distance from the reflection plane will begin to fade out the planar reflection.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta float ExtraFOV Additional FOV used when rendering to the reflection texture.
Public variable UProperty Category, EditAnywhere, Meta float NormalDistortionStrength Controls the strength of normals when distorting the planar reflection.
Public variable UProperty Category, EditAnywhere, Meta float PrefilterRoughness The roughness value to prefilter the planar reflection texture with, useful for hiding low resolution.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta float PrefilterRoughnessDistance The distance at which the prefilter roughness value will be achieved.
Public variable UProperty TObjectPtr< class UBoxComponent > PreviewBox  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta int32 ScreenPercentage Downsample percent, can be used to reduce GPU time rendering the planar reflection.

Constructors

  Type Name Description
Public function  

UPlanarReflectionComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const int32  
Public function Const void

GetProjectionWithExtraFOV ( FMatrix& OutMatrix,
const uint32 StereoIndex
)

  
Public function Const bool  
Public function void  

Overridden from UActorComponent

  Type Name Description
Public function Virtual void Used to create any rendering thread information for this component
Public function Virtual void Used to shut down any rendering thread structure for this component
Public function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Public function Virtual void Called to send a transform update for this component to the rendering thread

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void Called to finish destroying the object.
Public function Virtual bool Called to check if the object is ready for FinishDestroy.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

  Type Name Description
Public variable UProperty float DistanceFromPlaneFadeEnd_DEPRECATED  
Public variable UProperty float DistanceFromPlaneFadeStart_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page