Box Class Reference

A box and related functions. More...

#include <Box.hh>

List of all members.

Public Member Functions
	Box ()
	Default constructor.
	Box (const Vector3 &_min, const Vector3 &_max)
	Constructor.
	Box (const Box &b)
	Copy Constructor.
virtual	~Box ()
	Destructor.
double	GetXLength () const
	Get the length along the x dimension.
double	GetYLength () const
	Get the length along the y dimension.
double	GetZLength () const
	Get the length along the z dimension.
math::Vector3	GetSize () const
	Get the size of the box.
math::Vector3	GetCenter () const
	Get the box center.
void	Merge (const Box &_box)
	Merge a box with this box.
const Box &	operator= (const Box &_b)
	Equal operator.
Box	operator+ (const Box &_b) const
	Addition operator.
const Box &	operator+= (const Box &_b)
	Addition set operator.
Public Attributes
Vector3	min
	Minimum corner of the box.
Vector3	max
	Maximum corner of the box.
Friends
std::ostream &	operator<< (std::ostream &_out, const gazebo::math::Box &_b)
	Output operator.

---

Detailed Description

A box and related functions.

---

Constructor & Destructor Documentation

Box	(	const Vector3 &	_min,
		const Vector3 &	_max
	)

Constructor.

Parameters:

_min	Minimum corner of the box
_max	Maximum corner of the box

Box

(

const Box &

b

)

Copy Constructor.

Parameters:

_b	Box to copy

---

Member Function Documentation

math::Vector3 GetCenter

(

)

const

Get the box center.

Returns:

The center position of the box

math::Vector3 GetSize

(

)

const

Get the size of the box.

Returns:

Size of the box

double GetXLength

(

)

const

Get the length along the x dimension.

Returns:

Double value of the length in the x dimension

double GetYLength

(

)

const

Get the length along the y dimension.

Returns:

Double value of the length in the y dimension

double GetZLength

(

)

const

Get the length along the z dimension.

Returns:

Double value of the length in the z dimension

void Merge

(

const Box &

_box

)

Merge a box with this box.

Parameters:

_box	Box to add to this box

Box operator+

(

const Box &

_b

)

const

Addition operator.

result = this + _b

Parameters:

_b	Box to add

Returns:

The new box

const Box& operator+=

(

const Box &

_b

)

Addition set operator.

this = this + _b

Parameters:

_b	Box to add

Returns:

This new box

const Box& operator=

(

const Box &

_b

)

Equal operator.

Set this box to the parameter

Parameters:

_b	Box to copy

Returns:

The new box.

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	_out,
		const gazebo::math::Box &	_b
	)		[friend]

Output operator.

Parameters:

_out	Output stream
_b	Box to output to the stream

Returns:

The stream

---

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

• Box.hh