default_constraint_samplers.h

Go to the documentation of this file.

/*********************************************************************
 * Software License Agreement (BSD License)
 *
 *  Copyright (c) 2011, 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 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 */
 
#pragma once
 
#include <moveit/constraint_samplers/constraint_sampler.h>
#include <moveit/macros/class_forward.h>
#include <random_numbers/random_numbers.h>
#include <rclcpp/rclcpp.hpp>
#include <string>
#include <Eigen/Geometry>
 
namespace constraint_samplers
{
MOVEIT_CLASS_FORWARD(JointConstraintSampler);  // Defines JointConstraintSamplerPtr, ConstPtr, WeakPtr... etc
 
class JointConstraintSampler : public ConstraintSampler
{
public:
  JointConstraintSampler(const planning_scene::PlanningSceneConstPtr& scene, const std::string& group_name)
    : ConstraintSampler(scene, group_name), random_number_generator_(random_numbers::RandomNumberGenerator())
  {
  }
 
  JointConstraintSampler(const planning_scene::PlanningSceneConstPtr& scene, const std::string& group_name,
                         unsigned int seed)
    : ConstraintSampler(scene, group_name), random_number_generator_(random_numbers::RandomNumberGenerator(seed))
  {
  }
 
  bool configure(const moveit_msgs::msg::Constraints& constr) override;
 
  bool configure(const std::vector<kinematic_constraints::JointConstraint>& jc);
 
  bool sample(moveit::core::RobotState& state, const moveit::core::RobotState& ks, unsigned int max_attempts) override;
 
  std::size_t getConstrainedJointCount() const
  {
    return bounds_.size();
  }
 
  std::size_t getUnconstrainedJointCount() const
  {
    return unbounded_.size();
  }
 
  const std::string& getName() const override
  {
    static const std::string SAMPLER_NAME = "JointConstraintSampler";
    return SAMPLER_NAME;
  }
 
protected:
  struct JointInfo
  {
    JointInfo()
    {
      min_bound_ = -std::numeric_limits<double>::max();
      max_bound_ = std::numeric_limits<double>::max();
    }
 
    void potentiallyAdjustMinMaxBounds(double min, double max)
    {
      min_bound_ = std::max(min, min_bound_);
      max_bound_ = std::min(max, max_bound_);
    }
 
    double min_bound_;  
    double max_bound_;  
    std::size_t index_; 
  };
 
  void clear() override;
 
  random_numbers::RandomNumberGenerator random_number_generator_; 
  std::vector<JointInfo> bounds_; 
  std::vector<const moveit::core::JointModel*> unbounded_; 
  std::vector<unsigned int> uindex_; 
  std::vector<double> values_;       
};
 
struct IKSamplingPose
{
  IKSamplingPose();
 
  IKSamplingPose(const kinematic_constraints::PositionConstraint& pc);
 
  IKSamplingPose(const kinematic_constraints::OrientationConstraint& oc);
 
  IKSamplingPose(const kinematic_constraints::PositionConstraint& pc,
                 const kinematic_constraints::OrientationConstraint& oc);
 
  IKSamplingPose(const kinematic_constraints::PositionConstraintPtr& pc);
 
  IKSamplingPose(const kinematic_constraints::OrientationConstraintPtr& oc);
 
  IKSamplingPose(const kinematic_constraints::PositionConstraintPtr& pc,
                 const kinematic_constraints::OrientationConstraintPtr& oc);
 
  kinematic_constraints::PositionConstraintPtr position_constraint_; 
  kinematic_constraints::OrientationConstraintPtr
      orientation_constraint_; 
};
 
MOVEIT_CLASS_FORWARD(IKConstraintSampler);  // Defines IKConstraintSamplerPtr, ConstPtr, WeakPtr... etc
 
class IKConstraintSampler : public ConstraintSampler
{
public:
  IKConstraintSampler(const planning_scene::PlanningSceneConstPtr& scene, const std::string& group_name)
    : ConstraintSampler(scene, group_name), random_number_generator_(random_numbers::RandomNumberGenerator())
  {
  }
 
  IKConstraintSampler(const planning_scene::PlanningSceneConstPtr& scene, const std::string& group_name,
                      unsigned int seed)
    : ConstraintSampler(scene, group_name), random_number_generator_(random_numbers::RandomNumberGenerator(seed))
  {
  }
 
  bool configure(const moveit_msgs::msg::Constraints& constr) override;
 
  bool configure(const IKSamplingPose& sp);
 
  double getIKTimeout() const
  {
    return ik_timeout_;
  }
 
  void setIKTimeout(double timeout)
  {
    ik_timeout_ = timeout;
  }
 
  const kinematic_constraints::PositionConstraintPtr& getPositionConstraint() const
  {
    return sampling_pose_.position_constraint_;
  }
  const kinematic_constraints::OrientationConstraintPtr& getOrientationConstraint() const
  {
    return sampling_pose_.orientation_constraint_;
  }
 
  double getSamplingVolume() const;
 
  const std::string& getLinkName() const;
 
  bool sample(moveit::core::RobotState& state, const moveit::core::RobotState& reference_state,
              unsigned int max_attempts) override;
 
  bool samplePose(Eigen::Vector3d& pos, Eigen::Quaterniond& quat, const moveit::core::RobotState& ks,
                  unsigned int max_attempts);
 
  const std::string& getName() const override
  {
    static const std::string SAMPLER_NAME = "IKConstraintSampler";
    return SAMPLER_NAME;
  }
 
protected:
  void clear() override;
 
  bool loadIKSolver();
 
  bool callIK(const geometry_msgs::msg::Pose& ik_query,
              const kinematics::KinematicsBase::IKCallbackFn& adapted_ik_validity_callback, double timeout,
              moveit::core::RobotState& state, bool use_as_seed);
  bool sampleHelper(moveit::core::RobotState& state, const moveit::core::RobotState& reference_state,
                    unsigned int max_attempts);
  bool validate(moveit::core::RobotState& state) const;
 
  random_numbers::RandomNumberGenerator random_number_generator_; 
  IKSamplingPose sampling_pose_;                                  
  kinematics::KinematicsBaseConstPtr kb_;                         
  double ik_timeout_;                                             
  std::string ik_frame_;                                          
  bool transform_ik_; 
  bool need_eef_to_ik_tip_transform_; 
  Eigen::Isometry3d eef_to_ik_tip_transform_; 
};
}  // namespace constraint_samplers