Public Member Functions | Public Attributes | List of all members
buoyancy::SphereVolume Struct Reference

Sphere shape volume. More...

#include <shape_volume.hh>

Inheritance diagram for buoyancy::SphereVolume:
Inheritance graph
[legend]

Public Member Functions

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 sphere shape. More...
 
 SphereVolume (double r)
 Default constructor. More...
 
- Public Member Functions inherited from buoyancy::ShapeVolume
virtual ~ShapeVolume ()=default
 Default destructor. More...
 

Public Attributes

double r
 Radius of sphere. 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from buoyancy::ShapeVolume
static std::unique_ptr< ShapeVolumemakeShape (const sdf::ElementPtr sdf)
 Factory method for shape. Parses a shape object from sdf data. More...
 

Detailed Description

Sphere shape volume.

Definition at line 129 of file shape_volume.hh.

Constructor & Destructor Documentation

SphereVolume::SphereVolume ( double  r)
explicit

Default constructor.

Parameters
rradius

Definition at line 176 of file shape_volume.cc.

Member Function Documentation

Volume SphereVolume::CalculateVolume ( const ignition::math::Pose3d &  pose,
double  fluidLevel 
)
overridevirtual

Calculates volume + centroid of submerged shape if the shape is out of water returns Volume{}.

Parameters
poseworld pose of volume
fluidLevelheight of fluid
Returns
volume object with volume + centroid (relative to world)

Implements buoyancy::ShapeVolume.

Definition at line 193 of file shape_volume.cc.

std::string SphereVolume::Display ( )
overridevirtual

Display string for sphere shape.

Reimplemented from buoyancy::ShapeVolume.

Definition at line 185 of file shape_volume.cc.

Member Data Documentation

double buoyancy::SphereVolume::r

Radius of sphere.

Definition at line 143 of file shape_volume.hh.


The documentation for this struct was generated from the following files:


usv_gazebo_plugins
Author(s): Brian Bingham , Carlos Aguero
autogenerated on Thu May 7 2020 03:54:47