DART  6.10.1
PyramidShape.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_PYRAMIDSHAPE_HPP_
34 #define DART_DYNAMICS_PYRAMIDSHAPE_HPP_
35 
36 #include "dart/dynamics/Shape.hpp"
37 
38 namespace dart {
39 namespace dynamics {
40 
49 class PyramidShape : public Shape
50 {
51 public:
59  PyramidShape(double baseWidth, double baseDepth, double height);
60 
61  // Documentation inherited.
62  const std::string& getType() const override;
63 
65  static const std::string& getStaticType();
66 
68  double getBaseWidth() const;
69 
71  void setBaseWidth(double width);
72 
74  double getBaseDepth() const;
75 
77  void setBaseDepth(double depth);
78 
80  double getHeight() const;
81 
83  void setHeight(double height);
84 
92  static double computeVolume(
93  double baseWidth, double baseDepth, double height);
94 
95  // Documentation inherited.
96  Eigen::Matrix3d computeInertia(double mass) const override;
97 
98 protected:
99  // Documentation inherited.
100  void updateBoundingBox() const override;
101 
102  // Documentation inherited.
103  void updateVolume() const override;
104 
105 private:
107  double mBaseWidth;
108 
110  double mBaseDepth;
111 
113  double mHeight;
114 };
115 
116 } // namespace dynamics
117 } // namespace dart
118 
119 #endif // DART_DYNAMICS_PYRAMIDSHAPE_HPP_
PyramidShape represents a polyhedron formed by connecting a rectangular base and a point (apex) where...
Definition: PyramidShape.hpp:50
double getHeight() const
Returns the perpendicular height from the base to the apex.
Definition: PyramidShape.cpp:104
double mHeight
Perpendicular height from the base to the apex.
Definition: PyramidShape.hpp:113
void setBaseDepth(double depth)
Sets the longitudinal length (algon Y-axis) of the base.
Definition: PyramidShape.cpp:93
double mBaseDepth
Longitudinal length (algon Y-axis) of the base.
Definition: PyramidShape.hpp:110
PyramidShape(double baseWidth, double baseDepth, double height)
Constructor.
Definition: PyramidShape.cpp:45
static double computeVolume(double baseWidth, double baseDepth, double height)
Computes the volume given properties.
Definition: PyramidShape.cpp:121
void updateBoundingBox() const override
Updates bounding box.
Definition: PyramidShape.cpp:128
double getBaseWidth() const
Returns the lateral length (algon X-axis) of the base.
Definition: PyramidShape.cpp:70
void setBaseWidth(double width)
Sets the lateral length (algon X-axis) of the base.
Definition: PyramidShape.cpp:76
const std::string & getType() const override
Returns a string representing the shape type.
Definition: PyramidShape.cpp:57
void setHeight(double height)
Returns the Perpendicular height from the base to the apex.
Definition: PyramidShape.cpp:110
static const std::string & getStaticType()
Returns shape type string for this shape.
Definition: PyramidShape.cpp:63
void updateVolume() const override
Updates volume.
Definition: PyramidShape.cpp:140
Eigen::Matrix3d computeInertia(double mass) const override
Computes the inertia.
Definition: PyramidShape.cpp:147
double getBaseDepth() const
Returns the longitudinal length (algon Y-axis) of the base.
Definition: PyramidShape.cpp:87
double mBaseWidth
Lateral length (algon X-axis) of the base.
Definition: PyramidShape.hpp:107
Definition: Shape.hpp:54
Definition: BulletCollisionDetector.cpp:65