Navigation
API > API/Runtime > API/Runtime/Engine
| Name | UPlanarReflectionComponent |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Components/PlanarReflectionComponent.h |
| Include Path | #include "Components/PlanarReflectionComponent.h" |
Syntax
UCLASS (HideCategories=(Collision, Object, Physics, SceneComponent), ClassGroup=Rendering,
MinimalAPI, EditInlineNew, Meta=(BlueprintSpawnableComponent))
class UPlanarReflectionComponent : public USceneCaptureComponent
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → USceneComponent → USceneCaptureComponent → UPlanarReflectionComponent
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UPlanarReflectionComponent
(
const FObjectInitializer& ObjectInitializer |
Components/PlanarReflectionComponent.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AngleFromPlaneFadeEnd | float | Receiving pixels whose normal is at this angle from the reflection plane will have completely faded out the planar reflection. | Components/PlanarReflectionComponent.h |
|
| AngleFromPlaneFadeStart | float | Receiving pixels whose normal is at this angle from the reflection plane will begin to fade out the planar reflection. | Components/PlanarReflectionComponent.h |
|
| bRenderSceneTwoSided | bool | 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. | Components/PlanarReflectionComponent.h |
|
| bShowPreviewPlane | bool | Components/PlanarReflectionComponent.h |
|
|
| DistanceFromPlaneFadeoutEnd | float | Receiving pixels at this distance from the reflection plane will have completely faded out the planar reflection. | Components/PlanarReflectionComponent.h |
|
| DistanceFromPlaneFadeoutStart | float | Receiving pixels at this distance from the reflection plane will begin to fade out the planar reflection. | Components/PlanarReflectionComponent.h |
|
| ExtraFOV | float | Additional FOV used when rendering to the reflection texture. | Components/PlanarReflectionComponent.h |
|
| NormalDistortionStrength | float | Controls the strength of normals when distorting the planar reflection. | Components/PlanarReflectionComponent.h |
|
| PrefilterRoughness | float | The roughness value to prefilter the planar reflection texture with, useful for hiding low resolution. | Components/PlanarReflectionComponent.h |
|
| PrefilterRoughnessDistance | float | The distance at which the prefilter roughness value will be achieved. | Components/PlanarReflectionComponent.h |
|
| PreviewBox | TObjectPtr< class UBoxComponent > | Components/PlanarReflectionComponent.h | ||
| ScreenPercentage | int32 | Downsample percent, can be used to reduce GPU time rendering the planar reflection. | Components/PlanarReflectionComponent.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| PlanarReflectionId | int32 | Components/PlanarReflectionComponent.h | ||
| ProjectionWithExtraFOV | FMatrix | Components/PlanarReflectionComponent.h | ||
| ReleaseResourcesFence | FRenderCommandFence | Fence used to track progress of releasing resources on the rendering thread. | Components/PlanarReflectionComponent.h | |
| RenderTarget | FPlanarReflectionRenderTarget * | Components/PlanarReflectionComponent.h | ||
| SceneProxy | FPlanarReflectionSceneProxy * | Components/PlanarReflectionComponent.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 GetPlanarReflectionId() |
Components/PlanarReflectionComponent.h | ||
void GetProjectionWithExtraFOV
(
FMatrix& OutMatrix, |
Components/PlanarReflectionComponent.h | ||
bool ShouldComponentAddToScene() |
Components/PlanarReflectionComponent.h | ||
void UpdatePreviewShape() |
Components/PlanarReflectionComponent.h |
Overridden from UActorComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CreateRenderState_Concurrent
(
FRegisterComponentContext* Context |
Used to create any rendering thread information for this component | Components/PlanarReflectionComponent.h | |
virtual void DestroyRenderState_Concurrent () |
Used to shut down any rendering thread structure for this component | Components/PlanarReflectionComponent.h | |
virtual void OnRegister() |
Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called. | Components/PlanarReflectionComponent.h | |
virtual void SendRenderTransform_Concurrent () |
Called to send a transform update for this component to the rendering thread | Components/PlanarReflectionComponent.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
Components/PlanarReflectionComponent.h | ||
virtual void FinishDestroy() |
Components/PlanarReflectionComponent.h | ||
virtual bool IsReadyForFinishDestroy() |
Components/PlanarReflectionComponent.h | ||
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Components/PlanarReflectionComponent.h | ||
virtual void Serialize
(
FArchive& Ar |
Components/PlanarReflectionComponent.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DistanceFromPlaneFadeEnd_DEPRECATED | float | Components/PlanarReflectionComponent.h | ||
| DistanceFromPlaneFadeStart_DEPRECATED | float | Components/PlanarReflectionComponent.h |