iso::geom::Cuboid Class Reference

#include <iso_geom_cuboid.h>

Inherits iso::geom::Geometry.

Inheritance diagram for iso::geom::Cuboid:

[legend]Collaboration diagram for iso::geom::Cuboid:

[legend]List of all members.

Public Member Functions
	Cuboid (unsigned int pDim)
	create cuboid
	Cuboid (const math::Rectangle< real > &pRect)
	create cuboid
	Cuboid (const math::Vector< real > &pMinPos, const math::Vector< real > &pMaxPos)
	create cuboid
virtual	~Cuboid ()
	destructor
virtual void	calcMinMaxPos ()
	calculate minimum and maximum positions
math::Vector< real >	size () const
	return size
math::Vector< real > &	minPos ()
	return minimum position
math::Vector< real > &	maxPos ()
	return maximum position
const math::Vector< real > &	minPos () const
	return minimum position
const math::Vector< real > &	maxPos () const
	return maximum position
void	setMinPos (real pValue)
	set minimum position
void	setMinPos (const math::Vector< real > &pMinPos)
	set minimum position
void	setMinPos (const real *pValues)
	set minimum position
void	setMaxPos (real pValue)
	set maximum position
void	setMaxPos (const math::Vector< real > &pMaxPos)
	set maximum position
void	setMaxPos (const real *pValues)
	set maximum position
void	set (const math::Rectangle< real > &pRect)
	set min and max position
void	set (const math::Vector< real > &pMinPos, const math::Vector< real > &pMaxPos)
	set minimum and maximum positions
void	set (const real *pMinValues, const real *pMaxValues)
	set minimum and maximum positions
virtual void	closestPoint (const math::Vector< real > &pRefPoint, math::Vector< real > &pResPoint)
	return closest point
Protected Member Functions
	Cuboid ()
	default constructor
Protected Attributes
math::Rectangle< real >	mRect
	cuboid rectangle

---

Constructor & Destructor Documentation

Cuboid::Cuboid

(

unsigned int

pDim

)

create cuboid

Parameters:

pDim

dimension

Cuboid::Cuboid

(

const math::Rectangle< real > &

pRect

)

create cuboid

Parameters:

pRect

cuboid rectangle

Cuboid::Cuboid	(	const math::Vector< real > &	pMinPos,
		const math::Vector< real > &	pMaxPos
	)

create cuboid

Parameters:

	pMinPos	minimum position
	pMaxPos	maximum position

Cuboid::~Cuboid

(

)

[virtual]

destructor

Cuboid::Cuboid

(

)

[protected]

default constructor

---

Member Function Documentation

void Cuboid::calcMinMaxPos

(

)

[virtual]

calculate minimum and maximum positions

Implements iso::geom::Geometry.

math::Vector< real > Cuboid::size

(

)

const

return size

Returns:

size

math::Vector< real > & Cuboid::minPos

(

)

return minimum position

Returns:

minimum position

math::Vector< real > & Cuboid::maxPos

(

)

return maximum position

Returns:

maximum position

const math::Vector< real > & Cuboid::minPos

(

)

const

return minimum position

Returns:

minimum position

Reimplemented from iso::geom::Geometry.

const math::Vector< real > & Cuboid::maxPos

(

)

const

return maximum position

Returns:

maximum position

Reimplemented from iso::geom::Geometry.

void Cuboid::setMinPos

(

real

pValue

)

set minimum position

Parameters:

pValue

minimum position value

Remarks:

fails if position is bigger than maximum position

void Cuboid::setMinPos

(

const math::Vector< real > &

pMinPos

)

set minimum position

Parameters:

pMinPos

minimum position

Remarks:

fails if dimension of position is wrong or position is bigger than maximum position

void Cuboid::setMinPos

(

const real *

pValues

)

set minimum position

Parameters:

pValues

array of minimum position values

Remarks:

position is bigger than maximum position

void Cuboid::setMaxPos

(

real

pValue

)

set maximum position

Parameters:

pValue

maximum position value

Remarks:

fails if position is smaller than minimum position

void Cuboid::setMaxPos

(

const math::Vector< real > &

pMaxPos

)

set maximum position

Parameters:

pMaxPos

maximum position

Remarks:

fails if dimension of position is wrong or position is smaller than minimum position

void Cuboid::setMaxPos

(

const real *

pValues

)

set maximum position

Parameters:

pValues

array of maximum position values

Remarks:

position is smaller than minimum position

void Cuboid::set

(

const math::Rectangle< real > &

pRect

)

set min and max position

Parameters:

pRect

rect

void Cuboid::set	(	const math::Vector< real > &	pMinPos,
		const math::Vector< real > &	pMaxPos
	)

set minimum and maximum positions

Parameters:

	pMinPos	minimum position
	pMaxPos	maximum position

Remarks:

fails if dimension of one position is wrong or minimum position is bigger than maximum position

void Cuboid::set	(	const real *	pMinValues,
		const real *	pMaxValues
	)

set minimum and maximum positions

Parameters:

	pMinValues	array of minimum position values
	pMaxValues	arary of maximum position values

Remarks:

fails if minimum position is bigger than maximum position

void Cuboid::closestPoint	(	const math::Vector< real > &	pRefPoint,
		math::Vector< real > &	pResPoint
	)			[virtual]

return closest point

Parameters:

	pRefPoint	reference points
	pResPoint	result point

Remarks:

fails if dimension of reference and result points don't match dimension of geometry

Implements iso::geom::Geometry.

---

Member Data Documentation

math::Rectangle<real> iso::geom::Cuboid::mRect [protected]

cuboid rectangle

---

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

• /Users/dbisig/programming/swarms/trunk/geom/trunk/code/iso_geom_cuboid.h
• /Users/dbisig/programming/swarms/trunk/geom/trunk/code/iso_geom_cuboid.cpp

---