1. Epic GamesDeveloper
  3. UReflectionCaptureComponent

UReflectionCaptureComponent

-> will be exported to EngineDecalClasses.h

Unreal Engine C++ API Reference > Runtime > Engine > Components

Inheritance Hierarchy

References

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

Syntax

UCLASS (Abstract,  
       HideCategories=(Collision, Object, Physics, SceneComponent, Activation, "Components|Activation", Mobility),  
       MinimalAPI)  
class UReflectionCaptureComponent : public USceneComponent

Remarks

-> will be exported to EngineDecalClasses.h

Variables

  Type Name Description
Public variable bool bMapBuildDataIdLoaded Check to see if MapBuildDataId was loaded - otherwise we need to display a warning on cook
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float Brightness A brightness control to scale the captured scene's reflection intensity.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite FVector CaptureOffset World space offset to apply before capturing.
Public variable UProperty TObjectPtr< UBillboardComponent > CaptureOffsetComponent  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TObjectPtr< class UTextureCube > Cubemap Cubemap to use for reflection if ReflectionSourceType is set to RS_SpecifiedCubemap.
Public variable FReflectionTextureCubeResource * EncodedHDRCubemapTexture Cubemap texture resource used for rendering with the encoded HDR values.
Public variable UProperty FGuid MapBuildDataId Guid for map build data
Public variable UProperty Category, EditAnywhere BlueprintReadOnly EReflectionSourceType ReflectionSourceType Indicates where to get the reflection source from.
Public variable FReflectionCaptureProxy * SceneProxy The rendering thread's mirror of this reflection capture.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float SourceCubemapAngle Angle to rotate the source cubemap when SourceType is set to SLS_SpecifiedCubemap.

Constructors

  Type Name Description
Public function  

UReflectionCaptureComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function FReflectionCaptureProxy * Callback to create the rendering thread mirror.
Public function Virtual Const float Gets the radius that bounds the shape's influence, used for culling.
Public function Const FReflectionCaptureMapBuildData *  
Public function Static int32  
Public function void Generates a new MapBuildDataId and adds the capture to the capture queue processed by UpdateReflectionCaptureContents.
Public function void Adds the capture to the capture queue processed by UpdateReflectionCaptureContents.
Public function void Marks this component has having been recaptured.
Public function Virtual void Called to update the preview shapes when something they are dependent on has changed.
Public function Static void

UpdateReflectionCaptureContents ( UWorld* WorldToUpdate,
const TCHAR* CaptureReason,
bool bVerifyOnlyCapturing,
bool bCapturingForMobile,
bool bInsideTick
)

 Generally called each tick to recapture any queued reflection captures.

Overridden from USceneComponent

  Type Name Description
Public function Virtual void Called to update any visuals needed for a feature level change
Public function Virtual void Updates any visuals after the lighting has changed

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

InvalidateLightingCacheDetailed ( bool bInvalidateBuildEnqueuedLighting,
bool bTranslationOnly
)

 Called when this actor component has moved, allowing it to discard statically cached lighting information.
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 Const bool

CanEditChange ( const FProperty* Property
)

 Called by the editor to query whether a property of this object is allowed to be modified.
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 Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Constants

Name Description
ReflectionCapturesToUpdate List of reflection captures that need to be recaptured.
ReflectionCapturesToUpdateForLoad List of reflection captures that need to be recaptured because they were dirty on load.
ReflectionCapturesToUpdateForLoadLock  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page