SSafeZone.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 "Widgets/DeclarativeSyntaxSupport.h"
#include "Widgets/Layout/SBox.h"
 
class FArrangedChildren;
 
class SSafeZone : public SBox
{
    SLATE_BEGIN_ARGS(SSafeZone)
        : _HAlign( HAlign_Fill )
        , _VAlign( VAlign_Fill )
        , _Padding( 0.0f )
        , _Content()
        , _IsTitleSafe( false )
        , _SafeAreaScale(1,1,1,1)
        , _PadLeft( true )
        , _PadRight( true )
        , _PadTop( true )
        , _PadBottom( true )
#if WITH_EDITOR
        , _OverrideScreenSize()
        , _OverrideDpiScale()
#endif
        {}
 
        SLATE_ARGUMENT( EHorizontalAlignment, HAlign )
 
        
        SLATE_ARGUMENT( EVerticalAlignment, VAlign )
 
        
        SLATE_ATTRIBUTE( FMargin, Padding )
 
        
        SLATE_DEFAULT_SLOT( FArguments, Content )
    
        
        SLATE_ARGUMENT( bool, IsTitleSafe )
 
        
        SLATE_ARGUMENT(FMargin, SafeAreaScale)
 
        
        SLATE_ARGUMENT( bool, PadLeft )
 
        
        SLATE_ARGUMENT( bool, PadRight )
 
        
        SLATE_ARGUMENT( bool, PadTop )
        
        
        SLATE_ARGUMENT( bool, PadBottom )
 
#if WITH_EDITOR
        SLATE_ARGUMENT( TOptional<FVector2D>, OverrideScreenSize )
 
        
        SLATE_ARGUMENT(TOptional<float>, OverrideDpiScale )
#endif
 
    SLATE_END_ARGS()
 
public:
 
    SLATE_API SSafeZone();
    SLATE_API virtual ~SSafeZone();
 
    SLATE_API void Construct( const FArguments& InArgs );
    
    SLATE_API void SetTitleSafe( bool bIsTitleSafe );
    SLATE_API void SetSafeAreaScale(FMargin InSafeAreaScale);
 
    SLATE_API void SetSidesToPad( bool InPadLeft, bool InPadRight, bool InPadTop, bool InPadBottom );
 
    SLATE_API FMargin GetSafeMargin(float InLayoutScale) const;
 
#if WITH_EDITOR
    SLATE_API void SetOverrideScreenInformation(TOptional<FVector2D> InScreenSize, TOptional<float> InOverrideDpiScale);
    SLATE_API void DebugSafeAreaUpdated(const FMargin& NewSafeZone, bool bShouldRecacheMetrics);
#endif
 
    SLATE_API virtual void OnArrangeChildren( const FGeometry& AllottedGeometry, FArrangedChildren& ArrangedChildren ) const override;
    SLATE_API virtual FVector2D ComputeDesiredSize(float LayoutScale) const override;
 
    static SLATE_API void SetGlobalSafeZoneScale(TOptional<float> InScale);
    static SLATE_API TOptional<float> GetGlobalSafeZoneScale();
 
private:
 
    void UpdateSafeMargin();
    FMargin ComputeScaledSafeMargin(float Scale) const;
 
    TSlateAttribute<FMargin, EInvalidateWidgetReason::Layout> Padding;
    FMargin SafeAreaScale;
    bool bIsTitleSafe;
    bool bPadLeft;
    bool bPadRight;
    bool bPadTop;
    bool bPadBottom;
 
#if WITH_EDITOR
    TOptional<FVector2D> OverrideScreenSize;
    TOptional<float> OverrideDpiScale;
#endif
 
    mutable bool bSafeMarginNeedsUpdate;
 
    mutable FMargin SafeMargin;
 
    FDelegateHandle OnSafeFrameChangedHandle;
};