AStarWithOrientation.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/>.
 *
 * @author     Niklas Arlt ( niklas dot arlt at kit dot edu )
 * @date       2025
 * @copyright  http://www.gnu.org/licenses/gpl-2.0.txt
 *             GNU General Public License
 */
 
#pragma once
 
#include <optional>
 
#include <RobotAPI/libraries/aron/core/data/variant/forward_declarations.h>
 
#include <armarx/navigation/algorithms/orientation_aware/Costmap3D.h>
#include <armarx/navigation/core/basic_types.h>
#include <armarx/navigation/core/types.h>
#include <armarx/navigation/global_planning/GlobalPlanner.h>
#include <armarx/navigation/global_planning/core.h>
 
namespace armarx::navigation::global_planning
{
 
    /**
    * @brief Parameters for AStarWithOrientation
    *
    */
    struct AStarWithOrientationParams : public GlobalPlannerParams
    {
        bool includeStartPose{true};
 
        Algorithms algorithm() const override;
        aron::data::DictPtr toAron() const override;
 
        static AStarWithOrientationParams FromAron(const aron::data::DictPtr& dict);
    };
 
    // Implementation class with only the necessary interface
    class AStarWithOrientationImpl
    {
    public:
        using Params = AStarWithOrientationParams;
 
        AStarWithOrientationImpl(
            const Params& params,
            const std::optional<navigation::algorithms::orientation_aware::Costmap3D>& costmap,
            VirtualRobot::RobotPtr robot);
 
        void updateCostmap(const std::optional<navigation::algorithms::orientation_aware::Costmap3D>& costmap);
 
        std::optional<GlobalPlannerResult> plan(const core::Pose& start, const core::Pose& goal);
 
        void visualizeDebugInfo(viz::Client& vizClient,
                                const std::string& vizLayerNamePrefix = "global_planner_debug");
 
    protected:
        Params params;
        std::optional<navigation::algorithms::orientation_aware::Costmap3D> costmap;
        VirtualRobot::RobotPtr robot;
 
    private:
        // state from last execution
        std::vector<core::GlobalTrajectoryPoint> lastPointsInCollision;
    };
 
    /**
    * @class AStarWithOrientation
    * @ingroup Library-GlobalPlanner
    *
    * Implements an A* planner but is compatible with non-circular robots.
    * Compared to circular robots, the orientation of non-circular robots is important to not collide with obstacles.
    *
    * This class is the integration class for the GlobalPanner base class.
    */
    class AStarWithOrientation : virtual public GlobalPlanner
    {
    public:
        using Params = AStarWithOrientationParams;
 
        AStarWithOrientation(const Params& params,
                             const core::GeneralConfig& generalConfig,
                             const core::Scene& ctx);
 
        std::optional<GlobalPlannerResult> plan(const core::Pose& goal) override;
        std::optional<GlobalPlannerResult> plan(const core::Pose& start,
                                                const core::Pose& goal) override;
 
        using GlobalPlanner::visualizeDebugInfo;
        void
        visualizeDebugInfo(viz::Client& vizClient,
                           const std::string& vizLayerNamePrefix = "global_planner_debug") override;
 
    protected:
        AStarWithOrientationImpl impl;
    };
 
} // namespace armarx::navigation::global_planning