Drake
ShapeName Class Referencefinal

Detailed Description

Class that reports the name of the type of shape being reified (e.g., Sphere, Box, etc.)

#include <drake/geometry/shape_specification.h>

Public Member Functions

 ShapeName ()=default
 
 ShapeName (const Shape &shape)
 Constructs a ShapeName from the given shape such that string() already contains the string representation of shape. More...
 
std::string name () const
 Returns the name of the last shape reified. More...
 
Implementation of ShapeReifier interface
void ImplementGeometry (const Sphere &, void *) final
 
void ImplementGeometry (const Cylinder &, void *) final
 
void ImplementGeometry (const HalfSpace &, void *) final
 
void ImplementGeometry (const Box &, void *) final
 
void ImplementGeometry (const Capsule &, void *) final
 
void ImplementGeometry (const Ellipsoid &, void *) final
 
void ImplementGeometry (const Mesh &, void *) final
 
void ImplementGeometry (const Convex &, void *) final
 
virtual void ImplementGeometry (const Sphere &sphere, void *user_data)
 
virtual void ImplementGeometry (const Cylinder &cylinder, void *user_data)
 
virtual void ImplementGeometry (const HalfSpace &half_space, void *user_data)
 
virtual void ImplementGeometry (const Box &box, void *user_data)
 
virtual void ImplementGeometry (const Capsule &capsule, void *user_data)
 
virtual void ImplementGeometry (const Ellipsoid &ellipsoid, void *user_data)
 
virtual void ImplementGeometry (const Mesh &mesh, void *user_data)
 
virtual void ImplementGeometry (const Convex &convex, void *user_data)
 
- Public Member Functions inherited from ShapeReifier
virtual ~ShapeReifier ()=default
 

Related Functions

(Note that these are not member functions.)

std::ostream & operator<< (std::ostream &out, const ShapeName &name)
 

Additional Inherited Members

- Protected Member Functions inherited from ShapeReifier
 ShapeReifier ()=default
 
virtual void ThrowUnsupportedGeometry (const std::string &shape_name)
 Derived ShapeReifiers can replace the default message for unsupported geometries by overriding this method. More...
 
 ShapeReifier (const ShapeReifier &)=default
 
ShapeReifieroperator= (const ShapeReifier &)=default
 
 ShapeReifier (ShapeReifier &&)=default
 
ShapeReifieroperator= (ShapeReifier &&)=default
 

Constructor & Destructor Documentation

◆ ShapeName() [1/2]

ShapeName ( )
default

◆ ShapeName() [2/2]

ShapeName ( const Shape shape)
explicit

Constructs a ShapeName from the given shape such that string() already contains the string representation of shape.

Member Function Documentation

◆ ImplementGeometry() [1/16]

virtual void ImplementGeometry

◆ ImplementGeometry() [2/16]

virtual void ImplementGeometry

◆ ImplementGeometry() [3/16]

virtual void ImplementGeometry

◆ ImplementGeometry() [4/16]

virtual void ImplementGeometry

◆ ImplementGeometry() [5/16]

virtual void ImplementGeometry

◆ ImplementGeometry() [6/16]

virtual void ImplementGeometry

◆ ImplementGeometry() [7/16]

virtual void ImplementGeometry

◆ ImplementGeometry() [8/16]

virtual void ImplementGeometry

◆ ImplementGeometry() [9/16]

void ImplementGeometry ( const Sphere ,
void *   
)
finalvirtual

Reimplemented from ShapeReifier.

◆ ImplementGeometry() [10/16]

void ImplementGeometry ( const Cylinder ,
void *   
)
finalvirtual

Reimplemented from ShapeReifier.

◆ ImplementGeometry() [11/16]

void ImplementGeometry ( const HalfSpace ,
void *   
)
finalvirtual

Reimplemented from ShapeReifier.

◆ ImplementGeometry() [12/16]

void ImplementGeometry ( const Box ,
void *   
)
finalvirtual

Reimplemented from ShapeReifier.

◆ ImplementGeometry() [13/16]

void ImplementGeometry ( const Capsule ,
void *   
)
finalvirtual

Reimplemented from ShapeReifier.

◆ ImplementGeometry() [14/16]

void ImplementGeometry ( const Ellipsoid ,
void *   
)
finalvirtual

Reimplemented from ShapeReifier.

◆ ImplementGeometry() [15/16]

void ImplementGeometry ( const Mesh ,
void *   
)
finalvirtual

Reimplemented from ShapeReifier.

◆ ImplementGeometry() [16/16]

void ImplementGeometry ( const Convex ,
void *   
)
finalvirtual

Reimplemented from ShapeReifier.

◆ name()

std::string name ( ) const

Returns the name of the last shape reified.

Empty if no shape has been reified yet.

Friends And Related Function Documentation

◆ operator<<()

std::ostream & operator<< ( std::ostream &  out,
const ShapeName name 
)
related

The documentation for this class was generated from the following file: