C++ class Geometry::_Box
_{template< typename value_t >}
_Box

public

Inheritance Graph

graph BT
	_Box
	click _Box "classGeometry_1_1__Box"

Description

Three-dimensional axis-aligned box. [Box]

Main

	_Box()
	_Box(value_t minx, value_t maxx, value_t miny, value_t maxy, value_t minz, value_t maxz)
	_Box(const vec3_t & center, value_t size)
	_Box(const vec3_t & center, value_t dimX, value_t dimY, value_t dimZ)
	_Box(const vec3_t & cornerA, const vec3_t & cornerB)

Information

value_t	getMaxX() const
value_t	getMaxY() const
value_t	getMaxZ() const
value_t	getMax( dimension_t dim) const
const vec3_t &	getMax() const
value_t	getMinX() const
value_t	getMinY() const
value_t	getMinZ() const
value_t	getMin( dimension_t dim) const
const vec3_t &	getMin() const
value_t	getExtentMax() const
value_t	getExtentMin() const
value_t	getExtentX() const
value_t	getExtentY() const
value_t	getExtentZ() const
value_t	getExtent( dimension_t dim) const
value_t	getDiameter() const
value_t	getDiameterSquared() const
value_t	getVolume() const
value_t	getSurfaceArea() const
vec3_t	getCorner(const corner_t corner) const
corner_t	getOctant(const vec3_t & v) const
bool	contains(value_t x, value_t y, value_t z) const
bool	contains(const vec3_t & p) const
bool	contains(const _Box & b) const
value_t	getDistance(const vec3_t & p) const
value_t	getDistanceSquared(const vec3_t & p) const
vec3_t	getClosestPoint(const vec3_t & p) const
bool	isValid() const
bool	isInvalid() const
vec3_t	getCenter() const
value_t	getBoundingSphereRadius() const
corner_t	getOppositeCorner(const corner_t corner)

Modification

void	invalidate()
void	setMaxX(value_t x)
void	setMaxY(value_t y)
void	setMaxZ(value_t z)
void	setMax( dimension_t dim, value_t value)
void	setMax(const vec3_t & newMax)
void	setMinX(value_t x)
void	setMinY(value_t y)
void	setMinZ(value_t z)
void	setMin( dimension_t dim, value_t value)
void	setMin(const vec3_t & newMin)
void	include(const _Box & b)
void	include(const value_t x, const value_t y, const value_t z)
void	set(value_t minX, value_t maxX, value_t minY, value_t maxY, value_t minZ, value_t maxZ)
void	set(value_t x, value_t y, value_t z)
void	include(const vec3_t & p)
void	setCenter(const vec3_t & v)
void	resizeAbs(value_t size)
void	resizeRel(value_t relSize)
void	resizeAbs(value_t sizeX, value_t sizeY, value_t sizeZ)
void	resizeRel(value_t relSizeX, value_t relSizeY, value_t relSizeZ)
void	translate(const vec3_t & v)
void	setExtent(value_t ex)
void	setExtentX(value_t ex)
void	setExtentY(value_t ey)
void	setExtentZ(value_t ez)

Comparators

bool	operator==(const _Box & b) const
bool	operator!=(const _Box & b) const

Serialization

Public Types

typedef _Vec3 < value_t >	vec3_t

---

Documentation

function
Geometry::_Box::_Box

public

inline

_Box(	)

_{Defined in Geometry/Box.h:44}

---

function
Geometry::_Box::_Box

public

inline

_Box(	value_t	minx,
	value_t	maxx,
	value_t	miny,
	value_t	maxy,
	value_t	minz,
	value_t	maxz
)

_{Defined in Geometry/Box.h:46}

---

function
Geometry::_Box::_Box

public

inline

_Box(	const vec3_t &	center,
	value_t	size
)

_{Defined in Geometry/Box.h:49}

---

function
Geometry::_Box::_Box

public

inline

_Box(	const vec3_t &	center,
	value_t	dimX,
	value_t	dimY,
	value_t	dimZ
)

_{Defined in Geometry/Box.h:53}

---

function
Geometry::_Box::_Box

public

inline

_Box(	const vec3_t &	cornerA,
	const vec3_t &	cornerB
)

_{Defined in Geometry/Box.h:57}

---

function
Geometry::_Box::getMaxX

public

const

inline

value_t getMaxX(	) const

_{Defined in Geometry/Box.h:70}

---

function
Geometry::_Box::getMaxY

public

const

inline

value_t getMaxY(	) const

_{Defined in Geometry/Box.h:73}

---

function
Geometry::_Box::getMaxZ

public

const

inline

value_t getMaxZ(	) const

_{Defined in Geometry/Box.h:76}

---

function
Geometry::_Box::getMax

public

const

inline

value_t getMax(	dimension_t	dim ) const

_{Defined in Geometry/Box.h:79}

---

function
Geometry::_Box::getMax

public

const

inline

const vec3_t & getMax(	) const

_{Defined in Geometry/Box.h:80}

---

function
Geometry::_Box::getMinX

public

const

inline

value_t getMinX(	) const

_{Defined in Geometry/Box.h:83}

---

function
Geometry::_Box::getMinY

public

const

inline

value_t getMinY(	) const

_{Defined in Geometry/Box.h:86}

---

function
Geometry::_Box::getMinZ

public

const

inline

value_t getMinZ(	) const

_{Defined in Geometry/Box.h:89}

---

function
Geometry::_Box::getMin

public

const

inline

value_t getMin(	dimension_t	dim ) const

_{Defined in Geometry/Box.h:92}

---

function
Geometry::_Box::getMin

public

const

inline

const vec3_t & getMin(	) const

_{Defined in Geometry/Box.h:93}

---

function
Geometry::_Box::getExtentMax

public

const

inline

value_t getExtentMax(	) const

_{Defined in Geometry/Box.h:96}

---

function
Geometry::_Box::getExtentMin

public

const

inline

value_t getExtentMin(	) const

_{Defined in Geometry/Box.h:97}

---

function
Geometry::_Box::getExtentX

public

const

inline

value_t getExtentX(	) const

_{Defined in Geometry/Box.h:98}

---

function
Geometry::_Box::getExtentY

public

const

inline

value_t getExtentY(	) const

_{Defined in Geometry/Box.h:101}

---

function
Geometry::_Box::getExtentZ

public

const

inline

value_t getExtentZ(	) const

_{Defined in Geometry/Box.h:104}

---

function
Geometry::_Box::getExtent

public

const

inline

value_t getExtent(	dimension_t	dim ) const

_{Defined in Geometry/Box.h:107}

---

function
Geometry::_Box::getDiameter

public

const

inline

value_t getDiameter(	) const

Returns

length of the space diagonal

_{Defined in Geometry/Box.h:112}

---

function
Geometry::_Box::getDiameterSquared

public

const

inline

value_t getDiameterSquared(	) const

Returns

squared length of the space diagonal

_{Defined in Geometry/Box.h:117}

---

function
Geometry::_Box::getVolume

public

const

inline

value_t getVolume(	) const

_{Defined in Geometry/Box.h:119}

---

function
Geometry::_Box::getSurfaceArea

public

const

inline

value_t getSurfaceArea(	) const

_{Defined in Geometry/Box.h:120}

---

function
Geometry::_Box::getCorner

public

const

inline

vec3_t getCorner(	const corner_t	corner ) const

_{Defined in Geometry/Box.h:122}

---

function
Geometry::_Box::getOctant

public

const

inline

corner_t getOctant(	const vec3_t &	v ) const

_{Defined in Geometry/Box.h:137}

---

function
Geometry::_Box::contains

public

const

inline

bool contains(	value_t	x,
	value_t	y,
	value_t	z
) const

_{Defined in Geometry/Box.h:139}

---

function
Geometry::_Box::contains

public

const

inline

bool contains(	const vec3_t &	p ) const

_{Defined in Geometry/Box.h:140}

---

function
Geometry::_Box::contains

public

const

inline

bool contains(	const _Box &	b ) const

_{Defined in Geometry/Box.h:141}

---

function
Geometry::_Box::getDistance

public

const

inline

value_t getDistance(	const vec3_t &	p ) const

Parameters

p

Point to be used for calculations

Returns

the distance between this and p

Note: distance is defined as the minimum distance p has to be moved such that this.contains(p) returns true

_{Defined in Geometry/Box.h:150}

---

function
Geometry::_Box::getDistanceSquared

public

const

inline

value_t getDistanceSquared(	const vec3_t &	p ) const

same as getDistance, but faster because of missing sqrt() call

_{Defined in Geometry/Box.h:154}

---

function
Geometry::_Box::getClosestPoint

public

const

inline

vec3_t getClosestPoint(	const vec3_t &	p ) const

_{Defined in Geometry/Box.h:156}

---

function
Geometry::_Box::isValid

public

const

inline

bool isValid(	) const

_{Defined in Geometry/Box.h:158}

---

function
Geometry::_Box::isInvalid

public

const

inline

bool isInvalid(	) const

_{Defined in Geometry/Box.h:159}

---

function
Geometry::_Box::getCenter

public

const

inline

vec3_t getCenter(	) const

_{Defined in Geometry/Box.h:163}

---

function
Geometry::_Box::getBoundingSphereRadius

public

const

inline

value_t getBoundingSphereRadius(	) const

_{Defined in Geometry/Box.h:166}

---

function
Geometry::_Box::getOppositeCorner

public

static

inline

corner_t getOppositeCorner(	const corner_t	corner )

Retrieve the corner index which does not share any side with the given corner index.

Parameters

corner

Index of a box corner.

Returns

Index of the corner that is on the other end of the box’s diagonal starting at the given corner.

_{Defined in Geometry/Box.h:129}

---

function
Geometry::_Box::invalidate

public

inline

void invalidate(	)

_{Defined in Geometry/Box.h:175}

---

function
Geometry::_Box::setMaxX

public

inline

void setMaxX(	value_t	x )

_{Defined in Geometry/Box.h:176}

---

function
Geometry::_Box::setMaxY

public

inline

void setMaxY(	value_t	y )

_{Defined in Geometry/Box.h:179}

---

function
Geometry::_Box::setMaxZ

public

inline

void setMaxZ(	value_t	z )

_{Defined in Geometry/Box.h:182}

---

function
Geometry::_Box::setMax

public

inline

void setMax(	dimension_t	dim,
	value_t	value
)

_{Defined in Geometry/Box.h:185}

---

function
Geometry::_Box::setMax

public

inline

void setMax(	const vec3_t &	newMax )

_{Defined in Geometry/Box.h:186}

---

function
Geometry::_Box::setMinX

public

inline

void setMinX(	value_t	x )

_{Defined in Geometry/Box.h:189}

---

function
Geometry::_Box::setMinY

public

inline

void setMinY(	value_t	y )

_{Defined in Geometry/Box.h:192}

---

function
Geometry::_Box::setMinZ

public

inline

void setMinZ(	value_t	z )

_{Defined in Geometry/Box.h:195}

---

function
Geometry::_Box::setMin

public

inline

void setMin(	dimension_t	dim,
	value_t	value
)

_{Defined in Geometry/Box.h:198}

---

function
Geometry::_Box::setMin

public

inline

void setMin(	const vec3_t &	newMin )

_{Defined in Geometry/Box.h:199}

---

function
Geometry::_Box::include

public

inline

void include(	const _Box &	b )

_{Defined in Geometry/Box.h:202}

---

function
Geometry::_Box::include

public

inline

void include(	const value_t	x,
	const value_t	y,
	const value_t	z
)

_{Defined in Geometry/Box.h:203}

---

function
Geometry::_Box::set

public

inline

void set(	value_t	minX,
	value_t	maxX,
	value_t	minY,
	value_t	maxY,
	value_t	minZ,
	value_t	maxZ
)

_{Defined in Geometry/Box.h:204}

---

function
Geometry::_Box::set

public

inline

void set(	value_t	x,
	value_t	y,
	value_t	z
)

_{Defined in Geometry/Box.h:205}

---

function
Geometry::_Box::include

public

inline

void include(	const vec3_t &	p )

_{Defined in Geometry/Box.h:206}

---

function
Geometry::_Box::setCenter

public

inline

void setCenter(	const vec3_t &	v )

_{Defined in Geometry/Box.h:207}

---

function
Geometry::_Box::resizeAbs

public

inline

void resizeAbs(	value_t	size )

_{Defined in Geometry/Box.h:208}

---

function
Geometry::_Box::resizeRel

public

inline

void resizeRel(	value_t	relSize )

_{Defined in Geometry/Box.h:209}

---

function
Geometry::_Box::resizeAbs

public

inline

void resizeAbs(	value_t	sizeX,
	value_t	sizeY,
	value_t	sizeZ
)

_{Defined in Geometry/Box.h:210}

---

function
Geometry::_Box::resizeRel

public

inline

void resizeRel(	value_t	relSizeX,
	value_t	relSizeY,
	value_t	relSizeZ
)

_{Defined in Geometry/Box.h:211}

---

function
Geometry::_Box::translate

public

inline

void translate(	const vec3_t &	v )

_{Defined in Geometry/Box.h:212}

---

function
Geometry::_Box::setExtent

public

inline

void setExtent(	value_t	ex )

_{Defined in Geometry/Box.h:216}

---

function
Geometry::_Box::setExtentX

public

inline

void setExtentX(	value_t	ex )

_{Defined in Geometry/Box.h:217}

---

function
Geometry::_Box::setExtentY

public

inline

void setExtentY(	value_t	ey )

_{Defined in Geometry/Box.h:218}

---

function
Geometry::_Box::setExtentZ

public

inline

void setExtentZ(	value_t	ez )

_{Defined in Geometry/Box.h:219}

---

function
Geometry::_Box::operator==

public

const

inline

bool operator==(	const _Box &	b ) const

_{Defined in Geometry/Box.h:226}

---

function
Geometry::_Box::operator!=

public

const

inline

bool operator!=(	const _Box &	b ) const

_{Defined in Geometry/Box.h:229}

---

typedef
Geometry::_Box::vec3_t

public

typedef _Vec3 < value_t > vec3_t

_{Defined in Geometry/Box.h:33}

---