BoundingBox Class Reference
2D or 3D Bounding box. It stores the position / orientation / size info of the box and its label More...
#include <BoundingBox.hh>
Public Member Functions | |
BoundingBox () | |
Constructor. | |
BoundingBox (BoundingBox &&_box) noexcept | |
Move constructor. | |
BoundingBox (const BoundingBox &_box) | |
Copy constructor. | |
virtual | ~BoundingBox () |
Destructor. | |
const math::Vector3d & | Center () const |
Get the center of the bounding box. | |
uint32_t | Label () const |
Get the label of the bounding box. | |
BoundingBox & | operator= (BoundingBox &&_box) |
Move assignment operator. | |
BoundingBox & | operator= (const BoundingBox &_box) |
Copy Assignment operator. | |
const math::Quaterniond & | Orientation () const |
Get the orientation of the bounding box. | |
void | SetCenter (const math::Vector3d &_center) |
Set the center of the bounding box. | |
void | SetLabel (uint32_t _label) |
Set the label of the bounding box. | |
void | SetOrientation (const math::Quaterniond &_orientation) |
Set the orientation of the bounding box. | |
void | SetSize (const math::Vector3d &_size) |
Set the size of the bounding box. | |
const math::Vector3d & | Size () const |
Get the size of the bounding box. | |
const std::vector< math::Vector3d > & | Vertices3D () const |
Get the vertices of the 3D bounding box representation. | |
Detailed Description
2D or 3D Bounding box. It stores the position / orientation / size info of the box and its label
Constructor & Destructor Documentation
◆ BoundingBox() [1/3]
BoundingBox | ( | ) |
Constructor.
◆ BoundingBox() [2/3]
BoundingBox | ( | const BoundingBox & | _box | ) |
Copy constructor.
- Parameters
-
[in] _box BoundingBox to copy.
◆ BoundingBox() [3/3]
|
noexcept |
Move constructor.
- Parameters
-
[in] _box BoundingBox to move.
◆ ~BoundingBox()
|
virtual |
Destructor.
Member Function Documentation
◆ Center()
const math::Vector3d & Center | ( | ) | const |
Get the center of the bounding box.
- Returns
- The center of the bounding box, in (x,y,z) representation. If this is a 2D bounding box, the z component should be ignored.
◆ Label()
uint32_t Label | ( | ) | const |
Get the label of the bounding box.
- Returns
- The label of the bounding box.
◆ operator=() [1/2]
BoundingBox & operator= | ( | BoundingBox && | _box | ) |
◆ operator=() [2/2]
BoundingBox & operator= | ( | const BoundingBox & | _box | ) |
Copy Assignment operator.
- Parameters
-
[in] _box The heightmap box to set values from.
- Returns
- *this
◆ Orientation()
const math::Quaterniond & Orientation | ( | ) | const |
Get the orientation of the bounding box.
- Returns
- The orientation of the bounding box, in camera coordinates.
◆ SetCenter()
void SetCenter | ( | const math::Vector3d & | _center | ) |
Set the center of the bounding box.
- Parameters
-
[in] _center The center of the bounding box, in (x,y,z) representation. If this is a 2D bounding box, the z component should be ignored.
◆ SetLabel()
void SetLabel | ( | uint32_t | _label | ) |
Set the label of the bounding box.
- Parameters
-
[in] _label The label of the bounding box.
◆ SetOrientation()
void SetOrientation | ( | const math::Quaterniond & | _orientation | ) |
Set the orientation of the bounding box.
- Parameters
-
[in] _orientation The orientation of the bounding box, in camera coordinates.
◆ SetSize()
void SetSize | ( | const math::Vector3d & | _size | ) |
Set the size of the bounding box.
- Parameters
-
[in] _size The size of the box (width, height, depth). If this is a 2D bounding box, the depth should be ignored.
◆ Size()
const math::Vector3d & Size | ( | ) | const |
Get the size of the bounding box.
- Returns
- The size of the box (width, height, depth). If this is a 2D bounding box, the depth should be ignored.
◆ Vertices3D()
const std::vector< math::Vector3d > & Vertices3D | ( | ) | const |
Get the vertices of the 3D bounding box representation.
- Returns
- The vertices, in the following order:
1 -----— 0 /| /| 2 -----— 3 . | | | | . 5 -----— 4 |/ |/ 6 -----— 7
The documentation for this class was generated from the following file: