mds::img::CSize3< T > Class Template Reference

Class representing size of a rectangle box in 3D space. More...

#include <mdsSize.h>

Inheritance diagram for mds::img::CSize3< T >:

List of all members.

Public Types
typedef CCoordinates3< T >	tBase
	tBase class.
typedef tBase::tComponent	tComponent
	Coordinates type.
typedef CLibraryLockableClass < CSmallObjectBase< C, M, A > >::CLock	tLock
	Lock type.
Public Member Functions
	CSize3 ()
	Default constructor.
	CSize3 (const tComponent &size)
	Constructor initializes the size.
	CSize3 (const tComponent &px, const tComponent &py, const tComponent &pz)
	Constructor initializes the size.
	CSize3 (const tBase &p)
	Copy constructor.
const tSize &	depth () const
tSize &	depth ()
tComponent	getMult () const
	Returns multiplication of all coordinates.
tComponent	getSum () const
	Returns sum of all coordinates.
tComponent &	getX ()
	Returns reference to the x-coordinate.
const tComponent &	getX () const
const tSize &	getXSize () const
	Returns the volume size in x-axis (i.e. width).
tSize &	getXSize ()
CCoordinates3 &	getXY (tComponent &px, tComponent &py) const
	Returns XY point coordinates.
CCoordinates3 &	getXYZ (tComponent &px, tComponent &py, tComponent &pz) const
	Returns all point coordinates.
tComponent &	getY ()
	Returns reference to the y-coordinate.
const tComponent &	getY () const
const tSize &	getYSize () const
	Returns the volume size in y-axis (i.e. height).
tSize &	getYSize ()
tComponent &	getZ ()
	Returns reference to the z-coordinate.
const tComponent &	getZ () const
const tSize &	getZSize () const
	Returns the volume size in z-axis (i.e. depth).
tSize &	getZSize ()
const tSize &	height () const
tSize &	height ()
CSize3 &	operator&= (const CSize3 &a)
CCoordinates3 &	operator*= (const CCoordinates3 &p)
CCoordinates3 &	operator*= (const tComponent &c)
CCoordinates3 &	operator+= (const CCoordinates3 &p)
CCoordinates3 &	operator+= (const tComponent &c)
CCoordinates3 &	operator-= (const CCoordinates3 &p)
CCoordinates3 &	operator-= (const tComponent &c)
CCoordinates3 &	operator/= (const CCoordinates3 &p)
CCoordinates3 &	operator/= (const tComponent &c)
CSize3 &	operator= (const tBase &p)
	Assignment operator.
CCoordinates3 &	setX (const tComponent &px)
	Returns point coordinate.
CCoordinates3 &	setXY (const tComponent &px, const tComponent &py)
	Sets XY point coordinates.
CCoordinates3 &	setXYZ (const tComponent &px, const tComponent &py, const tComponent &pz)
	Sets all point coordinates.
CCoordinates3 &	setY (const tComponent &py)
CCoordinates3 &	setZ (const tComponent &pz)
const tSize &	width () const
	Returns the volume size.
tSize &	width ()
tComponent &	x ()
	Returns reference to the x-coordinate.
const tComponent &	x () const
tComponent &	y ()
	Returns reference to the y-coordinate.
const tComponent &	y () const
tComponent &	z ()
	Returns reference to the z-coordinate.
const tComponent &	z () const
	~CSize3 ()
	Destructor.
Static Public Member Functions
static void	lock ()
	Locks the object.
static void	operator delete (void *p, std::size_t Size)
	Deallocates small object.
static void	operator delete (void *p, void *pPlace)
	Placement single-object delete merely calls global placement delete.
static void	operator delete[] (void *p, std::size_t Size)
	Deallocates array-object.
static void	operator delete[] (void *p, void *pPlace)
	Placement array-object delete merely calls global placement delete.
static void *	operator new (std::size_t Size)
	Allocates a small object.
static void *	operator new (std::size_t Size, void *pPlace)
	Placement single-object new merely calls global placement new.
static void *	operator new[] (std::size_t Size)
	Allocates array-object.
static void *	operator new[] (std::size_t Size, void *pPlace)
	Placement array-object new merely calls global placement new.
static void	unlock ()
	Locks the object.
Protected Attributes
tComponent	m_x
	Coordinates in the 3D space.
tComponent	m_y
tComponent	m_z
Friends
bool	operator!= (const CSize3 &a, const CSize3 &b)
bool	operator!= (const CCoordinates3 &l, const CCoordinates3 &r)
CSize3	operator& (const CSize3 &a, const CSize3 &b)
	Operator calculates intersection of two given sizes.
CCoordinates3	operator* (const CCoordinates3 &l, const CCoordinates3 &r)
CCoordinates3	operator+ (const CCoordinates3 &l, const CCoordinates3 &r)
CCoordinates3	operator- (const CCoordinates3 &l, const CCoordinates3 &r)
CCoordinates3	operator/ (const CCoordinates3 &l, const CCoordinates3 &r)
bool	operator== (const CSize3 &a, const CSize3 &b)
	Comparison operators.
bool	operator== (const CCoordinates3 &l, const CCoordinates3 &r)

---

Detailed Description

template<typename T>
class mds::img::CSize3< T >

Class representing size of a rectangle box in 3D space.

---

Member Typedef Documentation

template<typename T>

typedef CCoordinates3<T> mds::img::CSize3< T >::tBase

tBase class.

Reimplemented from mds::img::CCoordinates3< T >.

template<typename T>

typedef tBase::tComponent mds::img::CSize3< T >::tComponent

Coordinates type.

Reimplemented from mds::img::CCoordinates3< T >.

template<tSize C, tSize M, tSize A>

typedef CLibraryLockableClass<CSmallObjectBase<C,M,A> >::CLock mds::base::CSmallObjectBase< C, M, A >::tLock [inherited]

Lock type.

---

Constructor & Destructor Documentation

template<typename T>

mds::img::CSize3< T >::CSize3

(

)

Default constructor.

template<typename T>

mds::img::CSize3< T >::CSize3

(

const tComponent &

size

)

Constructor initializes the size.

template<typename T>

mds::img::CSize3< T >::CSize3	(	const tComponent &	px,
		const tComponent &	py,
		const tComponent &	pz
	)

Constructor initializes the size.

template<typename T>

mds::img::CSize3< T >::CSize3

(

const tBase &

p

)

Copy constructor.

template<typename T>

mds::img::CSize3< T >::~CSize3

(

)

Destructor.

---

Member Function Documentation

template<typename T>

const tSize& mds::img::CSize3< T >::depth

(

)

const

template<typename T>

tSize& mds::img::CSize3< T >::depth

(

)

template<typename T>

tComponent mds::img::CCoordinates3< T >::getMult

(

)

const [inherited]

Returns multiplication of all coordinates.

template<typename T>

tComponent mds::img::CCoordinates3< T >::getSum

(

)

const [inherited]

Returns sum of all coordinates.

template<typename T>

tComponent& mds::img::CCoordinates3< T >::getX

(

)

[inherited]

Returns reference to the x-coordinate.

template<typename T>

const tComponent& mds::img::CCoordinates3< T >::getX

(

)

const [inherited]

template<typename T>

const tSize& mds::img::CSize3< T >::getXSize

(

)

const

Returns the volume size in x-axis (i.e. width).

template<typename T>

tSize& mds::img::CSize3< T >::getXSize

(

)

template<typename T>

CCoordinates3& mds::img::CCoordinates3< T >::getXY	(	tComponent &	px,
		tComponent &	py
	)		const [inherited]

Returns XY point coordinates.

template<typename T>

CCoordinates3& mds::img::CCoordinates3< T >::getXYZ	(	tComponent &	px,
		tComponent &	py,
		tComponent &	pz
	)		const [inherited]

Returns all point coordinates.

template<typename T>

tComponent& mds::img::CCoordinates3< T >::getY

(

)

[inherited]

Returns reference to the y-coordinate.

template<typename T>

const tComponent& mds::img::CCoordinates3< T >::getY

(

)

const [inherited]

template<typename T>

const tSize& mds::img::CSize3< T >::getYSize

(

)

const

Returns the volume size in y-axis (i.e. height).

template<typename T>

tSize& mds::img::CSize3< T >::getYSize

(

)

template<typename T>

tComponent& mds::img::CCoordinates3< T >::getZ

(

)

[inherited]

Returns reference to the z-coordinate.

template<typename T>

const tComponent& mds::img::CCoordinates3< T >::getZ

(

)

const [inherited]

template<typename T>

const tSize& mds::img::CSize3< T >::getZSize

(

)

const

Returns the volume size in z-axis (i.e. depth).

template<typename T>

tSize& mds::img::CSize3< T >::getZSize

(

)

template<typename T>

const tSize& mds::img::CSize3< T >::height

(

)

const

template<typename T>

tSize& mds::img::CSize3< T >::height

(

)

static void mds::base::CLockableClass< CSmallObjectBase< C, M, A > >::lock

(

)

[static, inherited]

Locks the object.

template<tSize C, tSize M, tSize A>

static void mds::base::CSmallObjectBase< C, M, A >::operator delete	(	void *	p,
		std::size_t	Size
	)		[static, inherited]

Deallocates small object.

template<tSize C, tSize M, tSize A>

static void mds::base::CSmallObjectBase< C, M, A >::operator delete	(	void *	p,
		void *	pPlace
	)		[static, inherited]

Placement single-object delete merely calls global placement delete.

template<tSize C, tSize M, tSize A>

static void mds::base::CSmallObjectBase< C, M, A >::operator delete[]	(	void *	p,
		std::size_t	Size
	)		[static, inherited]

Deallocates array-object.

template<tSize C, tSize M, tSize A>

static void mds::base::CSmallObjectBase< C, M, A >::operator delete[]	(	void *	p,
		void *	pPlace
	)		[static, inherited]

Placement array-object delete merely calls global placement delete.

template<tSize C, tSize M, tSize A>

static void* mds::base::CSmallObjectBase< C, M, A >::operator new

(

std::size_t

Size

)

[static, inherited]

Allocates a small object.

template<tSize C, tSize M, tSize A>

static void* mds::base::CSmallObjectBase< C, M, A >::operator new	(	std::size_t	Size,
		void *	pPlace
	)		[static, inherited]

Placement single-object new merely calls global placement new.

template<tSize C, tSize M, tSize A>

static void* mds::base::CSmallObjectBase< C, M, A >::operator new[]

(

std::size_t

Size

)

[static, inherited]

Allocates array-object.

template<tSize C, tSize M, tSize A>

static void* mds::base::CSmallObjectBase< C, M, A >::operator new[]	(	std::size_t	Size,
		void *	pPlace
	)		[static, inherited]

Placement array-object new merely calls global placement new.

template<typename T>

CSize3& mds::img::CSize3< T >::operator&=

(

const CSize3< T > &

a

)

template<typename T>

CCoordinates3& mds::img::CCoordinates3< T >::operator*=

(

const CCoordinates3< T > &

p

)

[inherited]

template<typename T>

CCoordinates3& mds::img::CCoordinates3< T >::operator*=

(

const tComponent &

c

)

[inherited]

template<typename T>

CCoordinates3& mds::img::CCoordinates3< T >::operator+=

(

const CCoordinates3< T > &

p

)

[inherited]

template<typename T>

CCoordinates3& mds::img::CCoordinates3< T >::operator+=

(

const tComponent &

c

)

[inherited]

template<typename T>

CCoordinates3& mds::img::CCoordinates3< T >::operator-=

(

const CCoordinates3< T > &

p

)

[inherited]

template<typename T>

CCoordinates3& mds::img::CCoordinates3< T >::operator-=

(

const tComponent &

c

)

[inherited]

template<typename T>

CCoordinates3& mds::img::CCoordinates3< T >::operator/=

(

const CCoordinates3< T > &

p

)

[inherited]

template<typename T>

CCoordinates3& mds::img::CCoordinates3< T >::operator/=

(

const tComponent &

c

)

[inherited]

template<typename T>

CSize3& mds::img::CSize3< T >::operator=

(

const tBase &

p

)

Assignment operator.

template<typename T>

CCoordinates3& mds::img::CCoordinates3< T >::setX

(

const tComponent &

px

)

[inherited]

Returns point coordinate.

template<typename T>

CCoordinates3& mds::img::CCoordinates3< T >::setXY	(	const tComponent &	px,
		const tComponent &	py
	)		[inherited]

Sets XY point coordinates.

template<typename T>

CCoordinates3& mds::img::CCoordinates3< T >::setXYZ	(	const tComponent &	px,
		const tComponent &	py,
		const tComponent &	pz
	)		[inherited]

Sets all point coordinates.

template<typename T>

CCoordinates3& mds::img::CCoordinates3< T >::setY

(

const tComponent &

py

)

[inherited]

template<typename T>

CCoordinates3& mds::img::CCoordinates3< T >::setZ

(

const tComponent &

pz

)

[inherited]

static void mds::base::CLockableClass< CSmallObjectBase< C, M, A > >::unlock

(

)

[static, inherited]

Locks the object.

template<typename T>

const tSize& mds::img::CSize3< T >::width

(

)

const

Returns the volume size.

template<typename T>

tSize& mds::img::CSize3< T >::width

(

)

template<typename T>

tComponent& mds::img::CCoordinates3< T >::x

(

)

[inherited]

Returns reference to the x-coordinate.

template<typename T>

const tComponent& mds::img::CCoordinates3< T >::x

(

)

const [inherited]

template<typename T>

tComponent& mds::img::CCoordinates3< T >::y

(

)

[inherited]

Returns reference to the y-coordinate.

template<typename T>

const tComponent& mds::img::CCoordinates3< T >::y

(

)

const [inherited]

template<typename T>

tComponent& mds::img::CCoordinates3< T >::z

(

)

[inherited]

Returns reference to the z-coordinate.

template<typename T>

const tComponent& mds::img::CCoordinates3< T >::z

(

)

const [inherited]

---

Friends And Related Function Documentation

template<typename T>

bool operator!=	(	const CSize3< T > &	a,
		const CSize3< T > &	b
	)		[friend]

template<typename T>

bool operator!=	(	const CCoordinates3< T > &	l,
		const CCoordinates3< T > &	r
	)		[friend, inherited]

template<typename T>

CSize3 operator&	(	const CSize3< T > &	a,
		const CSize3< T > &	b
	)		[friend]

Operator calculates intersection of two given sizes.

template<typename T>

CCoordinates3 operator*	(	const CCoordinates3< T > &	l,
		const CCoordinates3< T > &	r
	)		[friend, inherited]

template<typename T>

CCoordinates3 operator+	(	const CCoordinates3< T > &	l,
		const CCoordinates3< T > &	r
	)		[friend, inherited]

template<typename T>

CCoordinates3 operator-	(	const CCoordinates3< T > &	l,
		const CCoordinates3< T > &	r
	)		[friend, inherited]

template<typename T>

CCoordinates3 operator/	(	const CCoordinates3< T > &	l,
		const CCoordinates3< T > &	r
	)		[friend, inherited]

template<typename T>

bool operator==	(	const CSize3< T > &	a,
		const CSize3< T > &	b
	)		[friend]

Comparison operators.

template<typename T>

bool operator==	(	const CCoordinates3< T > &	l,
		const CCoordinates3< T > &	r
	)		[friend, inherited]

---

Member Data Documentation

template<typename T>

tComponent mds::img::CCoordinates3< T >::m_x [protected, inherited]

Coordinates in the 3D space.

template<typename T>

tComponent mds::img::CCoordinates3< T >::m_y [protected, inherited]

template<typename T>

tComponent mds::img::CCoordinates3< T >::m_z [protected, inherited]

---

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

• mdsSize.h