buoyancy::ShapeVolume Struct Reference

Parent shape object for volume objects. More...

#include <shape_volume.hh>

Inheritance diagram for buoyancy::ShapeVolume:

Public Member Functions
virtual Volume	CalculateVolume (const ignition::math::Pose3d &pose, double fluidLevel)=0
	Calculates volume + centroid of submerged shape if the shape is out of water returns Volume{}. More...
virtual std::string	Display ()
	Display string for shape object. More...
virtual	~ShapeVolume ()=default
	Default destructor. More...

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

Public Attributes
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...

Detailed Description

Parent shape object for volume objects.

Definition at line 40 of file shape_volume.hh.

Constructor & Destructor Documentation

virtual buoyancy::ShapeVolume::~ShapeVolume ( )

virtualdefault

Default destructor.

Member Function Documentation

virtual Volume buoyancy::ShapeVolume::CalculateVolume ( const ignition::math::Pose3d &  pose, double  fluidLevel  )

pure virtual

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)

Implemented in buoyancy::SphereVolume, buoyancy::CylinderVolume, and buoyancy::BoxVolume.

std::string ShapeVolume::Display ( )

virtual

Display string for shape object.

Reimplemented in buoyancy::SphereVolume, buoyancy::CylinderVolume, and buoyancy::BoxVolume.

Definition at line 103 of file shape_volume.cc.

ShapeVolumePtr ShapeVolume::makeShape ( const sdf::ElementPtr  sdf )

static

Factory method for shape. Parses a shape object from sdf data.

Parameters

sdf	geometry SDF element

Definition at line 23 of file shape_volume.cc.

Member Data Documentation

double buoyancy::ShapeVolume::averageLength

Average length of object estimate used for drag torque calculation.

Definition at line 68 of file shape_volume.hh.

ShapeType buoyancy::ShapeVolume::type

Type of shape.

Definition at line 61 of file shape_volume.hh.

double buoyancy::ShapeVolume::volume

Full volume of object.

Definition at line 64 of file shape_volume.hh.

---

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

• shape_volume.hh
• shape_volume.cc