planar_joint_model.h
Go to the documentation of this file.
1 /*********************************************************************
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2013, Willow Garage, Inc.
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 Willow Garage, Inc. 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 OWNER 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 /* Author: Ioan Sucan */
36 
37 #pragma once
38 
40 
41 namespace moveit
42 {
43 namespace core
44 {
46 class PlanarJointModel : public JointModel
47 {
48 public:
50  enum MotionModel
51  {
52  HOLONOMIC, // default
54  };
55 
56  PlanarJointModel(const std::string& name);
57 
58  void getVariableDefaultPositions(double* values, const Bounds& other_bounds) const override;
60  const Bounds& other_bounds) const override;
62  const Bounds& other_bounds, const double* seed,
63  const double distance) const override;
64  bool enforcePositionBounds(double* values, const Bounds& other_bounds) const override;
65  bool satisfiesPositionBounds(const double* values, const Bounds& other_bounds, double margin) const override;
66 
67  void interpolate(const double* from, const double* to, const double t, double* state) const override;
68  unsigned int getStateSpaceDimension() const override;
69  double getMaximumExtent(const Bounds& other_bounds) const override;
70  double distance(const double* values1, const double* values2) const override;
71 
72  void computeTransform(const double* joint_values, Eigen::Isometry3d& transf) const override;
73  void computeVariablePositions(const Eigen::Isometry3d& transf, double* joint_values) const override;
74 
75  double getAngularDistanceWeight() const
76  {
78  }
79 
80  void setAngularDistanceWeight(double weight)
81  {
82  angular_distance_weight_ = weight;
83  }
84 
85  double getMinTranslationalDistance() const
86  {
88  }
89 
90  void setMinTranslationalDistance(double min_translational_distance)
91  {
92  min_translational_distance_ = min_translational_distance;
93  }
94 
96  {
97  return motion_model_;
98  }
99 
100  void setMotionModel(MotionModel model)
101  {
102  motion_model_ = model;
103  }
104 
108  bool normalizeRotation(double* values) const;
109 
110 private:
115 };
128 void computeTurnDriveTurnGeometry(const double* from, const double* to, const double min_translational_distance,
129  double& dx, double& dy, double& initial_turn, double& drive_angle,
130  double& final_turn);
131 } // namespace core
132 } // namespace moveit
moveit::core::PlanarJointModel::interpolate
void interpolate(const double *from, const double *to, const double t, double *state) const override
Computes the state that lies at time t in [0, 1] on the segment that connects from state to to state....
Definition: planar_joint_model.cpp:246
moveit::core::PlanarJointModel::getVariableRandomPositions
void getVariableRandomPositions(random_numbers::RandomNumberGenerator &rng, double *values, const Bounds &other_bounds) const override
Provide random values for the joint variables (within specified bounds). Enough memory is assumed to ...
Definition: planar_joint_model.cpp:169
moveit::core::PlanarJointModel::motion_model_
MotionModel motion_model_
Definition: planar_joint_model.h:208
moveit::core::PlanarJointModel::setAngularDistanceWeight
void setAngularDistanceWeight(double weight)
Definition: planar_joint_model.h:176
moveit::core::PlanarJointModel::getVariableRandomPositionsNearBy
void getVariableRandomPositionsNearBy(random_numbers::RandomNumberGenerator &rng, double *values, const Bounds &other_bounds, const double *seed, const double distance) const override
Provide random values for the joint variables (within specified bounds). Enough memory is assumed to ...
Definition: planar_joint_model.cpp:185
moveit::core::PlanarJointModel::DIFF_DRIVE
@ DIFF_DRIVE
Definition: planar_joint_model.h:181
moveit::core::PlanarJointModel::enforcePositionBounds
bool enforcePositionBounds(double *values, const Bounds &other_bounds) const override
Force the specified values to be inside bounds and normalized. Quaternions are normalized,...
Definition: planar_joint_model.cpp:374
moveit::core::PlanarJointModel::min_translational_distance_
double min_translational_distance_
Only used for the differential drive motion model.
Definition: planar_joint_model.h:210
moveit::core::PlanarJointModel::normalizeRotation
bool normalizeRotation(double *values) const
Definition: planar_joint_model.cpp:361
moveit::core::PlanarJointModel::getStateSpaceDimension
unsigned int getStateSpaceDimension() const override
Get the dimension of the state space that corresponds to this joint.
Definition: planar_joint_model.cpp:144
moveit::core::PlanarJointModel::angular_distance_weight_
double angular_distance_weight_
Definition: planar_joint_model.h:207
moveit::core::PlanarJointModel::computeVariablePositions
void computeVariablePositions(const Eigen::Isometry3d &transf, double *joint_values) const override
Given the transform generated by joint, compute the corresponding joint values. Make sure the passed ...
Definition: planar_joint_model.cpp:399
moveit::core::PlanarJointModel::getMotionModel
MotionModel getMotionModel() const
Definition: planar_joint_model.h:191
moveit::core::PlanarJointModel::distance
double distance(const double *values1, const double *values2) const override
Compute the distance between two joint states of the same model (represented by the variable values)
Definition: planar_joint_model.cpp:332
moveit::core::JointModel::getMaximumExtent
double getMaximumExtent() const
Definition: joint_model.h:513
moveit::core::JointModel::Bounds
std::vector< VariableBounds > Bounds
The datatype for the joint bounds.
Definition: joint_model.h:188
moveit::core::PlanarJointModel::PlanarJointModel
PlanarJointModel(const std::string &name)
Definition: planar_joint_model.cpp:115
moveit::core::PlanarJointModel::MotionModel
MotionModel
different types of planar joints we support
Definition: planar_joint_model.h:146
moveit::core::PlanarJointModel::getMinTranslationalDistance
double getMinTranslationalDistance() const
Definition: planar_joint_model.h:181
moveit::core::PlanarJointModel::setMotionModel
void setMotionModel(MotionModel model)
Definition: planar_joint_model.h:196
random_numbers::RandomNumberGenerator
moveit::core::PlanarJointModel::getAngularDistanceWeight
double getAngularDistanceWeight() const
Definition: planar_joint_model.h:171
moveit
Main namespace for MoveIt.
Definition: background_processing.h:46
moveit::core::PlanarJointModel::satisfiesPositionBounds
bool satisfiesPositionBounds(const double *values, const Bounds &other_bounds, double margin) const override
Check if the set of position values for the variables of this joint are within bounds,...
Definition: planar_joint_model.cpp:353
joint_model.h
moveit::core::PlanarJointModel::computeTransform
void computeTransform(const double *joint_values, Eigen::Isometry3d &transf) const override
Given the joint values for a joint, compute the corresponding transform. The computed transform is gu...
Definition: planar_joint_model.cpp:393
moveit::core::PlanarJointModel::setMinTranslationalDistance
void setMinTranslationalDistance(double min_translational_distance)
Definition: planar_joint_model.h:186
moveit::core::PlanarJointModel::getVariableDefaultPositions
void getVariableDefaultPositions(double *values, const Bounds &other_bounds) const override
Provide a default value for the joint given the joint variable bounds. Most joints will use the defau...
Definition: planar_joint_model.cpp:156
moveit::core::PlanarJointModel::HOLONOMIC
@ HOLONOMIC
Definition: planar_joint_model.h:180
moveit::core::computeTurnDriveTurnGeometry
void computeTurnDriveTurnGeometry(const double *from, const double *to, const double min_translational_distance, double &dx, double &dy, double &initial_turn, double &drive_angle, double &final_turn)
Compute the geometry to turn toward the target point, drive straight and then turn to target orientat...
Definition: planar_joint_model.cpp:210


moveit_core
Author(s): Ioan Sucan , Sachin Chitta , Acorn Pooley
autogenerated on Thu Apr 18 2024 02:23:40