Box shape volume. More...
#include <shape_volume.hh>
Inheritance diagram for buoyancy::BoxVolume:
Public Member Functions | |
| BoxVolume (double x, double y, double z) | |
| Default constructor. More... | |
| Volume | CalculateVolume (const ignition::math::Pose3d &pose, double fluidLevel) override |
| Calculates volume + centroid of submerged shape if the shape is out of water returns Volume{}. More... | |
| std::string | Display () override |
| Display string for box shape. More... | |
 Public Member Functions inherited from buoyancy::ShapeVolume | |
| virtual | ~ShapeVolume ()=default |
| Default destructor. More... | |
Public Attributes | |
| double | x |
| Length. More... | |
| double | y |
| Width. More... | |
| double | z |
| Height. More... | |
| Public Attributes inherited from buoyancy::ShapeVolume | |
| double | averageLength |
| Average length of object estimate used for drag torque calculation. More... | |
| ShapeType | type |
| Type of shape. More... | |
| double | volume |
| Full volume of object. More... | |
Private Attributes | |
| Polyhedron | polyhedron |
| Polyhedron defining a box. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from buoyancy::ShapeVolume | |
| static std::unique_ptr< ShapeVolume > | makeShape (const sdf::ElementPtr sdf) |
| Factory method for shape. Parses a shape object from sdf data. More... | |
Detailed Description
Box shape volume.
Definition at line 73 of file shape_volume.hh.
Constructor & Destructor Documentation
|
explicit |
Default constructor.
- Parameters
-
x length y width z height
Definition at line 119 of file shape_volume.cc.
Member Function Documentation
|
overridevirtual |
Calculates volume + centroid of submerged shape if the shape is out of water returns Volume{}.
- Parameters
-
pose world pose of volume fluidLevel height of fluid
- Returns
- volume object with volume + centroid (relative to world)
Implements buoyancy::ShapeVolume.
Definition at line 139 of file shape_volume.cc.
|
overridevirtual |
Display string for box shape.
Reimplemented from buoyancy::ShapeVolume.
Definition at line 131 of file shape_volume.cc.
Member Data Documentation
|
private |
Polyhedron defining a box.
Definition at line 99 of file shape_volume.hh.
| double buoyancy::BoxVolume::x |
Length.
Definition at line 89 of file shape_volume.hh.
| double buoyancy::BoxVolume::y |
Width.
Definition at line 92 of file shape_volume.hh.
| double buoyancy::BoxVolume::z |
Height.
Definition at line 95 of file shape_volume.hh.
The documentation for this struct was generated from the following files: