Nav2 Navigation Stack - kilted  kilted
ROS 2 Navigation Stack
goal_align.cpp
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2017, Locus Robotics
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above
14  * copyright notice, this list of conditions and the following
15  * disclaimer in the documentation and/or other materials provided
16  * with the distribution.
17  * * Neither the name of the copyright holder nor the names of its
18  * contributors may be used to endorse or promote products derived
19  * from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #include "dwb_critics/goal_align.hpp"
36 #include <vector>
37 #include <string>
38 #include "dwb_critics/alignment_util.hpp"
39 #include "pluginlib/class_list_macros.hpp"
40 #include "nav_2d_utils/parameters.hpp"
41 
42 namespace dwb_critics
43 {
44 
45 void GoalAlignCritic::onInit()
46 {
47  GoalDistCritic::onInit();
48  stop_on_failure_ = false;
49 
50  auto node = node_.lock();
51  if (!node) {
52  throw std::runtime_error{"Failed to lock node"};
53  }
54 
55  forward_point_distance_ = nav_2d_utils::searchAndGetParam(
56  node,
57  dwb_plugin_name_ + "." + name_ + ".forward_point_distance", 0.325);
58 }
59 
61  const geometry_msgs::msg::Pose2D & pose, const nav_2d_msgs::msg::Twist2D & vel,
62  const geometry_msgs::msg::Pose2D & goal,
63  const nav_2d_msgs::msg::Path2D & global_plan)
64 {
65  // we want the robot nose to be drawn to its final position
66  // (before robot turns towards goal orientation), not the end of the
67  // path for the robot center. Choosing the final position after
68  // turning towards goal orientation causes instability when the
69  // robot needs to make a 180 degree turn at the end
70  double angle_to_goal = atan2(goal.y - pose.y, goal.x - pose.x);
71 
72  nav_2d_msgs::msg::Path2D target_poses = global_plan;
73  target_poses.poses.back().x += forward_point_distance_ * cos(angle_to_goal);
74  target_poses.poses.back().y += forward_point_distance_ * sin(angle_to_goal);
75 
76  return GoalDistCritic::prepare(pose, vel, goal, target_poses);
77 }
78 
79 double GoalAlignCritic::scorePose(const geometry_msgs::msg::Pose2D & pose)
80 {
81  return GoalDistCritic::scorePose(getForwardPose(pose, forward_point_distance_));
82 }
83 
84 } // namespace dwb_critics
85 
Evaluates a Trajectory2D to produce a score.
Scores trajectories based on whether the robot ends up pointing toward the eventual goal.
Definition: goal_align.hpp:53
double scorePose(const geometry_msgs::msg::Pose2D &pose) override
Retrieve the score for a single pose.
Definition: goal_align.cpp:79
bool prepare(const geometry_msgs::msg::Pose2D &pose, const nav_2d_msgs::msg::Twist2D &vel, const geometry_msgs::msg::Pose2D &goal, const nav_2d_msgs::msg::Path2D &global_plan) override
Prior to evaluating any trajectories, look at contextual information constant across all trajectories...
Definition: goal_align.cpp:60
bool prepare(const geometry_msgs::msg::Pose2D &pose, const nav_2d_msgs::msg::Twist2D &vel, const geometry_msgs::msg::Pose2D &goal, const nav_2d_msgs::msg::Path2D &global_plan) override
Prior to evaluating any trajectories, look at contextual information constant across all trajectories...
Definition: goal_dist.cpp:43
virtual double scorePose(const geometry_msgs::msg::Pose2D &pose)
Retrieve the score for a single pose.
Definition: map_grid.cpp:158