/*********************************************************************

 * Software License Agreement (BSD License)

 *

 *  Copyright (c) 2013, SRI International

 *  All rights reserved.

 *

 *  Redistribution and use in source and binary forms, with or without

 *  modification, are permitted provided that the following conditions

 *  are met:

 *

 *   * Redistributions of source code must retain the above copyright

 *     notice, this list of conditions and the following disclaimer.

 *   * Redistributions in binary form must reproduce the above

 *     copyright notice, this list of conditions and the following

 *     disclaimer in the documentation and/or other materials provided

 *     with the distribution.

 *   * Neither the name of SRI International nor the names of its

 *     contributors may be used to endorse or promote products derived

 *     from this software without specific prior written permission.

 *

 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS

 *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE

 *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,

 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,

 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER

 *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN

 *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

 *  POSSIBILITY OF SUCH DAMAGE.

 *********************************************************************/

/* Author: Sachin Chitta, Dave Coleman, Mike Lautman */

#include <moveit/move_group_interface/move_group_interface.h>

#include <moveit/planning_scene_interface/planning_scene_interface.h>

#include <moveit_msgs/DisplayRobotState.h>

#include <moveit_msgs/DisplayTrajectory.h>

#include <moveit_msgs/AttachedCollisionObject.h>

#include <moveit_msgs/CollisionObject.h>

#include <moveit_visual_tools/moveit_visual_tools.h>

int main(int argc, char** argv)

{

  ros::init(argc, argv, "move_group_interface_tutorial");

  ros::NodeHandle node_handle;

  ros::AsyncSpinner spinner(1);

  spinner.start();

  // BEGIN_TUTORIAL

  //

  // Setup

  // ^^^^^

  //

  // are used interchangably.

  // MoveIt! operates on sets of joints called "planning groups" and stores them in an object called

  // the `JointModelGroup`. Throughout MoveIt! the terms "planning group" and "joint model group"

//MoveIt！對稱為“計劃組”的關節集進行操作，並將它們儲存在名為JointModelGroup的物件中。整個MoveIt！術語“計劃組”和“聯合模型組”可互換使用。//

  static const std::string PLANNING_GROUP = "panda_arm";

  // The :move_group_interface:`MoveGroup` class can be easily

  // setup using just the name of the planning group you would like to control and plan for.

 // 該MoveGroup類可以輕鬆設定使用規劃小組的只是名字，你想控制和規劃。

  moveit::planning_interface::MoveGroupInterface move_group(PLANNING_GROUP);

//我們將使用PlanningSceneInterface 類在“虛擬世界”場景中新增和刪除碰撞物件

  // We will use the :planning_scene_interface:`PlanningSceneInterface`

  // class to add and remove collision objects in our "virtual world" scene

  moveit::planning_interface::PlanningSceneInterface planning_scene_interface;

//原始指標經常用於指代規劃組以提高效能。

  // Raw pointers are frequently used to refer to the planning group for improved performance.

  const robot_state::JointModelGroup* joint_model_group =

      move_group.getCurrentState()->getJointModelGroup(PLANNING_GROUP);

  // Visualization

  // ^^^^^^^^^^^^^

  //MoveItVisualTools包提供了許多功能，可用於視覺化RViz中的物件，機器人和軌跡以及除錯工具，

  // The package MoveItVisualTools provides many capabilties for visualizing objects, robots,

  // and trajectories in RViz as well as debugging tools such as step-by-step introspection of a script

  namespace rvt = rviz_visual_tools;

  moveit_visual_tools::MoveItVisualTools visual_tools("panda_link0");

  visual_tools.deleteAllMarkers();

  // Remote control is an introspection tool that allows users to step through a high level script

  // via buttons and keyboard shortcuts in RViz

  //Remote控制是一種內省工具，允許使用者通過RViz中的按鈕和鍵盤快捷鍵逐步執行高階指令碼

  visual_tools.loadRemoteControl();

//RViz提供了許多型別的標記，在本演示中我們將使用文字，圓柱和球體

  // RViz provides many types of markers, in this demo we will use text, cylinders, and spheres

  Eigen::Affine3d text_pose = Eigen::Affine3d::Identity();

  text_pose.translation().z() = 1.75;

  visual_tools.publishText(text_pose, "MoveGroupInterface Demo", rvt::WHITE, rvt::XLARGE);

//批量釋出用於減少為大型視覺化傳送到RViz的訊息數

  // Batch publishing is used to reduce the number of messages being sent to RViz for large visualizations

  visual_tools.trigger();

  // Getting Basic Information

  // ^^^^^^^^^^^^^^^^^^^^^^^^^

  //我們可以列印這個機器人的參考框架的名稱。

  // We can print the name of the reference frame for this robot.

  ROS_INFO_NAMED("tutorial", "Reference frame: %s", move_group.getPlanningFrame().c_str());

//我們還可以列印該組的末端效應器連結的名稱。

  // We can also print the name of the end-effector link for this group.

  ROS_INFO_NAMED("tutorial", "End effector link: %s", move_group.getEndEffectorLink().c_str());

  // Start the demo

  // ^^^^^^^^^^^^^^^^^^^^^^^^^

  visual_tools.prompt("Press 'next' in the RvizVisualToolsGui window to start the demo");

  // Planning to a Pose goal

  // ^^^^^^^^^^^^^^^^^^^^^^^

  //我們可以為這個組計劃一個運動，使其達到最終效果器所需的姿勢。

  // We can plan a motion for this group to a desired pose for the

  // end-effector.

  geometry_msgs::Pose target_pose1;

  target_pose1.orientation.w = 1.0;

  target_pose1.position.x = 0.28;

  target_pose1.position.y = -0.2;

  target_pose1.position.z = 0.5;

  move_group.setPoseTarget(target_pose1);

  // Now, we call the planner to compute the plan and visualize it.

  // Note that we are just planning, not asking move_group

  // to actually move the robot.

  //現在，我們呼叫規劃器來計算計劃並將其視覺化。請注意，我們只是計劃，而不是要求move_group實際移動機器人。

  moveit::planning_interface::MoveGroupInterface::Plan my_plan;

  bool success = (move_group.plan(my_plan) == moveit::planning_interface::MoveItErrorCode::SUCCESS);

  ROS_INFO_NAMED("tutorial", "Visualizing plan 1 (pose goal) %s", success ? "" : "FAILED");

  // Visualizing plans

  // ^^^^^^^^^^^^^^^^^

  // We can also visualize the plan as a line with markers in RViz.

  //視覺化為帶有RViz中標記的線。

  ROS_INFO_NAMED("tutorial", "Visualizing plan 1 as trajectory line");

  visual_tools.publishAxisLabeled(target_pose1, "pose1");

  visual_tools.publishText(text_pose, "Pose Goal", rvt::WHITE, rvt::XLARGE);

  visual_tools.publishTrajectoryLine(my_plan.trajectory_, joint_model_group);

  visual_tools.trigger();

  visual_tools.prompt("Press 'next' in the RvizVisualToolsGui window to continue the demo");

  // Moving to a pose goal

  // ^^^^^^^^^^^^^^^^^^^^^

  //

  // Moving to a pose goal is similar to the step above

  // except we now use the move() function. Note that

  // the pose goal we had set earlier is still active

  // and so the robot will try to move to that goal. We will

  // not use that function in this tutorial since it is

  // a blocking function and requires a controller to be active

  // and report success on execution of a trajectory.

  /* Uncomment below line when working with a real robot */

  /* move_group.move(); */

  // Planning to a joint-space goal

  // ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

  //

  // Let's set a joint space goal and move towards it.  This will replace the

  // pose target we set above.

  //

  // To start, we'll create an pointer that references the current robot's state.

  // RobotState is the object that contains all the current position/velocity/acceleration data.

  //移動到姿勢目標與上面的步驟類似，除了我們現在使用move（）函式。請注意，我們之前設定的姿勢目標仍處於活動狀態，

  //因此機器人將嘗試移動到該目標。我們不會在本教程中使用該函式，因為它是一個阻塞函式，需要一個控制器處於活動狀態並報告執行軌跡的成功。

    //讓我們設定一個聯合空間目標並向它邁進。這將取代我們上面設定的姿勢目標。

//首先，我們將建立一個引用當前機器人狀態的指標。RobotState是包含所有當前位置/速度/加速度資料的物件。

  moveit::core::RobotStatePtr current_state = move_group.getCurrentState();

//接下來獲取該組的當前關節集合。

  // Next get the current set of joint values for the group.

  std::vector<double> joint_group_positions;

  current_state->copyJointGroupPositions(joint_model_group, joint_group_positions);

  // Now, let's modify one of the joints, plan to the new joint space goal and visualize the plan.

 // 現在，讓我們修改其中一個關節，計劃新的關節空間目標並可視化計劃。(1弧度)

  joint_group_positions [0] = -1.0;  // radians

  move_group.setJointValueTarget(joint_group_positions);

  success = (move_group.plan(my_plan) == moveit::planning_interface::MoveItErrorCode::SUCCESS);

  ROS_INFO_NAMED("tutorial", "Visualizing plan 2 (joint space goal) %s", success ? "" : "FAILED");

  // Visualize the plan in RViz

  visual_tools.deleteAllMarkers();

  visual_tools.publishText(text_pose, "Joint Space Goal", rvt::WHITE, rvt::XLARGE);

  visual_tools.publishTrajectoryLine(my_plan.trajectory_, joint_model_group);

  visual_tools.trigger();

  visual_tools.prompt("Press 'next' in the RvizVisualToolsGui window to continue the demo");

  // Planning with Path Constraints

  // ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

  //可以輕鬆地為機器人上的連結指定路徑約束。讓我們為我們的組指定路徑約束和姿勢目標。首先定義路徑約束。

  // Path constraints can easily be specified for a link on the robot.

  // Let's specify a path constraint and a pose goal for our group.

  // First define the path constraint.

  moveit_msgs::OrientationConstraint ocm;

  ocm.link_name = "panda_link7";

  ocm.header.frame_id = "panda_link0";

  ocm.orientation.w = 1.0;

  ocm.absolute_x_axis_tolerance = 0.1;

  ocm.absolute_y_axis_tolerance = 0.1;

  ocm.absolute_z_axis_tolerance = 0.1;

  ocm.weight = 1.0;

  // Now, set it as the path constraint for the group.

  //現在，將其設定為組的路徑約束。

  moveit_msgs::Constraints test_constraints;

  test_constraints.orientation_constraints.push_back(ocm);

  move_group.setPathConstraints(test_constraints);

  // We will reuse the old goal that we had and plan to it.

  // Note that this will only work if the current state already

  // satisfies the path constraints. So, we need to set the start

  // state to a new pose.

  //我們將重用我們擁有的舊目標並計劃它。請注意，這僅在當前狀態已滿足路徑約束時才有效。因此，我們需要將開始狀態設定為新姿勢。

  robot_state::RobotState start_state(*move_group.getCurrentState());

  geometry_msgs::Pose start_pose2;

  start_pose2.orientation.w = 1.0;

  start_pose2.position.x = 0.55;

  start_pose2.position.y = -0.05;

  start_pose2.position.z = 0.8;

  start_state.setFromIK(joint_model_group, start_pose2);

  move_group.setStartState(start_state);

//現在我們將從剛剛建立的新啟動狀態計劃更早的姿勢目標。

  // Now we will plan to the earlier pose target from the new

  // start state that we have just created.

  move_group.setPoseTarget(target_pose1);

  // Planning with constraints can be slow because every sample must call an inverse kinematics solver.

  // Lets increase the planning time from the default 5 seconds to be sure the planner has enough time to succeed.

  //使用約束進行規劃可能會很慢，因為每個樣本都必須呼叫反向運動學求解器。讓我們將計劃時間從預設的5秒增加到確保規劃人員有足夠的時間成功。

  move_group.setPlanningTime(10.0);

  success = (move_group.plan(my_plan) == moveit::planning_interface::MoveItErrorCode::SUCCESS);

  ROS_INFO_NAMED("tutorial", "Visualizing plan 3 (constraints) %s", success ? "" : "FAILED");

  // Visualize the plan in RViz

  visual_tools.deleteAllMarkers();

  visual_tools.publishAxisLabeled(start_pose2, "start");

  visual_tools.publishAxisLabeled(target_pose1, "goal");

  visual_tools.publishText(text_pose, "Constrained Goal", rvt::WHITE, rvt::XLARGE);

  visual_tools.publishTrajectoryLine(my_plan.trajectory_, joint_model_group);

  visual_tools.trigger();

  visual_tools.prompt("next step");

  // When done with the path constraint be sure to clear it.

  move_group.clearPathConstraints();

  // Since we set the start state we have to clear it before planning other paths

  move_group.setStartStateToCurrentState();

  // Cartesian Paths

  // ^^^^^^^^^^^^^^^

  // You can plan a Cartesian path directly by specifying a list of waypoints

  // for the end-effector to go through. Note that we are starting

  // from the new start state above.  The initial pose (start state) does not

  // need to be added to the waypoint list but adding it can help with visualizations

  //您可以通過指定末端執行器經過的航點列表來直接規劃笛卡爾路徑。請注意，我們從上面的新開始狀態開始。初始姿勢（開始狀態）不需要新增到航點列表，但新增它可以幫助進行視覺化

  geometry_msgs::Pose target_pose3 = move_group.getCurrentPose().pose;

  std::vector<geometry_msgs::Pose> waypoints;

  waypoints.push_back(target_pose3);

  target_pose3.position.z -= 0.2;

  waypoints.push_back(target_pose3);  // down

  target_pose3.position.y -= 0.2;

  waypoints.push_back(target_pose3);  // right

  target_pose3.position.z += 0.2;

  target_pose3.position.y += 0.2;

  target_pose3.position.x -= 0.2;

  waypoints.push_back(target_pose3);  // up and left

  // Cartesian motions are frequently needed to be slower for actions such as approach and retreat

  // grasp motions. Here we demonstrate how to reduce the speed of the robot arm via a scaling factor

  // of the maxiumum speed of each joint. Note this is not the speed of the end effector point.

  //對於諸如逼近和撤退抓握動作之類的動作，笛卡爾運動經常需要較慢。在這裡，我們演示瞭如何通過每個關節的最大速度的比例因子來降低機器人手臂的速度。請注意，這不是末端執行器點的速度。

  move_group.setMaxVelocityScalingFactor(0.1);

  // We want the Cartesian path to be interpolated at a resolution of 1 cm

  // which is why we will specify 0.01 as the max step in Cartesian

  // translation.  We will specify the jump threshold as 0.0, effectively disabling it.

  // Warning - disabling the jump threshold while operating real hardware can cause

  // large unpredictable motions of redundant joints and could be a safety issue

  //我們希望笛卡爾路徑以1 cm的解析度進行插值，這就是為什麼我們將指定0.01作為笛卡爾平移的最大步長。我們將跳轉閾值指定為0.0，

  //從而有效地禁用它。警告 - 在操作真實硬體時禁用跳轉閾值可能會導致冗餘關節的大量不可預測的運動，這可能是一個安全問題

  moveit_msgs::RobotTrajectory trajectory;

  const double jump_threshold = 0.0;

  const double eef_step = 0.01;

  double fraction = move_group.computeCartesianPath(waypoints, eef_step, jump_threshold, trajectory);

  ROS_INFO_NAMED("tutorial", "Visualizing plan 4 (Cartesian path) (%.2f%% acheived)", fraction * 100.0);

  // Visualize the plan in RViz

  visual_tools.deleteAllMarkers();

  visual_tools.publishText(text_pose, "Joint Space Goal", rvt::WHITE, rvt::XLARGE);

  visual_tools.publishPath(waypoints, rvt::LIME_GREEN, rvt::SMALL);

  for (std::size_t i = 0; i < waypoints.size(); ++i)

    visual_tools.publishAxisLabeled(waypoints[i], "pt" + std::to_string(i), rvt::SMALL);

  visual_tools.trigger();

  visual_tools.prompt("Press 'next' in the RvizVisualToolsGui window to continue the demo");

  // Adding/Removing Objects and Attaching/Detaching Objects

  // ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

  //定義衝突物件ROS訊息。

  // Define a collision object ROS message.

  moveit_msgs::CollisionObject collision_object;

  collision_object.header.frame_id = move_group.getPlanningFrame();

  // The id of the object is used to identify it.

  collision_object.id = "box1";

  // Define a box to add to the world.

  //定義一個框以新增到世界中。

  shape_msgs::SolidPrimitive primitive;

  primitive.type = primitive.BOX;

  primitive.dimensions.resize(3);

  primitive.dimensions[0] = 0.4;

  primitive.dimensions[1] = 0.1;

  primitive.dimensions[2] = 0.4;

  // Define a pose for the box (specified relative to frame_id)

  //為框定義一個姿勢

  geometry_msgs::Pose box_pose;

  box_pose.orientation.w = 1.0;

  box_pose.position.x = 0.4;

  box_pose.position.y = -0.2;

  box_pose.position.z = 1.0;

  collision_object.primitives.push_back(primitive);

  collision_object.primitive_poses.push_back(box_pose);

  collision_object.operation = collision_object.ADD;

  std::vector<moveit_msgs::CollisionObject> collision_objects;

  collision_objects.push_back(collision_object);

  // Now, let's add the collision object into the world

  ROS_INFO_NAMED("tutorial", "Add an object into the world");

  planning_scene_interface.addCollisionObjects(collision_objects);

  // Show text in RViz of status

  visual_tools.publishText(text_pose, "Add object", rvt::WHITE, rvt::XLARGE);

  visual_tools.trigger();

  // Wait for MoveGroup to recieve and process the collision object message

  visual_tools.prompt("Press 'next' in the RvizVisualToolsGui window to once the collision object appears in RViz");

  // Now when we plan a trajectory it will avoid the obstacle

  move_group.setStartState(*move_group.getCurrentState());

  geometry_msgs::Pose another_pose;

  another_pose.orientation.w = 1.0;

  another_pose.position.x = 0.4;

  another_pose.position.y = -0.4;

  another_pose.position.z = 0.9;

  move_group.setPoseTarget(another_pose);

  success = (move_group.plan(my_plan) == moveit::planning_interface::MoveItErrorCode::SUCCESS);

  ROS_INFO_NAMED("tutorial", "Visualizing plan 5 (pose goal move around cuboid) %s", success ? "" : "FAILED");

  // Visualize the plan in RViz

  visual_tools.deleteAllMarkers();

  visual_tools.publishText(text_pose, "Obstacle Goal", rvt::WHITE, rvt::XLARGE);

  visual_tools.publishTrajectoryLine(my_plan.trajectory_, joint_model_group);

  visual_tools.trigger();

  visual_tools.prompt("next step");

  // Now, let's attach the collision object to the robot.

  ROS_INFO_NAMED("tutorial", "Attach the object to the robot");

  move_group.attachObject(collision_object.id);

  // Show text in RViz of status

  visual_tools.publishText(text_pose, "Object attached to robot", rvt::WHITE, rvt::XLARGE);

  visual_tools.trigger();

  /* Wait for MoveGroup to recieve and process the attached collision object message */

  visual_tools.prompt("Press 'next' in the RvizVisualToolsGui window to once the collision object attaches to the "

                      "robot");

  // Now, let's detach the collision object from the robot.

  ROS_INFO_NAMED("tutorial", "Detach the object from the robot");

  move_group.detachObject(collision_object.id);

  // Show text in RViz of status

  visual_tools.publishText(text_pose, "Object dettached from robot", rvt::WHITE, rvt::XLARGE);

  visual_tools.trigger();

  /* Wait for MoveGroup to recieve and process the attached collision object message */

  visual_tools.prompt("Press 'next' in the RvizVisualToolsGui window to once the collision object detaches to the "

                      "robot");

  // Now, let's remove the collision object from the world.

  ROS_INFO_NAMED("tutorial", "Remove the object from the world");

  std::vector<std::string> object_ids;

  object_ids.push_back(collision_object.id);

  planning_scene_interface.removeCollisionObjects(object_ids);

  // Show text in RViz of status

  visual_tools.publishText(text_pose, "Object removed", rvt::WHITE, rvt::XLARGE);

  visual_tools.trigger();

  /* Wait for MoveGroup to recieve and process the attached collision object message */

  visual_tools.prompt("Press 'next' in the RvizVisualToolsGui window to once the collision object disapears");

  // END_TUTORIAL

  ros::shutdown();

  return 0;

}