RetainerBox.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 "Widgets/SWidget.h"
#include "Components/ContentWidget.h"
#include "RetainerBox.generated.h"
 
class SRetainerWidget;
class UMaterialInstanceDynamic;
class UMaterialInterface;
 
UCLASS(MinimalAPI)
class URetainerBox : public UContentWidget
{
    GENERATED_UCLASS_BODY()
 
protected:
    UE_DEPRECATED(5.2, "Direct access to bRetainRender is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Setter = "SetRetainRendering", Getter = "IsRetainRendering", BlueprintSetter = "SetRetainRendering", Category = "Render Rules")
    bool bRetainRender = true;
 
public:
    UE_DEPRECATED(5.2, "Direct access to RenderOnInvalidation is deprecated. Please use the getter. Note that this property is only set at construction and is not modifiable at runtime.")
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Getter = "IsRenderOnInvalidation", Category = "Render Rules", meta = (EditCondition = bRetainRender))
    bool RenderOnInvalidation;
 
    UE_DEPRECATED(5.2, "Direct access to RenderOnPhase is deprecated. Please use the getter. Note that this property is only set at construction and is not modifiable at runtime.")
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Getter = "IsRenderOnPhase", Category = "Render Rules", meta = (EditCondition = bRetainRender))
    bool RenderOnPhase;
 
    UE_DEPRECATED(5.2, "Direct access to Phase is deprecated. Please use the getter. Note that this property is only set at construction and is not modifiable at runtime.")
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Getter, Category="Render Rules", meta=(UIMin=0, ClampMin=0))
    int32 Phase;
 
    UE_DEPRECATED(5.2, "Direct access to PhaseCount is deprecated. Please use the getter. Note that this property is only set at construction and is not modifiable at runtime.")
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Getter, Category="Render Rules", meta=(UIMin=1, ClampMin=1))
    int32 PhaseCount;
 
public:
 
    UFUNCTION(BlueprintCallable, Category="Retainer")
    UMG_API void SetRenderingPhase(int32 RenderPhase, int32 TotalPhases);
 
    UFUNCTION(BlueprintCallable, Category="Retainer")
    UMG_API void RequestRender();
 
    UFUNCTION(BlueprintCallable, Category="Retainer|Effect")
    UMG_API UMaterialInstanceDynamic* GetEffectMaterial() const;
 
    UFUNCTION(BlueprintCallable, Category="Retainer|Effect")
    UMG_API void SetEffectMaterial(UMaterialInterface* EffectMaterial);
 
    UFUNCTION(BlueprintCallable, Category="Retainer|Effect")
    UMG_API void SetTextureParameter(FName TextureParameter);
 
    UFUNCTION(BlueprintCallable, Category = "Retainer")
    UMG_API void SetRetainRendering(bool bInRetainRendering);
 
    UMG_API bool IsRetainRendering() const;
 
    UMG_API int32 GetPhase() const;
 
    UMG_API int32 GetPhaseCount() const;
 
    UMG_API bool IsRenderOnInvalidation() const;
 
    UMG_API bool IsRenderOnPhase() const;
 
    UMG_API virtual void ReleaseSlateResources(bool bReleaseChildren) override;
 
#if WITH_EDITOR
    UMG_API virtual const FText GetPaletteCategory() override;
#endif
 
    UMG_API FGeometry GetCachedAllottedGeometry() const;
 
protected:
 
    UE_DEPRECATED(5.2, "Direct access to EffectMaterial is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter = "GetEffectMaterialInterface", Setter, BlueprintSetter = "SetEffectMaterial", Category = "Effect")
    TObjectPtr<UMaterialInterface> EffectMaterial;
 
    UE_DEPRECATED(5.2, "Direct access to TextureParameter is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter = "SetTextureParameter", Category="Effect")
    FName TextureParameter;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Effect", meta = (EditCondition = bRetainRender))
    bool bShowEffectsInDesigner;
#endif
 
    //~ Begin UPanelWidget interface
    UMG_API virtual void OnSlotAdded(UPanelSlot* Slot) override;
    UMG_API virtual void OnSlotRemoved(UPanelSlot* Slot) override;
    //~ End UPanelWidget interface
 
    //~ Begin UWidget interface
    UMG_API virtual TSharedRef<SWidget> RebuildWidget() override;
    UMG_API virtual void SynchronizeProperties() override;
    //~ End of UWidget interface
 
    //~ Begin UObject interface
#if WITH_EDITOR
    UMG_API virtual bool CanEditChange(const FProperty* InProperty) const override;
#endif
    //~ End UObject interface
 
    // Initialize RenderOnInvalidation in the constructor before the SWidget is constructed.
    UMG_API void InitRenderOnInvalidation(bool InRenderOnInvalidation);
 
    // Initialize RenderOnPhase in the constructor before the SWidget is constructed.
    UMG_API void InitRenderOnPhase(bool InRenderOnPhase);
 
    // Initialize Phase in the constructor before the SWidget is constructed.
    UMG_API void InitPhase(int32 InPhase);
 
    // Initialize PhaseCount in the constructor before the SWidget is constructed.
    UMG_API void InitPhaseCount(int32 InPhaseCount);
public:
    UMG_API const FName& GetTextureParameter() const;
 
    UMG_API const UMaterialInterface* GetEffectMaterialInterface() const;
 
protected:
    TSharedPtr<class SRetainerWidget> MyRetainerWidget;
};