Drake
Cylinder Class Referencefinal

Detailed Description

Definition of a cylinder.

It is centered in its canonical frame with the length of the cylinder parallel with the frame's z-axis.

#include <drake/geometry/shape_specification.h>

Public Member Functions

 Cylinder (double radius, double length)
 Constructs a cylinder with the given radius and length. More...
 
double radius () const
 
double length () const
 
Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable
 Cylinder (const Cylinder &)=default
 
Cylinderoperator= (const Cylinder &)=default
 
 Cylinder (Cylinder &&)=default
 
Cylinderoperator= (Cylinder &&)=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...
 

Additional Inherited Members

- Protected Member Functions inherited from Shape
template<typename S >
 Shape (ShapeTag< S > tag)
 Constructor available for derived class construction. More...
 
 Shape (const Shape &)=default
 
Shapeoperator= (const Shape &)=default
 
 Shape (Shape &&)=default
 
Shapeoperator= (Shape &&)=default
 

Constructor & Destructor Documentation

◆ Cylinder() [1/3]

Cylinder ( const Cylinder )
default

◆ Cylinder() [2/3]

Cylinder ( Cylinder &&  )
default

◆ Cylinder() [3/3]

Cylinder ( double  radius,
double  length 
)

Constructs a cylinder with the given radius and length.

Exceptions
std::exceptionif radius or length are not strictly positive.

Member Function Documentation

◆ length()

double length ( ) const

◆ operator=() [1/2]

Cylinder& operator= ( Cylinder &&  )
default

◆ operator=() [2/2]

Cylinder& operator= ( const Cylinder )
default

◆ radius()

double radius ( ) const

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