|
Drake
|
|
Drake
|
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. | |
| 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. | |
| ~Box () final | |
| double | width () const |
| Returns the box's dimension along the x axis. | |
| double | depth () const |
| Returns the box's dimension along the y axis. | |
| double | height () const |
| Returns the box's dimension along the z axis. | |
| const Vector3< double > & | size () const |
| Returns the box's dimensions. | |
Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable | |
| Box (const Box &)=default | |
| Box & | operator= (const Box &)=default |
| Box (Box &&)=default | |
| Box & | operator= (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. | |
| std::unique_ptr< Shape > | Clone () const |
| Creates a unique copy of this shape. | |
| std::string_view | type_name () const |
| Returns the (unqualified) type name of this Shape, e.g., "Box". | |
| std::string | to_string () const |
| Returns a string representation of this shape. | |
| 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. | |
Static Public Member Functions | |
| static Box | MakeCube (double edge_size) |
| Constructs a cube with the given edge_size for its width, depth, and height. | |
Additional Inherited Members | |
| Protected Types inherited from Shape | |
| using | VariantShapeConstPtr |
| (Internal use only) All concrete subclasses, as const pointers. | |
| Protected Member Functions inherited from Shape | |
| Shape () | |
| (Internal use only) Constructor for use by derived classes. | |
| Shape (const Shape &)=default | |
| (Internal use only) For derived classes. | |
| Shape & | operator= (const Shape &)=default |
| (Internal use only) For derived classes. | |
| Shape (Shape &&)=default | |
| (Internal use only) For derived classes. | |
| Shape & | operator= (Shape &&)=default |
| (Internal use only) For derived classes. | |
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.
| std::exception | if any measure is not finite positive. |
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.
| std::exception | if any measure is not finite positive. |
|
final |
| double depth | ( | ) | const |
Returns the box's dimension along the y axis.
| double height | ( | ) | const |
Returns the box's dimension along the z axis.
Constructs a cube with the given edge_size for its width, depth, and height.
| std::exception | if edge_size is not finite positive. |
| double width | ( | ) | const |
Returns the box's dimension along the x axis.