Gazebo Rendering

API Reference

6.6.3
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. More...
 
 BoundingBox (BoundingBox &&_box) noexcept
 Move constructor. More...
 
 BoundingBox (const BoundingBox &_box)
 Copy constructor. More...
 
virtual ~BoundingBox ()
 Destructor. More...
 
const math::Vector3dCenter () const
 Get the center of the bounding box. More...
 
uint32_t Label () const
 Get the label of the bounding box. More...
 
BoundingBoxoperator= (BoundingBox &&_box)
 Move assignment operator. More...
 
BoundingBoxoperator= (const BoundingBox &_box)
 Copy Assignment operator. More...
 
const math::QuaterniondOrientation () const
 Get the orientation of the bounding box. More...
 
void SetCenter (const math::Vector3d &_center)
 Set the center of the bounding box. More...
 
void SetLabel (uint32_t _label)
 Set the label of the bounding box. More...
 
void SetOrientation (const math::Quaterniond &_orientation)
 Set the orientation of the bounding box. More...
 
void SetSize (const math::Vector3d &_size)
 Set the size of the bounding box. More...
 
const math::Vector3dSize () const
 Get the size of the bounding box. More...
 
const std::vector< math::Vector3d > & Vertices3D () const
 Get the vertices of the 3D bounding box representation. More...
 

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]

Constructor.

◆ BoundingBox() [2/3]

BoundingBox ( const BoundingBox _box)

Copy constructor.

Parameters
[in]_boxBoundingBox to copy.

◆ BoundingBox() [3/3]

BoundingBox ( BoundingBox &&  _box)
noexcept

Move constructor.

Parameters
[in]_boxBoundingBox to move.

◆ ~BoundingBox()

virtual ~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)

Move assignment operator.

Parameters
[in]_boxHeightmap box to move.
Returns
Reference to this.

◆ operator=() [2/2]

BoundingBox& operator= ( const BoundingBox _box)

Copy Assignment operator.

Parameters
[in]_boxThe 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]_centerThe 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]_labelThe label of the bounding box.

◆ SetOrientation()

void SetOrientation ( const math::Quaterniond _orientation)

Set the orientation of the bounding box.

Parameters
[in]_orientationThe orientation of the bounding box, in camera coordinates.

◆ SetSize()

void SetSize ( const math::Vector3d _size)

Set the size of the bounding box.

Parameters
[in]_sizeThe 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: