DecalComponent.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 "Engine/EngineTypes.h"
#include "Components/SceneComponent.h"
#include "PSOPrecache.h"
 
#include "DecalComponent.generated.h"
 
class FDeferredDecalProxy;
class UMaterialInterface;
 
UCLASS(Blueprintable, editinlinenew, hidecategories=(Collision, Object, Physics, SceneComponent, Activation, "Components|Activation", Mobility), ClassGroup=Rendering, meta=(BlueprintSpawnableComponent), MinimalAPI)
class UDecalComponent : public USceneComponent
{
    GENERATED_UCLASS_BODY()
 
protected:
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=Decal)
    TObjectPtr<class UMaterialInterface> DecalMaterial;
 
public:
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Decal)
    int32 SortOrder;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Decal)
    float FadeScreenSize;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Decal)
    float FadeStartDelay;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Decal)
    float FadeDuration;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Decal)
    float FadeInDuration;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Decal)
    float FadeInStartDelay;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Decal)
    uint8 bDestroyOwnerAfterFade : 1;
 
    UFUNCTION(BlueprintCallable, Category = "Rendering|Components|Decal")
    ENGINE_API float GetFadeStartDelay() const;
 
    UFUNCTION(BlueprintCallable, Category = "Rendering|Components|Decal")
    ENGINE_API float GetFadeDuration() const;
 
    UFUNCTION(BlueprintCallable, Category = "Rendering|Components|Decal")
    ENGINE_API float GetFadeInStartDelay() const;
 
    UFUNCTION(BlueprintCallable, Category = "Rendering|Components|Decal")
    ENGINE_API float GetFadeInDuration() const;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Decal, meta=(AllowPreserveRatio = "true"))
    FVector DecalSize;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Decal)
    FLinearColor DecalColor = FLinearColor::White;
 
    UFUNCTION(BlueprintCallable, Category = "Rendering|Components|Decal")
    ENGINE_API void SetFadeOut(float StartDelay, float Duration, bool DestroyOwnerAfterFade = true);
 
    UFUNCTION(BlueprintCallable, Category = "Rendering|Components|Decal")
    ENGINE_API void SetFadeIn(float StartDelay, float Duration);
 
    UFUNCTION(BlueprintCallable, Category = "Rendering|Components|Decal")
    ENGINE_API void SetFadeScreenSize(float NewFadeScreenSize);
 
    UFUNCTION(BlueprintCallable, Category = "Rendering|Components|Decal")
    ENGINE_API void SetSortOrder(int32 Value);
 
    UFUNCTION(BlueprintCallable, Category = "Rendering|Components|Decal")
    ENGINE_API void SetDecalColor(const FLinearColor& Color);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|Decal")
    ENGINE_API void SetDecalMaterial(class UMaterialInterface* NewDecalMaterial);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|Decal")
    ENGINE_API class UMaterialInterface* GetDecalMaterial() const;
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|Decal")
    ENGINE_API virtual class UMaterialInstanceDynamic* CreateDynamicMaterialInstance();
 
public:
#if UE_WITH_PSO_PRECACHING
    std::atomic<int> LatestPSOPrecacheJobSetCompleted = 0;
    int32 LatestPSOPrecacheJobSet = 0;
#endif
 
    FDeferredDecalProxy* SceneProxy;
 
    UE_DEPRECATED(5.4, "This method has no effect, calls to this method may be safely removed.")
    ENGINE_API void PushSelectionToProxy();
 
protected:
    FTimerHandle TimerHandle_DestroyDecalComponent;
 
    ENGINE_API virtual void LifeSpanCallback();
 
public:
    
    ENGINE_API void SetLifeSpan(const float LifeSpan);
 
    ENGINE_API virtual void GetUsedMaterials( TArray<UMaterialInterface*>& OutMaterials, bool bGetDebugMaterials = false ) const;
    
    ENGINE_API virtual FDeferredDecalProxy* CreateSceneProxy();
    virtual int32 GetNumMaterials() const
    {
        return 1; // DecalMaterial
    }
 
    virtual UMaterialInterface* GetMaterial(int32 ElementIndex) const
    {
        return (ElementIndex == 0) ? DecalMaterial : NULL;
    }
    virtual void SetMaterial(int32 ElementIndex, UMaterialInterface* InMaterial)
    {
        if (ElementIndex == 0)
        {
            SetDecalMaterial(InMaterial);
        }
    }
 
    
    //~ Begin UActorComponent Interface
    ENGINE_API virtual void OnRegister() override;
    ENGINE_API virtual void BeginPlay() override;
    ENGINE_API virtual void CreateRenderState_Concurrent(FRegisterComponentContext* Context) override;
    ENGINE_API virtual void DestroyRenderState_Concurrent() override;
    ENGINE_API virtual void SendRenderTransform_Concurrent() override;
    ENGINE_API virtual const UObject* AdditionalStatObject() const override;
    ENGINE_API virtual void PrecachePSOs() override;
#if WITH_EDITOR
    ENGINE_API virtual void CheckForErrors() override;
#endif
    //~ End UActorComponent Interface
    
    //~ Begin UObject Interface. 
    ENGINE_API virtual void Serialize(FArchive& Ar) override;
    ENGINE_API virtual bool IsPostLoadThreadSafe() const override;
    ENGINE_API virtual void PostLoad() override;
    //~ End UObject Interface
 
    //~ Begin USceneComponent Interface
#if WITH_EDITOR
    ENGINE_API virtual bool GetMaterialPropertyPath(int32 ElementIndex, UObject*& OutOwner, FString& OutPropertyPath, FProperty*& OutProperty) override;
#endif // WITH_EDITOR
    ENGINE_API virtual FBoxSphereBounds CalcBounds(const FTransform& LocalToWorld) const override;
    //~ End USceneComponent Interface
 
    FTransform GetTransformIncludingDecalSize() const
    {
        FTransform Ret = GetComponentToWorld();
        Ret.SetScale3D(Ret.GetScale3D() * DecalSize);
 
        return Ret;
    }
};