o3de-extras/Gems/ROS2Controllers/Code/Source/Manipulation/Controllers/JointsArticulationControllerComponent.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/Component/Component.h>
#include <ROS2Controllers/Manipulation/Controllers/JointsPositionControllerRequests.h>
#include <ROS2Controllers/ROS2ControllersTypeIds.h>

namespace ROS2
{
    //! Handles position control commands for joints using Articulations.
    class JointsArticulationControllerComponent
        : public AZ::Component
        , public JointsPositionControllerRequestBus::Handler
    {
    public:
        JointsArticulationControllerComponent() = default;
        ~JointsArticulationControllerComponent() = default;
        AZ_COMPONENT(JointsArticulationControllerComponent, ROS2Controllers::JointsArticulationControllerComponentTypeId, AZ::Component);

        static void GetRequiredServices(AZ::ComponentDescriptor::DependencyArrayType& required);
        static void GetProvidedServices(AZ::ComponentDescriptor::DependencyArrayType& provided);
        static void GetIncompatibleServices(AZ::ComponentDescriptor::DependencyArrayType& incompatible);
        static void Reflect(AZ::ReflectContext* context);

        // JointsPositionControllerRequestBus::Handler overrides ...
        //! @see ROS2::JointsPositionControllerRequestBus::SupportsArticulation
        bool SupportsArticulation() override
        {
            return true;
        }

        //! @see ROS2::JointsPositionControllerRequestBus::SupportsClassicJoints
        bool SupportsClassicJoints() override
        {
            return false;
        }

        //! @see ROS2::JointsPositionControllerRequestBus::PositionControl
        AZ::Outcome<void, AZStd::string> PositionControl(
            const AZStd::string& jointName,
            JointInfo joint,
            JointPosition currentPosition,
            JointPosition targetPosition,
            float deltaTime) override;

    private:
        // Component overrides ...
        void Activate() override;
        void Deactivate() override;
    };
} // namespace ROS2