Drake
Drake C++ Documentation
Box Class Referencefinal

Detailed Description

Definition of a box.

The box is centered on the origin of its canonical frame with its dimensions aligned with the frame's axes. The size of the box is given by three sizes.

#include <drake/geometry/shape_specification.h>

Public Member Functions

Box (double width, double depth, double height)
Constructs a box with the given width, depth, and height, which specify the box's dimension along the canonical x-, y-, and z-axes, respectively. More...

Box (const Vector3< double > &measures)
Constructs a box with a vector of measures: width, depth, and height – the box's dimensions along the canonical x-, y-, and z-axes, respectively. More...

double width () const
Returns the box's dimension along the x axis. More...

double depth () const
Returns the box's dimension along the y axis. More...

double height () const
Returns the box's dimension along the z axis. More...

const Vector3< double > & size () const
Returns the box's dimensions. More...

Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable
Box (const Box &)=default

Boxoperator= (const Box &)=default

Box (Box &&)=default

Boxoperator= (Box &&)=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...

Static Public Member Functions

static Box MakeCube (double edge_size)
Constructs a cube with the given edge_size for its width, depth, and height. More...

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

◆ Box() [1/4]

 Box ( const Box & )
default

◆ Box() [2/4]

 Box ( Box && )
default

◆ Box() [3/4]

 Box ( double width, double depth, double height )

Constructs a box with the given width, depth, and height, which specify the box's dimension along the canonical x-, y-, and z-axes, respectively.

Exceptions
 std::exception if width, depth or height are not strictly positive.

◆ Box() [4/4]

 Box ( const Vector3< double > & measures )
explicit

Constructs a box with a vector of measures: width, depth, and height – the box's dimensions along the canonical x-, y-, and z-axes, respectively.

Exceptions
 std::exception if the measures are not strictly positive.

◆ depth()

 double depth ( ) const

Returns the box's dimension along the y axis.

◆ height()

 double height ( ) const

Returns the box's dimension along the z axis.

◆ MakeCube()

 static Box MakeCube ( double edge_size )
static

Constructs a cube with the given edge_size for its width, depth, and height.

◆ operator=() [1/2]

 Box& operator= ( Box && )
default

◆ operator=() [2/2]

 Box& operator= ( const Box & )
default

◆ size()

 const Vector3& size ( ) const

Returns the box's dimensions.

◆ width()

 double width ( ) const

Returns the box's dimension along the x axis.

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