DART  6.10.1
HeightmapShape.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_HEIGHTMAPSHAPE_HPP_
34 #define DART_DYNAMICS_HEIGHTMAPSHAPE_HPP_
35 
36 #include "dart/dynamics/Shape.hpp"
37 
38 namespace dart {
39 namespace dynamics {
40 
45 template <typename S_>
46 class HeightmapShape : public Shape
47 {
48 public:
49  using S = S_;
50 
51  using Vector3 = Eigen::Matrix<S, 3, 1>;
53  = Eigen::Matrix<S, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor>;
54 
57 
59  ~HeightmapShape() override = default;
60 
61  // Documentation inherited.
62  const std::string& getType() const override;
63 
65  static const std::string& getStaticType();
66 
72  Eigen::Matrix3d computeInertia(double mass) const override;
73 
76  void setScale(const Vector3& scale);
77 
79  const Vector3& getScale() const;
80 
101  void setHeightField(
102  const std::size_t& width,
103  const std::size_t& depth,
104  const std::vector<S>& heights);
105 
126  void setHeightField(const HeightField& heights);
127 
129  const HeightField& getHeightField() const;
130 
133 
135  void flipY() const;
136 
138  std::size_t getWidth() const;
139 
141  std::size_t getDepth() const;
142 
144  S getMinHeight() const;
145 
147  S getMaxHeight() const;
148 
150  void notifyColorUpdated(const Eigen::Vector4d& color) override;
151 
152 protected:
153  // Documentation inherited.
154  void updateBoundingBox() const override;
155 
161  void updateVolume() const override;
162 
166  void computeBoundingBox(Eigen::Vector3d& min, Eigen::Vector3d& max) const;
167 
168 private:
171 
174 
178 
182 };
183 
186 
187 } // namespace dynamics
188 } // namespace dart
189 
191 
192 #endif // DART_DYNAMICS_HEIGHTMAPSHAPE_HPP_
Shape for a height map.
Definition: HeightmapShape.hpp:47
const HeightField & getHeightField() const
Returns the height field.
Definition: HeightmapShape-impl.hpp:133
std::size_t getWidth() const
Returns the width dimension of the height field.
Definition: HeightmapShape-impl.hpp:168
Eigen::Matrix3d computeInertia(double mass) const override
Computes the inertia.
Definition: HeightmapShape-impl.hpp:189
S_ S
Definition: HeightmapShape.hpp:49
void computeBoundingBox(Eigen::Vector3d &min, Eigen::Vector3d &max) const
Computes the bounding box of the height field.
Definition: HeightmapShape-impl.hpp:200
void updateVolume() const override
Updates volume.
Definition: HeightmapShape-impl.hpp:224
static const std::string & getStaticType()
Returns shape type for this class.
Definition: HeightmapShape-impl.hpp:62
const Vector3 & getScale() const
Returns scale of this heightmap.
Definition: HeightmapShape-impl.hpp:85
HeightField & getHeightFieldModifiable() const
Returns the modified height field. See also setHeightField().
Definition: HeightmapShape-impl.hpp:140
HeightField mHeights
Height field.
Definition: HeightmapShape.hpp:173
void flipY() const
Flips the y values in the height field.
Definition: HeightmapShape-impl.hpp:147
void updateBoundingBox() const override
Updates bounding box.
Definition: HeightmapShape-impl.hpp:212
HeightmapShape()
Constructor.
Definition: HeightmapShape-impl.hpp:46
Vector3 mScale
Scale of the heightmap.
Definition: HeightmapShape.hpp:170
const std::string & getType() const override
Returns a string representing the shape type.
Definition: HeightmapShape-impl.hpp:55
~HeightmapShape() override=default
Destructor.
Eigen::Matrix< S, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor > HeightField
Definition: HeightmapShape.hpp:53
void notifyColorUpdated(const Eigen::Vector4d &color) override
Set the color of this arrow.
Definition: HeightmapShape-impl.hpp:182
S mMaxHeight
Maximum heights.
Definition: HeightmapShape.hpp:181
std::size_t getDepth() const
Returns the height dimension of the height field.
Definition: HeightmapShape-impl.hpp:175
S getMinHeight() const
Returns the minimum height set by setHeightField()
Definition: HeightmapShape-impl.hpp:161
void setScale(const Vector3 &scale)
Sets scale of this heightmap.
Definition: HeightmapShape-impl.hpp:71
S mMinHeight
Minimum heights.
Definition: HeightmapShape.hpp:177
S getMaxHeight() const
Returns the maximum height set by setHeightField()
Definition: HeightmapShape-impl.hpp:154
void setHeightField(const std::size_t &width, const std::size_t &depth, const std::vector< S > &heights)
Sets the height field.
Definition: HeightmapShape-impl.hpp:92
Eigen::Matrix< S, 3, 1 > Vector3
Definition: HeightmapShape.hpp:51
Definition: Shape.hpp:54
Definition: BulletCollisionDetector.cpp:65