RBox Class Reference

Represents a box e.g. More...

#include <RBox.h>

List of all members.

Public Member Functions
bool	contains (const RBox &other) const
bool	contains (const RVector &v) const
RVector	getCenter () const
RVector	getCorner1 ()
RVector	getCorner2 ()
QList< RVector >	getCorners () const
QList< RVector >	getCorners2d () const
double	getHeight () const
QList< RLine >	getLines2d () const
RVector	getMaximum () const
RVector	getMinimum () const
RPolyline	getPolyline2d () const
RVector	getSize () const
QList< RTriangle >	getTriangles () const
double	getWidth () const
RBox &	grow (double offset)
void	growToInclude (const RBox &other)
	Grows this box to include the given box or sets this box to the given box if this box is invalid.
void	growToInclude (const RVector &v)
	Grows this box to include the given point.
RBox &	growXY (double offset)
bool	intersects (const RBox &other) const
bool	isOutside (const RBox &other) const
bool	isValid () const
bool	operator!= (const RBox &other) const
bool	operator== (const RBox &other) const
	== operator
	RBox ()
	Constructor for an invalid box with invalid corner points.
	RBox (const QRectF &rect)
	Constructor for a box based on the given QRectF object.
	RBox (const RVector &c1, const RVector &c2)
	Constructor for a box with two given diagonally opposite corners.
	RBox (const RVector &center, double range)
	Creates a square box with the given center and the given range (= side length / 2).
void	setCorner1 (const RVector &v)
void	setCorner2 (const RVector &v)
QRectF	toQRectF () const

Public Attributes
RVector	c1
	Getter function for this property: getCorner1.
RVector	c2
	Getter function for this property: getCorner2.

---

Detailed Description

Represents a box e.g.

a bounding box. The surfaces of the box are orthogonal to the Cartesian coordinate system.

Scriptable:

This class is wrapped for script environments.

Shared Pointer Support:

Script wrappers of this class support wrapping in QSharedPointer.

Copyable:

Script wrappers of this class should pass objects by reference.

---

Constructor & Destructor Documentation

RBox::RBox

(

)

Constructor for an invalid box with invalid corner points.

RBox::RBox ( const QRectF &  rect )

explicit

Constructor for a box based on the given QRectF object.

RBox::RBox	(	const RVector &	c1,
		const RVector &	c2
	)

Constructor for a box with two given diagonally opposite corners.

RBox::RBox	(	const RVector &	center,
		double	range
	)

Creates a square box with the given center and the given range (= side length / 2).

---

Member Function Documentation

bool RBox::contains

(

const RBox &

other

)

const

Returns:

True if the given box is completely inside this box.

bool RBox::contains

(

const RVector &

v

)

const

Returns:

True if the given vector is inside this box.

RVector RBox::getCenter

(

)

const

RVector RBox::getCorner1

(

)

RVector RBox::getCorner2

(

)

QList< RVector > RBox::getCorners

(

)

const

Returns:

8 vectors for the eight corners of the box.

The first box corner is the first defining corner c1. The next three corners are the corners on the same Z level as c1, counter-clockwise. The next four corners are on the same Z-level as c2 starting with the corner at the same X/Y position as c1, continueing counter-clockwise.

QList< RVector > RBox::getCorners2d

(

)

const

double RBox::getHeight

(

)

const

QList< RLine > RBox::getLines2d

(

)

const

RVector RBox::getMaximum

(

)

const

RVector RBox::getMinimum

(

)

const

RPolyline RBox::getPolyline2d

(

)

const

RVector RBox::getSize

(

)

const

QList< RTriangle > RBox::getTriangles

(

)

const

Returns:

12 triangles, two for each side of the box.

double RBox::getWidth

(

)

const

RBox & RBox::grow

(

double

offset

)

void RBox::growToInclude

(

const RBox &

other

)

Grows this box to include the given box or sets this box to the given box if this box is invalid.

void RBox::growToInclude

(

const RVector &

v

)

Grows this box to include the given point.

RBox & RBox::growXY

(

double

offset

)

bool RBox::intersects

(

const RBox &

other

)

const

bool RBox::isOutside

(

const RBox &

other

)

const

Returns:

True if this box is completely inside the given box.

True if the given box is completely outside this box.

bool RBox::isValid

(

)

const

bool RBox::operator!= ( const RBox &  other ) const

inline

bool RBox::operator==

(

const RBox &

other

)

const

== operator

void RBox::setCorner1

(

const RVector &

v

)

void RBox::setCorner2

(

const RVector &

v

)

QRectF RBox::toQRectF

(

)

const

---

Member Data Documentation

RVector RBox::c1

Getter function for this property: getCorner1.

Setter function for this property: setCorner1

RVector RBox::c2

Getter function for this property: getCorner2.

Setter function for this property: setCorner2

---

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

• src/math/RBox.h
• src/math/RBox.cpp