CanvasPanelSlot.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 "UObject/ScriptMacros.h"
#include "Layout/Margin.h"
#include "Layout/Geometry.h"
#include "Widgets/Layout/Anchors.h"
#include "Widgets/Layout/SConstraintCanvas.h"
#include "Components/PanelSlot.h"
 
#include "CanvasPanelSlot.generated.h"
 
USTRUCT(BlueprintType)
struct FAnchorData
{
public:
    GENERATED_USTRUCT_BODY()
 
public:
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=AnchorData)
    FMargin Offsets;
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=AnchorData)
    FAnchors Anchors;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=AnchorData)
    FVector2D Alignment = FVector2D::ZeroVector;
 
    bool operator==(const FAnchorData& Other) const
    {
        return Offsets == Other.Offsets && 
               Anchors == Other.Anchors && 
               Alignment == Other.Alignment;
    }
 
    bool operator!=(const FAnchorData& Other) const
    {
        return !(*this == Other);
    }
};
 
UCLASS(MinimalAPI)
class UCanvasPanelSlot : public UPanelSlot
{
    GENERATED_UCLASS_BODY()
 
public:
 
    UE_DEPRECATED(5.1, "Direct access to LayoutData is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter="GetLayout", Setter="SetLayout", BlueprintGetter ="GetLayout", BlueprintSetter="SetLayout", Category = "Layout|Canvas Slot")
    FAnchorData LayoutData;
 
    UE_DEPRECATED(5.1, "Direct access to bAutoSize is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter="GetAutoSize", Setter="SetAutoSize", BlueprintGetter="GetAutoSize", BlueprintSetter="SetAutoSize", Category = "Layout|Canvas Slot", AdvancedDisplay, meta = (DisplayName = "Size To Content"))
    bool bAutoSize;
 
    UE_DEPRECATED(5.1, "Direct access to ZOrder is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintGetter="GetZOrder", BlueprintSetter="SetZOrder", Category="Layout|Canvas Slot")
    int32 ZOrder;
 
public:
#if WITH_EDITOR
    UMG_API virtual bool NudgeByDesigner(const FVector2D& NudgeDirection, const TOptional<int32>& GridSnapSize) override;
    UMG_API virtual bool DragDropPreviewByDesigner(const FVector2D& LocalCursorPosition, const TOptional<int32>& XGridSnapSize, const TOptional<int32>& YGridSnapSize) override;
    UMG_API virtual void SynchronizeFromTemplate(const UPanelSlot* const TemplateSlot) override;
#endif //WITH_EDITOR
 
    UFUNCTION(BlueprintCallable, Category="Layout|Canvas Slot")
    UMG_API void SetLayout(const FAnchorData& InLayoutData);
 
    UFUNCTION(BlueprintCallable, Category="Layout|Canvas Slot")
    UMG_API FAnchorData GetLayout() const;
 
    UFUNCTION(BlueprintCallable, Category="Layout|Canvas Slot")
    UMG_API void SetPosition(FVector2D InPosition);
 
    UFUNCTION(BlueprintCallable, Category="Layout|Canvas Slot")
    UMG_API FVector2D GetPosition() const;
 
    UFUNCTION(BlueprintCallable, Category="Layout|Canvas Slot")
    UMG_API void SetSize(FVector2D InSize);
 
    UFUNCTION(BlueprintCallable, Category="Layout|Canvas Slot")
    UMG_API FVector2D GetSize() const;
 
    UFUNCTION(BlueprintCallable, Category="Layout|Canvas Slot")
    UMG_API void SetOffsets(FMargin InOffset);
 
    UFUNCTION(BlueprintCallable, Category="Layout|Canvas Slot")
    UMG_API FMargin GetOffsets() const;
    
    UFUNCTION(BlueprintCallable, Category="Layout|Canvas Slot")
    UMG_API void SetAnchors(FAnchors InAnchors);
 
    UFUNCTION(BlueprintCallable, Category="Layout|Canvas Slot")
    UMG_API FAnchors GetAnchors() const;
 
    UFUNCTION(BlueprintCallable, Category="Layout|Canvas Slot")
    UMG_API void SetAlignment(FVector2D InAlignment);
 
    UFUNCTION(BlueprintCallable, Category="Layout|Canvas Slot")
    UMG_API FVector2D GetAlignment() const;
 
    UFUNCTION(BlueprintCallable, Category="Layout|Canvas Slot")
    UMG_API void SetAutoSize(bool InbAutoSize);
 
    UFUNCTION(BlueprintCallable, Category="Layout|Canvas Slot")
    UMG_API bool GetAutoSize() const;
 
    UFUNCTION(BlueprintCallable, Category="Layout|Canvas Slot")
    UMG_API void SetZOrder(int32 InZOrder);
 
    UFUNCTION(BlueprintCallable, Category="Layout|Canvas Slot")
    UMG_API int32 GetZOrder() const;
 
public:
 
    UFUNCTION()
    UMG_API void SetMinimum(FVector2D InMinimumAnchors);
 
    UFUNCTION()
    UMG_API void SetMaximum(FVector2D InMaximumAnchors);
 
public:
 
    UMG_API void BuildSlot(TSharedRef<SConstraintCanvas> Canvas);
 
    // UPanelSlot interface
    UMG_API virtual void SynchronizeProperties() override;
    // End of UPanelSlot interface
 
    UMG_API virtual void ReleaseSlateResources(bool bReleaseChildren) override;
 
#if WITH_EDITOR
    // UObject interface
    using Super::PreEditChange;
    UMG_API virtual void PreEditChange(FProperty* PropertyThatWillChange) override;
    UMG_API virtual void PostEditChangeChainProperty(struct FPropertyChangedChainEvent& PropertyChangedEvent) override;
    // End of UObject interface
 
    UMG_API void SaveBaseLayout();
 
    UMG_API void SetDesiredPosition(FVector2D InPosition);
 
    UMG_API void RebaseLayout(bool PreserveSize = true);
#endif
 
private:
    SConstraintCanvas::FSlot* Slot;
 
#if WITH_EDITORONLY_DATA
    FGeometry PreEditGeometry;
    FAnchorData PreEditLayoutData;
 
    TOptional<FVector2D> DesiredPosition;
#endif
};