DART  6.10.1
FixedFrame.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_FIXEDFRAME_HPP_
34 #define DART_DYNAMICS_FIXEDFRAME_HPP_
35 
38 #include "dart/dynamics/Frame.hpp"
40 
41 namespace dart {
42 namespace dynamics {
43 
50  : public virtual Frame,
51  public virtual common::VersionCounter,
52  public common::EmbedProperties<FixedFrame, detail::FixedFrameProperties>
53 {
54 public:
56  explicit FixedFrame(
57  Frame* refFrame,
58  const Eigen::Isometry3d& relativeTransform
59  = Eigen::Isometry3d::Identity());
60 
62  virtual ~FixedFrame();
63 
66 
68  virtual void setRelativeTransform(const Eigen::Isometry3d& transform);
69 
70  // Documentation inherited
71  const Eigen::Isometry3d& getRelativeTransform() const override;
72 
74  const Eigen::Vector6d& getRelativeSpatialVelocity() const override;
75 
77  const Eigen::Vector6d& getRelativeSpatialAcceleration() const override;
78 
80  const Eigen::Vector6d& getPrimaryRelativeAcceleration() const override;
81 
83  const Eigen::Vector6d& getPartialAcceleration() const override;
84 
85 protected:
87  FixedFrame();
88 
91 
93  static const Eigen::Vector6d mZero;
94 
95 public:
96  // To get byte-aligned Eigen vectors
97  EIGEN_MAKE_ALIGNED_OPERATOR_NEW
98 };
100 
101 } // namespace dynamics
102 } // namespace dart
103 
104 #endif // DART_DYNAMICS_FIXEDFRAME_HPP_
#define DART_DECLARE_CLASS_WITH_VIRTUAL_BASE_END
Definition: ClassWithVirtualBase.hpp:44
#define DART_DECLARE_CLASS_WITH_VIRTUAL_BASE_BEGIN
Definition: ClassWithVirtualBase.hpp:43
BodyPropPtr properties
Definition: SdfParser.cpp:80
Inherit this class to embed Properties into your Composite object.
Definition: EmbeddedAspect.hpp:204
typename Aspect::Properties AspectProperties
Definition: EmbeddedAspect.hpp:208
VersionCounter is an interface for objects that count their versions.
Definition: VersionCounter.hpp:43
ConstructAbstractTag
Used when constructing a pure abstract class, because calling the Entity constructor is just a formal...
Definition: Entity.hpp:165
The FixedFrame class represents a Frame with zero relative velocity and zero relative acceleration.
Definition: FixedFrame.hpp:53
virtual ~FixedFrame()
Destructor.
Definition: FixedFrame.cpp:61
const Eigen::Vector6d & getPrimaryRelativeAcceleration() const override
Always returns a zero vector.
Definition: FixedFrame.cpp:102
void setAspectProperties(const AspectProperties &properties)
Set the AspectProperties of this FixedFrame.
Definition: FixedFrame.cpp:67
static const Eigen::Vector6d mZero
Used for Relative Velocity and Relative Acceleration of this Frame.
Definition: FixedFrame.hpp:93
FixedFrame()
Default constructor – calls the Abstract constructor.
Definition: FixedFrame.cpp:114
const Eigen::Vector6d & getRelativeSpatialAcceleration() const override
Always returns a zero vector.
Definition: FixedFrame.cpp:96
virtual void setRelativeTransform(const Eigen::Isometry3d &transform)
Set the relative transform of this FixedFrame.
Definition: FixedFrame.cpp:73
const Eigen::Vector6d & getPartialAcceleration() const override
Always returns a zero vector.
Definition: FixedFrame.cpp:108
const Eigen::Vector6d & getRelativeSpatialVelocity() const override
Always returns a zero vector.
Definition: FixedFrame.cpp:90
const Eigen::Isometry3d & getRelativeTransform() const override
Get the transform of this Frame with respect to its parent Frame.
Definition: FixedFrame.cpp:84
The Frame class serves as the backbone of DART's kinematic tree structure.
Definition: Frame.hpp:58
Matrix< double, 6, 1 > Vector6d
Definition: MathTypes.hpp:49
dart::collision::fcl::Vector3 transform(const dart::collision::fcl::Transform3 &t, const dart::collision::fcl::Vector3 &v)
Transforms a 3-dim vector by a transform and returns the result.
Definition: BackwardCompatibility.cpp:133
Definition: BulletCollisionDetector.cpp:65