omni::geometry::Box Class Reference

A box defines a 3D bounding box with a min and max point. More...

#include <Box.h>

Public Member Functions
	Box ()
	Default constructor. More...
	Box (QVector3D const &_min, QVector3D const &_max)
	Constructor by min and max vector. More...
QVector3D	size () const
	Returns the size of the box (= max - min) More...
qreal	radius () const
	Returns radius of the box (= half length of size vector) More...
QVector3D	min () const
	Returns the minimum point. More...
QVector3D	max () const
	Returns the maximum point. More...
void	setMin (QVector3D const &)
	Set minimum point of the box. More...
void	setMax (QVector3D const &)
	Set maximum point of the box. More...
void	setMinMax (QVector3D const &, QVector3D const &)
	Set minimum and maximum together. More...
void	extend (QVector3D const &)
	Extend dimenstions of box by point. More...
QVector3D	center () const
	Return the center point of the box. More...

Private Member Functions
void	validate ()
	Check if min < max and swap if necessary. More...

Private Attributes
QVector3D	min_
QVector3D	max_

Detailed Description

A box defines a 3D bounding box with a min and max point.

Constructor & Destructor Documentation

omni::geometry::Box::Box

(

)

Default constructor.

    {
      auto _min = std::numeric_limits<float>::min();
      auto _max = std::numeric_limits<float>::max();

      min_ = QVector3D(_max, _max, _max);
      max_ = QVector3D(_min, _min, _min);
    }

omni::geometry::Box::Box	(	QVector3D const &	_min,
		QVector3D const &	_max
	)

Constructor by min and max vector.

    {
      setMinMax(_min, _max);
    }

Member Function Documentation

QVector3D omni::geometry::Box::center

(

)

const

Return the center point of the box.

                                {
      return 0.5 * (min_ + max_);
    }

void omni::geometry::Box::extend

(

QVector3D const &

_v

)

Extend dimenstions of box by point.

                                        {
      for (int i = 0; i < 3; ++i) {
        min_[i] = std::min(_v[i], min_[i]);
        max_[i] = std::max(_v[i], max_[i]);
      }
      validate();
    }

QVector3D omni::geometry::Box::max

(

)

const

Returns the maximum point.

    {
      return max_;
    }

QVector3D omni::geometry::Box::min

(

)

const

Returns the minimum point.

    {
      return min_;
    }

qreal omni::geometry::Box::radius

(

)

const

Returns radius of the box (= half length of size vector)

    {
      return size().length() * 0.5;
    }

void omni::geometry::Box::setMax

(

QVector3D const &

_max

)

Set maximum point of the box.

    {
      max_ = _max;
      validate();
    }

void omni::geometry::Box::setMin

(

QVector3D const &

_min

)

Set minimum point of the box.

    {
      min_ = _min;
      validate();
    }

void omni::geometry::Box::setMinMax	(	QVector3D const &	_min,
		QVector3D const &	_max
	)

Set minimum and maximum together.

    {
      min_ = _min;
      max_ = _max;
      validate();
    }

QVector3D omni::geometry::Box::size

(

)

const

Returns the size of the box (= max - min)

    {
      return max() - min();
    }

void omni::geometry::Box::validate ( )

private

Check if min < max and swap if necessary.

    {
      for (int i = 0; i < 3; ++i)
      {
        if (min_[i] > max_[i]) std::swap(min_[i], max_[i]);
      }
    }

Field Documentation

QVector3D omni::geometry::Box::max_

private

QVector3D omni::geometry::Box::min_

private

---

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

• include/omni/geometry/Box.h
• src/lib/geometry/Box.cpp