ReflectionCaptureComponent.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Misc/Guid.h"
#include "Misc/CoreStats.h"
#include "Templates/RefCounting.h"
#include "Components/SceneComponent.h"
#include "RenderCommandFence.h"
#include "ReflectionCaptureComponent.generated.h"
 
class FReflectionCaptureProxy;
class UBillboardComponent;
class FTexture;
 
UENUM()
enum class EReflectionSourceType : uint8
{
    CapturedScene,
    SpecifiedCubemap,
};
 
// -> will be exported to EngineDecalClasses.h
UCLASS(abstract, hidecategories=(Collision, Object, Physics, SceneComponent, Activation, "Components|Activation", Mobility), MinimalAPI)
class UReflectionCaptureComponent : public USceneComponent
{
    GENERATED_UCLASS_BODY()
 
    UPROPERTY()
    TObjectPtr<UBillboardComponent> CaptureOffsetComponent;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=ReflectionCapture)
    EReflectionSourceType ReflectionSourceType;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=ReflectionCapture)
    TObjectPtr<class UTextureCube> Cubemap;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=ReflectionCapture, meta = (UIMin = "0", UIMax = "360"))
    float SourceCubemapAngle;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=ReflectionCapture, meta=(UIMin = ".5", UIMax = "4"))
    float Brightness;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=ReflectionCapture, AdvancedDisplay)
    FVector CaptureOffset;
 
    UPROPERTY()
    FGuid MapBuildDataId;
 
    class FReflectionTextureCubeResource* EncodedHDRCubemapTexture;
 
#if WITH_EDITOR
    bool bMapBuildDataIdLoaded;
#endif
 
    FReflectionCaptureProxy* SceneProxy;
 
    ENGINE_API FReflectionCaptureProxy* CreateSceneProxy();
 
    virtual void UpdatePreviewShape();
 
    ENGINE_API void MarkDirtyForRecaptureOrUpload();
 
    ENGINE_API void MarkDirtyForRecapture();
 
    void SetCaptureCompleted() { bNeedsRecaptureOrUpload = false; }
 
    virtual float GetInfluenceBoundingRadius() const PURE_VIRTUAL(UReflectionCaptureComponent::GetInfluenceBoundingRadius,return 0;);
 
    ENGINE_API static void UpdateReflectionCaptureContents(UWorld* WorldToUpdate, const TCHAR* CaptureReason = nullptr, bool bVerifyOnlyCapturing = false, bool bCapturingForMobile = false, bool bInsideTick = false);
 
    ENGINE_API class FReflectionCaptureMapBuildData* GetMapBuildData() const;
 
    virtual void PropagateLightingScenarioChange() override;
 
    ENGINE_API static int32 GetReflectionCaptureSize();
 
    //~ Begin UActorComponent Interface
    virtual void CreateRenderState_Concurrent(FRegisterComponentContext* Context) override;
    virtual void DestroyRenderState_Concurrent() override;
    virtual void SendRenderTransform_Concurrent() override;
    virtual void OnRegister() override;
    virtual void InvalidateLightingCacheDetailed(bool bInvalidateBuildEnqueuedLighting, bool bTranslationOnly) override;
    //~ End UActorComponent Interface
 
    //~ Begin UObject Interface
    virtual void PostInitProperties() override; 
    virtual void Serialize(FArchive& Ar) override;
#if WITH_EDITOR
    virtual bool CanEditChange(const FProperty* Property) const override;
    virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
    virtual void PreFeatureLevelChange(ERHIFeatureLevel::Type PendingFeatureLevel) override;
#endif // WITH_EDITOR
    virtual void BeginDestroy() override;
    virtual bool IsReadyForFinishDestroy() override;
    virtual void FinishDestroy() override;
    //~ End UObject Interface
 
private:
 
    bool bNeedsRecaptureOrUpload;
 
    float CachedAverageBrightness;
 
    FRenderCommandFence ReleaseResourcesFence;
 
    static TArray<UReflectionCaptureComponent*> ReflectionCapturesToUpdate;
 
    static TArray<UReflectionCaptureComponent*> ReflectionCapturesToUpdateForLoad;
    static FCriticalSection ReflectionCapturesToUpdateForLoadLock;
 
    //void UpdateDerivedData(FReflectionCaptureFullHDR* NewDerivedData);
    void SerializeLegacyData(FArchive& Ar);
 
    void SafeReleaseEncodedHDRCubemapTexture();
 
    friend class FReflectionCaptureProxy;
};
 
ENGINE_API extern void GenerateEncodedHDRData(const TArray<uint8>& FullHDRData, int32 CubemapSize, TArray<uint8>& OutEncodedHDRData);