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>
44 lines
1.3 KiB
C++
44 lines
1.3 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/EBus/EBus.h>
|
|
|
|
#include <AzCore/Math/Vector2.h>
|
|
|
|
class UiCursorInterface
|
|
: public AZ::EBusTraits
|
|
{
|
|
public:
|
|
static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single;
|
|
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single;
|
|
|
|
// Public functions
|
|
|
|
//! Increment the UI Cursor visible counter.
|
|
//! Should be paired with a call to DecrementVisibleCounter.
|
|
virtual void IncrementVisibleCounter() = 0;
|
|
|
|
//! Decrement the UI Cursor visible counter.
|
|
//! Should be paired with a call to IncrementVisibleCounter.
|
|
virtual void DecrementVisibleCounter() = 0;
|
|
|
|
//! Query whether the UI Cursor is currently visible
|
|
virtual bool IsUiCursorVisible() = 0;
|
|
|
|
//! Set the UI cursor image.
|
|
virtual void SetUiCursor(const char* cursorImagePath) = 0;
|
|
|
|
//! Get the UI cursor position (in pixels) relative
|
|
//! to the top-left corner of the UI overlay viewport
|
|
virtual AZ::Vector2 GetUiCursorPosition() = 0;
|
|
};
|
|
|
|
using UiCursorBus = AZ::EBus<UiCursorInterface>;
|
|
|