conversions.cpp

Go to the documentation of this file.

/*********************************************************************
 * Software License Agreement (BSD License)
 *
 *  Copyright (c) 2013, Ioan A. Sucan
 *  Copyright (c) 2011-2013, Willow Garage, Inc.
 *  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 the Willow Garage 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: Ioan Sucan, Dave Coleman */
 
#include <boost/variant.hpp>
#include <moveit/robot_state/conversions.h>
#include <geometric_shapes/shape_operations.h>
#include <rclcpp/logger.hpp>
#include <rclcpp/logging.hpp>
#include <tf2_eigen/tf2_eigen.hpp>
#include <string>
#include <moveit/utils/logger.hpp>
 
namespace moveit
{
namespace core
{
 
// ********************************************
// * Internal (hidden) functions
// ********************************************
namespace
{
rclcpp::Logger getLogger()
{
  return moveit::getLogger("conversions");
}
 
bool jointStateToRobotStateImpl(const sensor_msgs::msg::JointState& joint_state, RobotState& state)
{
  if (joint_state.name.size() != joint_state.position.size())
  {
    RCLCPP_ERROR(getLogger(), "Different number of names and positions in JointState message: %zu, %zu",
                 joint_state.name.size(), joint_state.position.size());
    return false;
  }
 
  state.setVariableValues(joint_state);
 
  return true;
}
 
bool multiDofJointsToRobotState(const sensor_msgs::msg::MultiDOFJointState& mjs, RobotState& state, const Transforms* tf)
{
  std::size_t nj = mjs.joint_names.size();
  if (nj != mjs.transforms.size())
  {
    RCLCPP_ERROR(getLogger(), "Different number of names, values or frames in MultiDOFJointState message.");
    return false;
  }
 
  bool error = false;
  Eigen::Isometry3d inv_t;
  bool use_inv_t = false;
 
  if (nj > 0 && !Transforms::sameFrame(mjs.header.frame_id, state.getRobotModel()->getModelFrame()))
  {
    if (tf)
    {
      try
      {
        // find the transform that takes the given frame_id to the desired fixed frame
        const Eigen::Isometry3d& t2fixed_frame = tf->getTransform(mjs.header.frame_id);
        // we update the value of the transform so that it transforms from the known fixed frame to the desired child
        // link
        inv_t = t2fixed_frame.inverse();
        use_inv_t = true;
      }
      catch (std::exception& ex)
      {
        RCLCPP_ERROR(getLogger(), "Caught %s", ex.what());
        error = true;
      }
    }
    else
    {
      error = true;
    }
 
    if (error)
    {
      RCLCPP_WARN(getLogger(),
                  "The transform for multi-dof joints was specified in frame '%s' "
                  "but it was not possible to transform that to frame '%s'",
                  mjs.header.frame_id.c_str(), state.getRobotModel()->getModelFrame().c_str());
    }
  }
 
  for (std::size_t i = 0; i < nj; ++i)
  {
    const std::string& joint_name = mjs.joint_names[i];
    if (!state.getRobotModel()->hasJointModel(joint_name))
    {
      RCLCPP_WARN(getLogger(), "No joint matching multi-dof joint '%s'", joint_name.c_str());
      error = true;
      continue;
    }
    Eigen::Isometry3d transf = tf2::transformToEigen(mjs.transforms[i]);
    // if frames do not mach, attempt to transform
    if (use_inv_t)
      transf = transf * inv_t;
 
    state.setJointPositions(joint_name, transf);
  }
 
  return !error;
}
 
void robotStateToMultiDofJointState(const RobotState& state, sensor_msgs::msg::MultiDOFJointState& mjs)
{
  const std::vector<const JointModel*>& js = state.getRobotModel()->getMultiDOFJointModels();
  mjs.joint_names.clear();
  mjs.transforms.clear();
  for (const JointModel* joint_model : js)
  {
    geometry_msgs::msg::TransformStamped p;
    if (state.dirtyJointTransform(joint_model))
    {
      Eigen::Isometry3d t;
      t.setIdentity();
      joint_model->computeTransform(state.getJointPositions(joint_model), t);
      p = tf2::eigenToTransform(t);
    }
    else
      p = tf2::eigenToTransform(state.getJointTransform(joint_model));
    mjs.joint_names.push_back(joint_model->getName());
    mjs.transforms.push_back(p.transform);
  }
  mjs.header.frame_id = state.getRobotModel()->getModelFrame();
}
 
class ShapeVisitorAddToCollisionObject : public boost::static_visitor<void>
{
public:
  ShapeVisitorAddToCollisionObject(moveit_msgs::msg::CollisionObject* obj) : boost::static_visitor<void>(), obj_(obj)
  {
  }
 
  void addToObject(const shapes::ShapeMsg& sm, const geometry_msgs::msg::Pose& pose)
  {
    pose_ = &pose;
    boost::apply_visitor(*this, sm);
  }
 
  void operator()(const shape_msgs::msg::Plane& shape_msg) const
  {
    obj_->planes.push_back(shape_msg);
    obj_->plane_poses.push_back(*pose_);
  }
 
  void operator()(const shape_msgs::msg::Mesh& shape_msg) const
  {
    obj_->meshes.push_back(shape_msg);
    obj_->mesh_poses.push_back(*pose_);
  }
 
  void operator()(const shape_msgs::msg::SolidPrimitive& shape_msg) const
  {
    obj_->primitives.push_back(shape_msg);
    obj_->primitive_poses.push_back(*pose_);
  }
 
private:
  moveit_msgs::msg::CollisionObject* obj_;
  const geometry_msgs::msg::Pose* pose_;
};
 
void attachedBodyToMsg(const AttachedBody& attached_body, moveit_msgs::msg::AttachedCollisionObject& aco)
{
  aco.link_name = attached_body.getAttachedLinkName();
  aco.detach_posture = attached_body.getDetachPosture();
  const std::set<std::string>& touch_links = attached_body.getTouchLinks();
  aco.touch_links.clear();
  for (const std::string& touch_link : touch_links)
    aco.touch_links.push_back(touch_link);
  aco.object.header.frame_id = aco.link_name;
  aco.object.id = attached_body.getName();
  aco.object.pose = tf2::toMsg(attached_body.getPose());
 
  aco.object.operation = moveit_msgs::msg::CollisionObject::ADD;
  const std::vector<shapes::ShapeConstPtr>& ab_shapes = attached_body.getShapes();
  const EigenSTL::vector_Isometry3d& shape_poses = attached_body.getShapePoses();
  ShapeVisitorAddToCollisionObject sv(&aco.object);
  aco.object.primitives.clear();
  aco.object.meshes.clear();
  aco.object.planes.clear();
  aco.object.primitive_poses.clear();
  aco.object.mesh_poses.clear();
  aco.object.plane_poses.clear();
  for (std::size_t j = 0; j < ab_shapes.size(); ++j)
  {
    shapes::ShapeMsg sm;
    if (shapes::constructMsgFromShape(ab_shapes[j].get(), sm))
    {
      geometry_msgs::msg::Pose p;
      p = tf2::toMsg(shape_poses[j]);
      sv.addToObject(sm, p);
    }
  }
  aco.object.subframe_names.clear();
  aco.object.subframe_poses.clear();
  for (const auto& frame_pair : attached_body.getSubframes())
  {
    aco.object.subframe_names.push_back(frame_pair.first);
    geometry_msgs::msg::Pose pose;
    pose = tf2::toMsg(frame_pair.second);
    aco.object.subframe_poses.push_back(pose);
  }
}
 
void msgToAttachedBody(const Transforms* tf, const moveit_msgs::msg::AttachedCollisionObject& aco, RobotState& state)
{
  if (aco.object.operation == moveit_msgs::msg::CollisionObject::ADD)
  {
    if (!aco.object.primitives.empty() || !aco.object.meshes.empty() || !aco.object.planes.empty())
    {
      if (aco.object.primitives.size() != aco.object.primitive_poses.size())
      {
        RCLCPP_ERROR(getLogger(), "Number of primitive shapes does not match "
                                  "number of poses in collision object message");
        return;
      }
 
      if (aco.object.meshes.size() != aco.object.mesh_poses.size())
      {
        RCLCPP_ERROR(getLogger(), "Number of meshes does not match number of poses in collision object message");
        return;
      }
 
      if (aco.object.planes.size() != aco.object.plane_poses.size())
      {
        RCLCPP_ERROR(getLogger(), "Number of planes does not match number of poses in collision object message");
        return;
      }
 
      if (aco.object.subframe_poses.size() != aco.object.subframe_names.size())
      {
        RCLCPP_ERROR(getLogger(), "Number of subframe poses does not match number of subframe names in message");
        return;
      }
 
      const LinkModel* lm = state.getLinkModel(aco.link_name);
      if (lm)
      {
        Eigen::Isometry3d object_pose;
        tf2::fromMsg(aco.object.pose, object_pose);
 
        std::vector<shapes::ShapeConstPtr> shapes;
        EigenSTL::vector_Isometry3d shape_poses;
        const auto num_shapes = aco.object.primitives.size() + aco.object.meshes.size() + aco.object.planes.size();
        shapes.reserve(num_shapes);
        shape_poses.reserve(num_shapes);
 
        auto append = [&shapes, &shape_poses](shapes::Shape* s, const geometry_msgs::msg::Pose& pose_msg) {
          if (!s)
            return;
          Eigen::Isometry3d pose;
          tf2::fromMsg(pose_msg, pose);
          shapes.emplace_back(shapes::ShapeConstPtr(s));
          shape_poses.emplace_back(std::move(pose));
        };
 
        for (std::size_t i = 0; i < aco.object.primitives.size(); ++i)
          append(shapes::constructShapeFromMsg(aco.object.primitives[i]), aco.object.primitive_poses[i]);
        for (std::size_t i = 0; i < aco.object.meshes.size(); ++i)
          append(shapes::constructShapeFromMsg(aco.object.meshes[i]), aco.object.mesh_poses[i]);
        for (std::size_t i = 0; i < aco.object.planes.size(); ++i)
          append(shapes::constructShapeFromMsg(aco.object.planes[i]), aco.object.plane_poses[i]);
 
        moveit::core::FixedTransformsMap subframe_poses;
        for (std::size_t i = 0; i < aco.object.subframe_poses.size(); ++i)
        {
          Eigen::Isometry3d p;
          tf2::fromMsg(aco.object.subframe_poses[i], p);
          std::string name = aco.object.subframe_names[i];
          subframe_poses[name] = p;
        }
 
        // Transform shape pose to link frame
        if (!Transforms::sameFrame(aco.object.header.frame_id, aco.link_name))
        {
          bool frame_found = false;
          Eigen::Isometry3d world_to_header_frame;
          world_to_header_frame = state.getFrameTransform(aco.object.header.frame_id, &frame_found);
          if (!frame_found)
          {
            if (tf && tf->canTransform(aco.object.header.frame_id))
            {
              world_to_header_frame = tf->getTransform(aco.object.header.frame_id);
            }
            else
            {
              world_to_header_frame.setIdentity();
              RCLCPP_ERROR(getLogger(),
                           "Cannot properly transform from frame '%s'. "
                           "The pose of the attached body may be incorrect",
                           aco.object.header.frame_id.c_str());
            }
          }
          object_pose = state.getGlobalLinkTransform(lm).inverse() * world_to_header_frame * object_pose;
        }
 
        if (shapes.empty())
        {
          RCLCPP_ERROR(getLogger(), "There is no geometry to attach to link '%s' as part of attached body '%s'",
                       aco.link_name.c_str(), aco.object.id.c_str());
        }
        else
        {
          if (state.clearAttachedBody(aco.object.id))
          {
            RCLCPP_DEBUG(getLogger(),
                         "The robot state already had an object named '%s' attached to link '%s'. "
                         "The object was replaced.",
                         aco.object.id.c_str(), aco.link_name.c_str());
          }
          state.attachBody(aco.object.id, object_pose, shapes, shape_poses, aco.touch_links, aco.link_name,
                           aco.detach_posture, subframe_poses);
          RCLCPP_DEBUG(getLogger(), "Attached object '%s' to link '%s'", aco.object.id.c_str(), aco.link_name.c_str());
        }
      }
    }
    else
      RCLCPP_ERROR(getLogger(), "The attached body for link '%s' has no geometry", aco.link_name.c_str());
  }
  else if (aco.object.operation == moveit_msgs::msg::CollisionObject::REMOVE)
  {
    if (!state.clearAttachedBody(aco.object.id))
    {
      RCLCPP_ERROR(getLogger(), "The attached body '%s' can not be removed because it does not exist",
                   aco.link_name.c_str());
    }
  }
  else
    RCLCPP_ERROR(getLogger(), "Unknown collision object operation: %d", aco.object.operation);
}
 
bool robotStateMsgToRobotStateHelper(const Transforms* tf, const moveit_msgs::msg::RobotState& robot_state,
                                     RobotState& state, bool copy_attached_bodies)
{
  bool valid;
  const moveit_msgs::msg::RobotState& rs = robot_state;
 
  if (!rs.is_diff && rs.joint_state.name.empty() && rs.multi_dof_joint_state.joint_names.empty())
  {
    RCLCPP_ERROR(getLogger(), "Found empty JointState message");
    return false;
  }
 
  bool result1 = jointStateToRobotStateImpl(robot_state.joint_state, state);
  bool result2 = multiDofJointsToRobotState(robot_state.multi_dof_joint_state, state, tf);
  valid = result1 || result2;
 
  if (valid && copy_attached_bodies)
  {
    if (!robot_state.is_diff)
      state.clearAttachedBodies();
    for (const moveit_msgs::msg::AttachedCollisionObject& attached_collision_object :
         robot_state.attached_collision_objects)
      msgToAttachedBody(tf, attached_collision_object, state);
  }
 
  return valid;
}
}  // namespace
 
// ********************************************
 
// ********************************************
// * Exposed functions
// ********************************************
 
bool jointStateToRobotState(const sensor_msgs::msg::JointState& joint_state, RobotState& state)
{
  bool result = jointStateToRobotStateImpl(joint_state, state);
  state.update();
  return result;
}
 
bool robotStateMsgToRobotState(const moveit_msgs::msg::RobotState& robot_state, RobotState& state,
                               bool copy_attached_bodies)
{
  bool result = robotStateMsgToRobotStateHelper(nullptr, robot_state, state, copy_attached_bodies);
  state.update();
  return result;
}
 
bool robotStateMsgToRobotState(const Transforms& tf, const moveit_msgs::msg::RobotState& robot_state, RobotState& state,
                               bool copy_attached_bodies)
{
  bool result = robotStateMsgToRobotStateHelper(&tf, robot_state, state, copy_attached_bodies);
  state.update();
  return result;
}
 
void robotStateToRobotStateMsg(const RobotState& state, moveit_msgs::msg::RobotState& robot_state,
                               bool copy_attached_bodies)
{
  robot_state.is_diff = false;
  robotStateToJointStateMsg(state, robot_state.joint_state);
  robotStateToMultiDofJointState(state, robot_state.multi_dof_joint_state);
 
  if (copy_attached_bodies)
  {
    std::vector<const AttachedBody*> attached_bodies;
    state.getAttachedBodies(attached_bodies);
    attachedBodiesToAttachedCollisionObjectMsgs(attached_bodies, robot_state.attached_collision_objects);
  }
}
 
void attachedBodiesToAttachedCollisionObjectMsgs(
    const std::vector<const AttachedBody*>& attached_bodies,
    std::vector<moveit_msgs::msg::AttachedCollisionObject>& attached_collision_objs)
{
  attached_collision_objs.resize(attached_bodies.size());
  for (std::size_t i = 0; i < attached_bodies.size(); ++i)
    attachedBodyToMsg(*attached_bodies[i], attached_collision_objs[i]);
}
 
void robotStateToJointStateMsg(const RobotState& state, sensor_msgs::msg::JointState& joint_state)
{
  const std::vector<const JointModel*>& js = state.getRobotModel()->getSingleDOFJointModels();
  joint_state = sensor_msgs::msg::JointState();
 
  for (const JointModel* joint_model : js)
  {
    joint_state.name.push_back(joint_model->getName());
    joint_state.position.push_back(state.getVariablePosition(joint_model->getFirstVariableIndex()));
    if (state.hasVelocities())
      joint_state.velocity.push_back(state.getVariableVelocity(joint_model->getFirstVariableIndex()));
  }
 
  // if inconsistent number of velocities are specified, discard them
  if (joint_state.velocity.size() != joint_state.position.size())
    joint_state.velocity.clear();
 
  joint_state.header.frame_id = state.getRobotModel()->getModelFrame();
}
 
bool jointTrajPointToRobotState(const trajectory_msgs::msg::JointTrajectory& trajectory, std::size_t point_id,
                                RobotState& state)
{
  if (trajectory.points.empty() || point_id > trajectory.points.size() - 1)
  {
    RCLCPP_ERROR(getLogger(), "Invalid point_id");
    return false;
  }
  if (trajectory.joint_names.empty())
  {
    RCLCPP_ERROR(getLogger(), "No joint names specified");
    return false;
  }
 
  state.setVariablePositions(trajectory.joint_names, trajectory.points[point_id].positions);
  if (!trajectory.points[point_id].velocities.empty())
    state.setVariableVelocities(trajectory.joint_names, trajectory.points[point_id].velocities);
  if (!trajectory.points[point_id].accelerations.empty())
    state.setVariableAccelerations(trajectory.joint_names, trajectory.points[point_id].accelerations);
  if (!trajectory.points[point_id].effort.empty())
    state.setVariableEffort(trajectory.joint_names, trajectory.points[point_id].effort);
 
  return true;
}
 
void robotStateToStream(const RobotState& state, std::ostream& out, bool include_header, const std::string& separator)
{
  // Output name of variables
  if (include_header)
  {
    for (std::size_t i = 0; i < state.getVariableCount(); ++i)
    {
      out << state.getVariableNames()[i];
 
      // Output comma except at end
      if (i < state.getVariableCount() - 1)
        out << separator;
    }
    out << '\n';
  }
 
  // Output values of joints
  for (std::size_t i = 0; i < state.getVariableCount(); ++i)
  {
    out << state.getVariablePositions()[i];
 
    // Output comma except at end
    if (i < state.getVariableCount() - 1)
      out << separator;
  }
  out << '\n';
}
 
void robotStateToStream(const RobotState& state, std::ostream& out,
                        const std::vector<std::string>& joint_groups_ordering, bool include_header,
                        const std::string& separator)
{
  std::stringstream headers;
  std::stringstream joints;
 
  for (const std::string& joint_group_id : joint_groups_ordering)
  {
    const JointModelGroup* jmg = state.getRobotModel()->getJointModelGroup(joint_group_id);
 
    // Output name of variables
    if (include_header)
    {
      for (std::size_t i = 0; i < jmg->getVariableCount(); ++i)
      {
        headers << jmg->getVariableNames()[i] << separator;
      }
    }
 
    // Copy the joint positions for each joint model group
    std::vector<double> group_variable_positions;
    state.copyJointGroupPositions(jmg, group_variable_positions);
 
    // Output values of joints
    for (std::size_t i = 0; i < jmg->getVariableCount(); ++i)
    {
      joints << group_variable_positions[i] << separator;
    }
  }
 
  // Push all headers and joints to our output stream
  if (include_header)
    out << headers.str() << '\n';
  out << joints.str() << '\n';
}
 
void streamToRobotState(RobotState& state, const std::string& line, const std::string& separator)
{
  std::stringstream line_stream(line);
  std::string cell;
 
  // For each item/column
  for (std::size_t i = 0; i < state.getVariableCount(); ++i)
  {
    // Get a variable
    if (!std::getline(line_stream, cell, separator[0]))
      RCLCPP_ERROR(getLogger(), "Missing variable %s", state.getVariableNames()[i].c_str());
    state.getVariablePositions()[i] = std::stod(cell);
  }
}
 
}  // end of namespace core
}  // end of namespace moveit