SOverlay.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Misc/Attribute.h"
#include "Layout/Margin.h"
#include "Layout/Visibility.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "SlotBase.h"
#include "Widgets/SWidget.h"
#include "Layout/Children.h"
#include "Widgets/SPanel.h"
 
#define UE_API SLATECORE_API
 
class FArrangedChildren;
class FPaintArgs;
class FSlateWindowElementList;
 
 
template <>
struct TWidgetTypeTraits<class SOverlay>
{
    static constexpr bool SupportsInvalidation() { return true; }
};
 
class SOverlay : public SPanel
{
    SLATE_DECLARE_WIDGET_API(SOverlay, SPanel, SLATECORE_API)
public: 
 
    class FOverlaySlot : public TBasicLayoutWidgetSlot<FOverlaySlot>
    {
    public:
        FOverlaySlot(int32 InZOrder)
            : TBasicLayoutWidgetSlot<FOverlaySlot>(HAlign_Fill, VAlign_Fill)
            , ZOrder(InZOrder)
        { }
 
        SLATE_SLOT_BEGIN_ARGS(FOverlaySlot, TBasicLayoutWidgetSlot<FOverlaySlot>)
            SLATE_ARGUMENT(TOptional<int32>, ZOrder)
        SLATE_SLOT_END_ARGS()
 
        UE_API void Construct(const FChildren& SlotOwner, FSlotArguments&& InArgs);
 
        int32 GetZOrder() const
        {
            return ZOrder;
        }
 
        UE_API void SetZOrder(int32 InOrder);
 
    private:
        int32 ZOrder;
    };
 
    SLATE_BEGIN_ARGS( SOverlay )
    {
        _Visibility = EVisibility::SelfHitTestInvisible;
    }
        SLATE_SLOT_ARGUMENT( SOverlay::FOverlaySlot, Slots )
    SLATE_END_ARGS()
 
    SLATECORE_API SOverlay();
    SLATECORE_API ~SOverlay();
 
    SLATECORE_API void Construct( const FArguments& InArgs );
 
    SLATECORE_API int32 GetNumWidgets() const;
 
    SLATECORE_API bool RemoveSlot( TSharedRef< SWidget > Widget );
 
    using FScopedWidgetSlotArguments = TPanelChildren<FOverlaySlot>::FScopedWidgetSlotArguments;
    SLATECORE_API FScopedWidgetSlotArguments AddSlot(int32 ZOrder=INDEX_NONE);
 
    SLATECORE_API bool HasSlotWithZOrder(int32 ZOrder) const;
 
    SLATECORE_API void RemoveSlot(int32 ZOrder=INDEX_NONE);
 
    SLATECORE_API void ClearChildren();
 
    static SLATECORE_API FOverlaySlot::FSlotArguments Slot(int32 ZOrder = 0);
 
    //~ Begin of SWidget interface
    SLATECORE_API virtual void OnArrangeChildren( const FGeometry& AllottedGeometry, FArrangedChildren& ArrangedChildren ) const override;
    SLATECORE_API virtual FChildren* GetChildren() override;
    SLATECORE_API virtual int32 OnPaint( const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawElements, int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled ) const override;
    //~ End of SWidget interface
 
protected:
    //~ Begin SWidget overrides.
    SLATECORE_API virtual FVector2D ComputeDesiredSize(float) const override;
    //~ End SWidget overrides.
 
    SLATECORE_API int32 GetChildIndexByZOrder(int32 ZOrder) const;
 
protected:
    TPanelChildren<FOverlaySlot> Children;
};
 
#undef UE_API