DART  6.10.1
JointAspect.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011-2021, The DART development contributors
3  * All rights reserved.
4  *
5  * The list of contributors can be found at:
6  * https://github.com/dartsim/dart/blob/master/LICENSE
7  *
8  * This file is provided under the following "BSD-style" License:
9  * Redistribution and use in source and binary forms, with or
10  * without modification, are permitted provided that the following
11  * conditions are met:
12  * * Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above
15  * copyright notice, this list of conditions and the following
16  * disclaimer in the documentation and/or other materials provided
17  * with the distribution.
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
19  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
20  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
26  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef DART_DYNAMICS_DETAIL_JOINTASPECT_HPP_
34 #define DART_DYNAMICS_DETAIL_JOINTASPECT_HPP_
35 
36 #include <Eigen/Core>
37 #include <Eigen/Geometry>
38 
39 namespace dart {
40 namespace dynamics {
41 namespace detail {
42 
59 {
66 
73 
79 
87 
93 
100 
106  LOCKED
107 };
108 
110 
112 {
114  std::string mName;
115 
117  Eigen::Isometry3d mT_ParentBodyToJoint;
118 
120  Eigen::Isometry3d mT_ChildBodyToJoint;
121 
125  // TODO(JS): Rename this to mAreLimitsEnforced
126 
129 
132 
135 
138  const std::string& _name = "Joint",
139  const Eigen::Isometry3d& _T_ParentBodyToJoint
140  = Eigen::Isometry3d::Identity(),
141  const Eigen::Isometry3d& _T_ChildBodyToJoint
142  = Eigen::Isometry3d::Identity(),
143  bool _isPositionLimitEnforced = false,
144  ActuatorType _actuatorType = DefaultActuatorType,
145  const Joint* _mimicJoint = nullptr,
146  double _mimicMultiplier = 1.0,
147  double _mimicOffset = 0.0);
148 
149  virtual ~JointProperties() = default;
150 
151 public:
152  // To get byte-aligned Eigen vectors
153  EIGEN_MAKE_ALIGNED_OPERATOR_NEW
154 };
155 
156 } // namespace detail
157 } // namespace dynamics
158 } // namespace dart
159 
160 #endif // DART_DYNAMICS_DETAIL_JOINTASPECT_HPP_
class Joint
Definition: Joint.hpp:60
ActuatorType
Actuator type.
Definition: JointAspect.hpp:59
@ PASSIVE
Passive joint doesn't take any command input, and the output is joint acceleration.
Definition: JointAspect.hpp:72
@ MIMIC
There is no command input.
Definition: JointAspect.hpp:86
@ FORCE
Command input is joint force, and the output is joint acceleration.
Definition: JointAspect.hpp:65
@ VELOCITY
Command input is joint velocity, and the output is joint force.
Definition: JointAspect.hpp:99
@ ACCELERATION
Command input is joint acceleration, and the output is joint force.
Definition: JointAspect.hpp:92
@ SERVO
Command input is desired velocity, and the output is joint acceleration.
Definition: JointAspect.hpp:78
@ LOCKED
Locked joint always set the velocity and acceleration to zero so that the joint dosen't move at all (...
Definition: JointAspect.hpp:106
const ActuatorType DefaultActuatorType
Definition: JointAspect.hpp:109
Definition: BulletCollisionDetector.cpp:65
Definition: JointAspect.hpp:112
double mMimicOffset
Definition: JointAspect.hpp:134
const Joint * mMimicJoint
Mimic joint.
Definition: JointAspect.hpp:131
std::string mName
Joint name.
Definition: JointAspect.hpp:114
bool mIsPositionLimitEnforced
True if the joint position or velocity limits should be enforced in dynamic simulation.
Definition: JointAspect.hpp:124
ActuatorType mActuatorType
Actuator type.
Definition: JointAspect.hpp:128
double mMimicMultiplier
Mimic joint properties.
Definition: JointAspect.hpp:134
Eigen::Isometry3d mT_ChildBodyToJoint
Transformation from child BodyNode to this Joint.
Definition: JointAspect.hpp:120
JointProperties(const std::string &_name="Joint", const Eigen::Isometry3d &_T_ParentBodyToJoint=Eigen::Isometry3d::Identity(), const Eigen::Isometry3d &_T_ChildBodyToJoint=Eigen::Isometry3d::Identity(), bool _isPositionLimitEnforced=false, ActuatorType _actuatorType=DefaultActuatorType, const Joint *_mimicJoint=nullptr, double _mimicMultiplier=1.0, double _mimicOffset=0.0)
Constructor.
Definition: Joint.cpp:61
Eigen::Isometry3d mT_ParentBodyToJoint
Transformation from parent BodyNode to this Joint.
Definition: JointAspect.hpp:117