Drake
Box Class Referencefinal

Definition of a box. More...

#include <drake/geometry/shape_specification.h>

Inheritance diagram for Box:
[legend]
Collaboration diagram for Box:
[legend]

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...
 
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...
 

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
 

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.

Constructor & Destructor Documentation

Box ( const Box )
default
Box ( Box &&  )
default
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.

Member Function Documentation

double depth ( ) const
inline

Returns the box's dimension along the y axis.

double height ( ) const
inline

Returns the box's dimension along the z axis.

Box& operator= ( const Box )
default
Box& operator= ( Box &&  )
default
const Vector3<double>& size ( ) const
inline

Returns the box's dimensions.

double width ( ) const
inline

Returns the box's dimension along the x axis.


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