DART  6.7.3
HeightmapShape.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011-2019, 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 
52  = Eigen::Matrix<S, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor>;
53 
56 
58  ~HeightmapShape() override = default;
59 
60  // Documentation inherited.
61  const std::string& getType() const override;
62 
64  static const std::string& getStaticType();
65 
71  Eigen::Matrix3d computeInertia(double mass) const override;
72 
75  void setScale(const Eigen::Vector3d& scale);
76 
78  const Eigen::Vector3d& getScale() const;
79 
102  void setHeightField(
103  const std::size_t& width,
104  const std::size_t& depth,
105  const std::vector<S>& heights);
106 
108  const HeightField& getHeightField() const;
109 
112 
114  void flipY() const;
115 
117  std::size_t getWidth() const;
118 
120  std::size_t getDepth() const;
121 
123  S getMinHeight() const;
124 
126  S getMaxHeight() const;
127 
128 protected:
129  // Documentation inherited.
130  void updateBoundingBox() const override;
131 
137  void updateVolume() const override;
138 
142  void computeBoundingBox(Eigen::Vector3d& min, Eigen::Vector3d& max) const;
143 
144 private:
146  Eigen::Vector3d mScale;
147 
150 
154 
158 };
159 
162 
163 } // namespace dynamics
164 } // namespace dart
165 
167 
168 #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:136
const Eigen::Vector3d & getScale() const
Returns scale of this heightmap.
Definition: HeightmapShape-impl.hpp:85
std::size_t getWidth() const
Returns the width dimension of the height field.
Definition: HeightmapShape-impl.hpp:171
void setScale(const Eigen::Vector3d &scale)
Sets scale of this heightmap.
Definition: HeightmapShape-impl.hpp:71
Eigen::Matrix3d computeInertia(double mass) const override
Computes the inertia.
Definition: HeightmapShape-impl.hpp:185
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:196
void updateVolume() const override
Updates volume.
Definition: HeightmapShape-impl.hpp:220
static const std::string & getStaticType()
Returns shape type for this class.
Definition: HeightmapShape-impl.hpp:62
HeightField & getHeightFieldModifiable() const
Returns the modified height field. See also setHeightField().
Definition: HeightmapShape-impl.hpp:143
Eigen::Vector3d mScale
Scale of the heightmap.
Definition: HeightmapShape.hpp:146
HeightField mHeights
Height field.
Definition: HeightmapShape.hpp:149
void flipY() const
Flips the y values in the height field.
Definition: HeightmapShape-impl.hpp:150
void updateBoundingBox() const override
Updates bounding box.
Definition: HeightmapShape-impl.hpp:208
HeightmapShape()
Constructor.
Definition: HeightmapShape-impl.hpp:46
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:52
S mMaxHeight
Maximum heights.
Definition: HeightmapShape.hpp:157
std::size_t getDepth() const
Returns the height dimension of the height field.
Definition: HeightmapShape-impl.hpp:178
S getMinHeight() const
Returns the minimum height set by setHeightField()
Definition: HeightmapShape-impl.hpp:164
S mMinHeight
Minimum heights.
Definition: HeightmapShape.hpp:153
S getMaxHeight() const
Returns the maximum height set by setHeightField()
Definition: HeightmapShape-impl.hpp:157
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
Definition: Shape.hpp:53
Definition: BulletCollisionDetector.cpp:63