Steve Pham
38261d0800
* Updated all copyright headers to split the longer original copyright line into 2 shorter lines Signed-off-by: Steve Pham <spham@amazon.com>
69 lines
1.9 KiB
C++
69 lines
1.9 KiB
C++
/*
|
|
* Copyright (c) Contributors to the Open 3D Engine Project.
|
|
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0 OR MIT
|
|
*
|
|
*/
|
|
#pragma once
|
|
|
|
#include <AzCore/Component/ComponentBus.h>
|
|
|
|
////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
class UiNavigationInterface
|
|
: public AZ::ComponentBus
|
|
{
|
|
public: // types
|
|
|
|
enum class NavigationMode
|
|
{
|
|
Automatic,
|
|
Custom,
|
|
None
|
|
};
|
|
|
|
public: // member functions
|
|
|
|
virtual ~UiNavigationInterface() {}
|
|
|
|
//! Get the navigation mode
|
|
virtual NavigationMode GetNavigationMode() = 0;
|
|
|
|
//! Set the navigation mode
|
|
virtual void SetNavigationMode(NavigationMode navigationMode) = 0;
|
|
|
|
//! Get the entity to receive focus when up is pressed
|
|
virtual AZ::EntityId GetOnUpEntity() = 0;
|
|
|
|
//! Set the entity to receive focus when up is pressed
|
|
virtual void SetOnUpEntity(AZ::EntityId entityId) = 0;
|
|
|
|
//! Get the entity to receive focus when down is pressed
|
|
virtual AZ::EntityId GetOnDownEntity() = 0;
|
|
|
|
//! Set the entity to receive focus when down is pressed
|
|
virtual void SetOnDownEntity(AZ::EntityId entityId) = 0;
|
|
|
|
//! Get the entity to receive focus when left is pressed
|
|
virtual AZ::EntityId GetOnLeftEntity() = 0;
|
|
|
|
//! Set the entity to receive focus when left is pressed
|
|
virtual void SetOnLeftEntity(AZ::EntityId entityId) = 0;
|
|
|
|
//! Get the entity to receive focus when right is pressed
|
|
virtual AZ::EntityId GetOnRightEntity() = 0;
|
|
|
|
//! Set the entity to receive focus when right is pressed
|
|
virtual void SetOnRightEntity(AZ::EntityId entityId) = 0;
|
|
|
|
public: // static member data
|
|
|
|
//! Only one component on a entity can implement the events
|
|
static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single;
|
|
};
|
|
|
|
typedef AZ::EBus<UiNavigationInterface> UiNavigationBus;
|
|
|
|
|
|
|