o3de/Gems/VirtualGamepad/Code/Source/VirtualGamepadButtonRequestBus.h

/*
 * 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/std/string/string.h>

////////////////////////////////////////////////////////////////////////////////////////////////////
namespace VirtualGamepad
{
    ////////////////////////////////////////////////////////////////////////////////////////////////
    class VirtualGamepadButtonRequests : public AZ::EBusTraits
    {
    public:
        ////////////////////////////////////////////////////////////////////////////////////////////
        // EBusTraits overrides
        static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::ById;
        static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single;
        using BusIdType = AZStd::string;

        ////////////////////////////////////////////////////////////////////////////////////////////
        //! Query whether the virtual button is currently pressed or not
        //! \return True if the virtual button is currently pressed, false otherwise
        virtual bool IsPressed() const = 0;
    };
    using VirtualGamepadButtonRequestBus = AZ::EBus<VirtualGamepadButtonRequests>;
}