Drake
Drake C++ Documentation
Sphere Class Referencefinal

Detailed Description

Definition of sphere.

It is centered in its canonical frame with the given radius.

#include <drake/geometry/shape_specification.h>

Public Member Functions

 Sphere (double radius)
 Constructs a sphere with the given radius. More...
 
 ~Sphere () final
 
double radius () const
 
Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable
 Sphere (const Sphere &)=default
 
Sphereoperator= (const Sphere &)=default
 
 Sphere (Sphere &&)=default
 
Sphereoperator= (Sphere &&)=default
 
- Public Member Functions inherited from Shape
virtual ~Shape ()
 
void Reify (ShapeReifier *reifier, void *user_data=nullptr) const
 Causes this description to be reified in the given reifier. More...
 
std::unique_ptr< ShapeClone () const
 Creates a unique copy of this shape. More...
 
std::string_view type_name () const
 Returns the (unqualified) type name of this Shape, e.g., "Box". More...
 
std::string to_string () const
 Returns a string representation of this shape. More...
 
template<typename ReturnType = void, typename Visitor >
decltype(auto) Visit (Visitor &&visitor) const
 Calls the given visitor function with *this as the sole argument, but with *this downcast to be the shape's concrete subclass. More...
 

Additional Inherited Members

- Protected Types inherited from Shape
using VariantShapeConstPtr = std::variant< const Box *, const Capsule *, const Convex *, const Cylinder *, const Ellipsoid *, const HalfSpace *, const Mesh *, const MeshcatCone *, const Sphere * >
 (Internal use only) All concrete subclasses, as const pointers. More...
 
- Protected Member Functions inherited from Shape
 Shape ()
 (Internal use only) Constructor for use by derived classes. More...
 
 Shape (const Shape &)=default
 (Internal use only) For derived classes. More...
 
Shapeoperator= (const Shape &)=default
 (Internal use only) For derived classes. More...
 
 Shape (Shape &&)=default
 (Internal use only) For derived classes. More...
 
Shapeoperator= (Shape &&)=default
 (Internal use only) For derived classes. More...
 

Constructor & Destructor Documentation

◆ Sphere() [1/3]

Sphere ( const Sphere )
default

◆ Sphere() [2/3]

Sphere ( Sphere &&  )
default

◆ Sphere() [3/3]

Sphere ( double  radius)
explicit

Constructs a sphere with the given radius.

Exceptions
std::exceptionif radius is negative. Note that a zero radius is considered valid.

◆ ~Sphere()

~Sphere ( )
final

Member Function Documentation

◆ operator=() [1/2]

Sphere& operator= ( const Sphere )
default

◆ operator=() [2/2]

Sphere& operator= ( Sphere &&  )
default

◆ radius()

double radius ( ) const

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