DART  6.10.1
TranslationalJoint2DAspect.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_TRANSLATIONALJOINT2DASPECT_HPP_
34 #define DART_DYNAMICS_DETAIL_TRANSLATIONALJOINT2DASPECT_HPP_
35 
36 #include <string>
37 
38 #include <Eigen/Dense>
39 
42 
43 namespace dart {
44 namespace dynamics {
45 
46 class TranslationalJoint2D;
47 
48 namespace detail {
49 
50 //==============================================================================
52 {
53 public:
57  PlaneType planeType = PlaneType::XY);
58 
62  const Eigen::Matrix<double, 3, 2>& transAxes);
63 
67  const Eigen::Vector3d& transAxis1, const Eigen::Vector3d& transAxis2);
68 
72 
74 
78 
80  void setXYPlane();
81 
83  void setYZPlane();
84 
86  void setZXPlane();
87 
89  void setArbitraryPlane(const Eigen::Matrix<double, 3, 2>& transAxes);
90 
92  void setArbitraryPlane(
93  const Eigen::Vector3d& transAxis1, const Eigen::Vector3d& transAxis2);
94 
96  const Eigen::Matrix<double, 3, 2>& getTranslationalAxes() const;
97 
99  Eigen::Vector3d getTranslationalAxis1() const;
100 
102  Eigen::Vector3d getTranslationalAxis2() const;
103 
105  PlaneType getPlaneType() const;
106 
107 private:
110 
112  Eigen::Matrix<double, 3, 2> mTransAxes;
113 };
114 
115 //==============================================================================
116 struct TranslationalJoint2DProperties : GenericJoint<math::R2Space>::Properties,
118 {
120 
122  const GenericJoint<math::R2Space>::Properties& genericJointProperties
124  const TranslationalJoint2DUniqueProperties& universalProperties
126 
127  virtual ~TranslationalJoint2DProperties() = default;
128 };
129 
130 //==============================================================================
135 
136 } // namespace detail
137 } // namespace dynamics
138 } // namespace dart
139 
140 #endif // DART_DYNAMICS_DETAIL_TRANSLATIONALJOINT2DASPECT_HPP_
#define DART_DEFINE_ALIGNED_SHARED_OBJECT_CREATOR(class_name)
Definition: Memory.hpp:155
This is an alternative to EmbedProperties which allows your class to also inherit other Composite obj...
Definition: EmbeddedAspect.hpp:240
Definition: GenericJoint.hpp:48
TranslationalJoint2D represents a 2-dof joint, which has two orthogonal translational axes.
Definition: TranslationalJoint2D.hpp:48
Definition: TranslationalJoint2DAspect.hpp:52
const Eigen::Matrix< double, 3, 2 > & getTranslationalAxes() const
Returns first and second translational axes.
Definition: TranslationalJoint2DAspect.cpp:186
Eigen::Matrix< double, 3, 2 > mTransAxes
First and second translational axes.
Definition: TranslationalJoint2DAspect.hpp:112
void setArbitraryPlane(const Eigen::Matrix< double, 3, 2 > &transAxes)
Sets plane type as arbitrary plane with two orthogonal translational axes.
Definition: TranslationalJoint2DAspect.cpp:146
void setYZPlane()
Sets plane type as YZ-plane.
Definition: TranslationalJoint2DAspect.cpp:130
void setZXPlane()
Sets plane type as ZX-plane.
Definition: TranslationalJoint2DAspect.cpp:138
PlaneType getPlaneType() const
Returns plane type.
Definition: TranslationalJoint2DAspect.cpp:206
Eigen::Vector3d getTranslationalAxis1() const
Returns first translational axis.
Definition: TranslationalJoint2DAspect.cpp:192
Eigen::Vector3d getTranslationalAxis2() const
Returns second translational axis.
Definition: TranslationalJoint2DAspect.cpp:199
TranslationalJoint2DUniqueProperties & operator=(const TranslationalJoint2DUniqueProperties &other)
Assignment operator.
Definition: TranslationalJoint2DAspect.cpp:97
void setXYPlane()
Sets plane type as XY-plane.
Definition: TranslationalJoint2DAspect.cpp:122
PlaneType mPlaneType
Plane type.
Definition: TranslationalJoint2DAspect.hpp:109
TranslationalJoint2DUniqueProperties(PlaneType planeType=PlaneType::XY)
Constructor for pre-defined plane types.
Definition: TranslationalJoint2DAspect.cpp:40
PlaneType
Plane type.
Definition: PlanarJointAspect.hpp:50
Definition: BulletCollisionDetector.cpp:65
Definition: GenericJointAspect.hpp:191
Definition: TranslationalJoint2DAspect.hpp:118
TranslationalJoint2DProperties(const GenericJoint< math::R2Space >::Properties &genericJointProperties=GenericJoint< math::R2Space >::Properties(), const TranslationalJoint2DUniqueProperties &universalProperties=TranslationalJoint2DUniqueProperties())
Definition: TranslationalJoint2DAspect.cpp:212