NavigationMetaData.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Input/NavigationReply.h"
#include "Input/NavigationRouting.h"
#include "Input/NavigationMethod.h"
#include "StructUtils/InstancedStruct.h"
#include "Types/ISlateMetaData.h"
#include "Types/SlateEnums.h"
 
class SWidget;
 
class FNavigationMetaData : public ISlateMetaData
{
public:
    SLATE_METADATA_TYPE(FNavigationMetaData, ISlateMetaData)
 
    FNavigationMetaData()
    {
        for (SNavData& Rule : Rules)
        {
            Rule.BoundaryRule = EUINavigationRule::Escape;
            Rule.FocusDelegate = nullptr;
            Rule.FocusRecipient = nullptr;
        }
    }
 
    EUINavigationRule GetBoundaryRule(EUINavigation InNavigation) const
    {
        return Rules[(uint8)InNavigation].BoundaryRule;
    }
 
    const TWeakPtr<SWidget>& GetFocusRecipient(EUINavigation InNavigation) const
    {
        return Rules[(uint8)InNavigation].FocusRecipient;
    }
 
    const FNavigationDelegate& GetFocusDelegate(EUINavigation InNavigation) const
    {
        return Rules[(uint8)InNavigation].FocusDelegate;
    }
 
    void SetNavigationExplicit(EUINavigation InNavigation, TSharedPtr<SWidget> InFocusRecipient)
    {
        Rules[(uint8)InNavigation].BoundaryRule = EUINavigationRule::Explicit;
        Rules[(uint8)InNavigation].FocusDelegate = nullptr;
        Rules[(uint8)InNavigation].FocusRecipient = InFocusRecipient;
    }
 
    void SetNavigationCustom(EUINavigation InNavigation, EUINavigationRule InCustomBoundaryRule, FNavigationDelegate InFocusDelegate)
    { 
        ensure(InCustomBoundaryRule == EUINavigationRule::Custom || InCustomBoundaryRule == EUINavigationRule::CustomBoundary);
        Rules[(uint8)InNavigation].BoundaryRule = InCustomBoundaryRule;
        Rules[(uint8)InNavigation].FocusDelegate = InFocusDelegate;
        Rules[(uint8)InNavigation].FocusRecipient = nullptr;
    }
 
    void SetNavigationWrap(EUINavigation InNavigation)
    {
        Rules[(uint8)InNavigation].BoundaryRule = EUINavigationRule::Wrap;
        Rules[(uint8)InNavigation].FocusDelegate = nullptr;
        Rules[(uint8)InNavigation].FocusRecipient = nullptr;
    }
 
    void SetNavigationStop(EUINavigation InNavigation)
    {
        Rules[(uint8)InNavigation].BoundaryRule = EUINavigationRule::Stop;
        Rules[(uint8)InNavigation].FocusDelegate = nullptr;
        Rules[(uint8)InNavigation].FocusRecipient = nullptr;
    }
 
    void SetNavigationEscape(EUINavigation InNavigation)
    {
        Rules[(uint8)InNavigation].BoundaryRule = EUINavigationRule::Escape;
        Rules[(uint8)InNavigation].FocusDelegate = nullptr;
        Rules[(uint8)InNavigation].FocusRecipient = nullptr;
    }
 
    void SetNavigationMethodStruct(const TInstancedStruct<FNavigationMethod>& InNavigationMethodStruct) 
    {
        NavigationMethodStruct = InNavigationMethodStruct;
    }
 
    const TInstancedStruct<FNavigationMethod>& GetNavigationMethodStruct() const
    {
        return NavigationMethodStruct;
    }
 
    void SetNavigationRoutingPolicy(EWidgetNavigationRoutingPolicy InNavigationRoutingPolicy) 
    {
        NavigationRoutingPolicy = InNavigationRoutingPolicy;
    }
 
    EWidgetNavigationRoutingPolicy GetNavigationRoutingPolicy() const
    {
        return NavigationRoutingPolicy;
    }
 
private:
 
    struct SNavData
    {
        EUINavigationRule BoundaryRule;
        TWeakPtr<SWidget> FocusRecipient;
        FNavigationDelegate FocusDelegate;
    };
    SNavData Rules[(uint8)EUINavigation::Num];
 
    EWidgetNavigationRoutingPolicy NavigationRoutingPolicy = EWidgetNavigationRoutingPolicy::Default;
    TInstancedStruct<FNavigationMethod> NavigationMethodStruct;
};
 
#ifndef UE_WITH_SLATE_SIMULATEDNAVIGATIONMETADATA
#define UE_WITH_SLATE_SIMULATEDNAVIGATIONMETADATA !(UE_BUILD_SHIPPING || UE_BUILD_TEST)
#endif
 
#if UE_WITH_SLATE_SIMULATEDNAVIGATIONMETADATA
class FSimulatedNavigationMetaData : public ISlateMetaData
{
public:
    SLATE_METADATA_TYPE(FSimulatedNavigationMetaData, ISlateMetaData)
 
    FSimulatedNavigationMetaData() = default;
 
    FSimulatedNavigationMetaData(const FNavigationMetaData& InSimulatedNavigation)
    {
        for (int32 Index = 0; Index < UE_ARRAY_COUNT(Rules); ++Index)
        {
            Rules[Index].BoundaryRule = InSimulatedNavigation.GetBoundaryRule((EUINavigation)Index);
            Rules[Index].FocusRecipient = InSimulatedNavigation.GetFocusRecipient((EUINavigation)Index);
        }
    }
 
    FSimulatedNavigationMetaData(EUINavigationRule InNavigationRule)
    {
        for(SNavData& Rule : Rules)
        {
            Rule.BoundaryRule = InNavigationRule;
        }
    }
 
    enum EOnNavigationIsConst { OnNavigationIsConst };
    FSimulatedNavigationMetaData(EOnNavigationIsConst)
    {
        for (SNavData& Rule : Rules)
        {
            Rule.BoundaryRule = EUINavigationRule::Escape;
        }
        bIsOnNavigationConst = true;
    }
 
public:
    EUINavigationRule GetBoundaryRule(EUINavigation InNavigation) const
    {
        return Rules[(uint8)InNavigation].BoundaryRule;
    }
 
    const TWeakPtr<SWidget>& GetFocusRecipient(EUINavigation InNavigation) const
    {
        return Rules[(uint8)InNavigation].FocusRecipient;
    }
 
    bool IsOnNavigationConst() const { return bIsOnNavigationConst; }
 
private:
    struct SNavData
    {
        EUINavigationRule BoundaryRule;
        TWeakPtr<SWidget> FocusRecipient;
    };
    SNavData Rules[(uint8)EUINavigation::Num];
    bool bIsOnNavigationConst = false;
};
#endif //UE_WITH_SLATE_SIMULATEDNAVIGATIONMETADATA