Cylinder Class Reference

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...
	Cylinder (const Vector2< double > &measures)
	Constructs a cylinder with a vector of measures: radius and length. More...
	~Cylinder () final
double	radius () const
double	length () const
Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable
	Cylinder (const Cylinder &)=default
Cylinder &	operator= (const Cylinder &)=default
	Cylinder (Cylinder &&)=default
Cylinder &	operator= (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< Shape >	Clone () 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...
Shape &	operator= (const Shape &)=default
	(Internal use only) For derived classes. More...
	Shape (Shape &&)=default
	(Internal use only) For derived classes. More...
Shape &	operator= (Shape &&)=default
	(Internal use only) For derived classes. More...

Constructor & Destructor Documentation

Cylinder() [1/4]

Cylinder ( const Cylinder &  )

default

Cylinder() [2/4]

Cylinder ( Cylinder &&  )

default

Cylinder() [3/4]

Cylinder	(	double	radius,
		double	length
	)

Constructs a cylinder with the given radius and length.

Exceptions

std::exception

if radius or length are not strictly positive.

Cylinder() [4/4]

Cylinder ( const Vector2< double > &  measures )

explicit

Constructs a cylinder with a vector of measures: radius and length.

Exceptions

std::exception

if the measures are not strictly positive.

~Cylinder()

~Cylinder ( )

final

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:

• drake/geometry/shape_specification.h