Nav2 Navigation Stack - rolling  main
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 
41 namespace dwb_critics
42 {
43 
44 void GoalAlignCritic::onInit()
45 {
46  GoalDistCritic::onInit();
47  stop_on_failure_ = false;
48 
49  auto node = node_.lock();
50  if (!node) {
51  throw std::runtime_error{"Failed to lock node"};
52  }
53 
54  forward_point_distance_ = node->declare_or_get_parameter(dwb_plugin_name_ + "." + name_ +
55  ".forward_point_distance", 0.325);
56 }
57 
59  const geometry_msgs::msg::Pose & pose, const nav_2d_msgs::msg::Twist2D & vel,
60  const geometry_msgs::msg::Pose & goal,
61  const nav_msgs::msg::Path & global_plan)
62 {
63  // we want the robot nose to be drawn to its final position
64  // (before robot turns towards goal orientation), not the end of the
65  // path for the robot center. Choosing the final position after
66  // turning towards goal orientation causes instability when the
67  // robot needs to make a 180 degree turn at the end
68  double angle_to_goal = atan2(goal.position.y - pose.position.y,
69  goal.position.x - pose.position.x);
70 
71  nav_msgs::msg::Path target_poses = global_plan;
72  target_poses.poses.back().pose.position.x += forward_point_distance_ * cos(angle_to_goal);
73  target_poses.poses.back().pose.position.y += forward_point_distance_ * sin(angle_to_goal);
74 
75  return GoalDistCritic::prepare(pose, vel, goal, target_poses);
76 }
77 
78 double GoalAlignCritic::scorePose(const geometry_msgs::msg::Pose & pose)
79 {
80  return GoalDistCritic::scorePose(getForwardPose(pose, forward_point_distance_));
81 }
82 
83 } // namespace dwb_critics
84 
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
bool prepare(const geometry_msgs::msg::Pose &pose, const nav_2d_msgs::msg::Twist2D &vel, const geometry_msgs::msg::Pose &goal, const nav_msgs::msg::Path &global_plan) override
Prior to evaluating any trajectories, look at contextual information constant across all trajectories...
Definition: goal_align.cpp:58
double scorePose(const geometry_msgs::msg::Pose &pose) override
Retrieve the score for a single pose.
Definition: goal_align.cpp:78
bool prepare(const geometry_msgs::msg::Pose &pose, const nav_2d_msgs::msg::Twist2D &vel, const geometry_msgs::msg::Pose &goal, const nav_msgs::msg::Path &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::Pose &pose)
Retrieve the score for a single pose.
Definition: map_grid.cpp:158