GazeController.h

Go to the documentation of this file.

/*
 * This file is part of ArmarX.
 *
 * ArmarX is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * ArmarX is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 * @package    view_selection
 * @author     Johann Mantel
 * @date       2020
 * @copyright  http://www.gnu.org/licenses/gpl-2.0.txt
 *             GNU General Public License
 */
 
#pragma once
 
#include <VirtualRobot/VirtualRobot.h>
 
#include <RobotAPI/components/units/RobotUnit/NJointControllers/NJointControllerBase.h>
#include <RobotAPI/components/units/RobotUnit/NJointControllers/NJointControllerWithTripleBuffer.h>
 
#include <armarx/control/interface/ConfigurableNJointControllerInterface.h>
#include <armarx/view_selection/gaze_controller/hemisphere/aron/ControllerConfig.aron.generated.h>
#include <armarx/view_selection/gaze_controller/types.h>
#include <armarx/view_selection/gaze_targets/GazeTarget.h>
 
namespace armarx
{
    class ControlTarget1DoFActuatorPosition;
}
 
namespace armarx::view_selection::gaze_controller::gaze_ik
{
    TYPEDEF_PTRS_HANDLE(GazeController);
 
    struct Params
    {
        std::string nodeSetName;
        bool enableJointLimitAvoidance;
        float maxPositionError;
        std::size_t maxLoops;
        std::size_t maxGradientDecentSteps;
    };
 
    struct Config
    {
        Params params;
        std::optional<armarx::view_selection::gaze_controller::Target> target;
    };
 
    using ControlTarget = std::vector<float>;
 
    /**
    * @defgroup Component-GazeControl GazeControl
    * @ingroup ActiveVision-Components
    * A description of the component GazeControl.
    *
    * @class GazeControl
    * @ingroup Component-GazeControl
    * @brief Brief description of class GazeControl.
    *
    * Detailed description of class GazeControl.
    */
    class GazeController :
        virtual public NJointControllerWithTripleBuffer<ControlTarget>,
        virtual public armarx::control::ConfigurableNJointControllerInterface
    {
    public:
        using ConfigPtrT = control::ConfigurableNJointControllerConfigPtr;
 
        GazeController(RobotUnitPtr robotUnit,
                       const NJointControllerConfigPtr& config,
                       const VirtualRobot::RobotPtr& robot);
 
        ~GazeController() override;
 
        void updateConfig(const ::armarx::aron::data::dto::DictPtr& dto,
                          const Ice::Current& iceCurrent = Ice::emptyCurrent) override;
 
        ::armarx::aron::data::dto::DictPtr
        getConfig(const ::Ice::Current& = ::Ice::emptyCurrent) override;
 
 
    protected:
        // NJointControllerInterface interface
        void onInitNJointController() override;
 
        // NJointControllerInterface interface
        void onConnectNJointController() override;
 
        // NJointControllerInterface interface
        std::string getClassName(const Ice::Current& = Ice::emptyCurrent) const override;
 
        // NJointController interface
        void rtRun(const IceUtil::Time& sensorValuesTimestamp,
                   const IceUtil::Time& timeSinceLastIteration) override;
 
        // NJointController interface
        void onPublish(const SensorAndControl&,
                       const DebugDrawerInterfacePrx&,
                       const DebugObserverInterfacePrx&) override;
 
        void rtPreActivateController() override;
 
        void rtPostDeactivateController() override;
 
    private:
        // void publishTarget(const armarx::view_selection::gaze_targets::GazeTarget& target);
        void removeTarget();
        void additionalTask();
 
        // rt variables
        VirtualRobot::RobotPtr _rtRobot;
 
        struct RobotState
        {
            std::vector<float> jointValues;
            // armarx::NameValueMap jointPositions;
            Eigen::Matrix4f globalRobotPose;
        };
 
        TripleBuffer<RobotState> _robotStateBuffer_rtToAdditionalTask;
        TripleBuffer<Config> _configBuffer_updateConfigToAdditionalTask;
        VirtualRobot::RobotPtr _robotAdditionalTask;
        VirtualRobot::RobotNodePrismaticPtr _virtualPrismaticJoint;
        VirtualRobot::RobotNodeSetPtr _headNodeSet;
        std::unique_ptr<VirtualRobot::GazeIK> _gazeIK;
 
        std::vector<VirtualRobot::RobotNodePtr> _rtRobotNodes;
 
        // node names for RobotState::jointValues
        std::vector<std::string> _additionalTaskRobotNodeNames;
 
 
        std::vector<armarx::ControlTarget1DoFActuatorPosition*> _rtCtrlTargets;
 
        // publishing
        TripleBuffer<armarx::view_selection::gaze_targets::GazeTarget>
            _gazeTarget_rtRunToPublishing;
 
        std::atomic<float> _publishCurrentPitchAngle = 0.0;
        std::atomic<float> _publishCurrentYawAngle = 0.0;
        std::atomic<float> _publishTargetPitchAngle = 0.0;
        std::atomic<float> _publishTargetYawAngle = 0.0;
 
        std::atomic_bool rtReady = false;
    };
} // namespace armarx::view_selection::gaze_controller::gaze_ik