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

Class representing a vector in 2D space. More...

#include <mdsVector3.h>

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

List of all members.

Public Types
typedef CCoordinates2< T >	tBase
	Base class.
typedef tBase::tComponent	tComponent
	Coordinates type.
typedef CLibraryLockableClass < CSmallObjectBase< C, M, A > >::CLock	tLock
	Lock type.
typedef CPoint2< T >	tPoint
	Corresponding point.
Public Member Functions
void	create (const tPoint &p0, const tPoint &p1)
	Creates the vector from two given points.
	CVector2 ()
	Default constructor.
	CVector2 (const tComponent &px, const tComponent &py)
	Constructor initializes vector coordinates.
	CVector2 (const tPoint &p0, const tPoint &p1)
	Constructor creates vector from two given points.
	CVector2 (const tBase &p)
	Copy constructor.
tComponent	getLength () const
	Returns the vector length.
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
CCoordinates2 &	getXY (tComponent &px, tComponent &py) const
	Returns XY coordinates.
tComponent &	getY ()
	Returns reference to the y-coordinate.
const tComponent &	getY () const
bool	isSimilarTo (const CVector2 &r)
	Returns true if two vectors are almost the same.
CVector2 &	normalize ()
	Normalizes the vector coordinates.
CCoordinates2 &	operator*= (const CCoordinates2 &p)
CCoordinates2 &	operator*= (const tComponent &c)
CCoordinates2 &	operator+= (const CCoordinates2 &p)
CCoordinates2 &	operator+= (const tComponent &c)
CCoordinates2 &	operator-= (const CCoordinates2 &p)
CCoordinates2 &	operator-= (const tComponent &c)
CCoordinates2 &	operator/= (const CCoordinates2 &p)
CCoordinates2 &	operator/= (const tComponent &c)
CVector2 &	operator= (const tBase &p)
	Assignment operator.
CCoordinates2 &	setX (const tComponent &px)
	Changes coordinates.
CCoordinates2 &	setXY (const tComponent &px, const tComponent &py)
	Sets XY point coordinates.
CCoordinates2 &	setY (const tComponent &py)
tComponent &	x ()
	Returns reference to the x-coordinate.
const tComponent &	x () const
tComponent &	y ()
	Returns reference to the y-coordinate.
const tComponent &	y () const
	~CVector2 ()
	Destructor.
Static Public Member Functions
static tComponent	dotProduct (const CVector2 &u, const CVector2 &v)
	Dot product of two vectors.
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 2D space.
tComponent	m_y
Friends
bool	operator!= (const CCoordinates2 &l, const CCoordinates2 &r)
CCoordinates2	operator* (const CCoordinates2 &l, const CCoordinates2 &r)
CCoordinates2	operator+ (const CCoordinates2 &l, const CCoordinates2 &r)
CCoordinates2	operator- (const CCoordinates2 &l, const CCoordinates2 &r)
CCoordinates2	operator/ (const CCoordinates2 &l, const CCoordinates2 &r)
bool	operator== (const CCoordinates2 &l, const CCoordinates2 &r)

---

Detailed Description

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

Class representing a vector in 2D space.

---

Member Typedef Documentation

template<typename T >

typedef CCoordinates2<T> mds::img::CVector2< T >::tBase

Base class.

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

template<typename T >

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

Coordinates type.

Reimplemented from mds::img::CCoordinates2< 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.

template<typename T >

typedef CPoint2<T> mds::img::CVector2< T >::tPoint

Corresponding point.

---

Constructor & Destructor Documentation

template<typename T >

mds::img::CVector2< T >::CVector2

(

)

Default constructor.

template<typename T >

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

Constructor initializes vector coordinates.

template<typename T >

mds::img::CVector2< T >::CVector2	(	const tPoint &	p0,
		const tPoint &	p1
	)

Constructor creates vector from two given points.

template<typename T >

mds::img::CVector2< T >::CVector2

(

const tBase &

p

)

Copy constructor.

template<typename T >

mds::img::CVector2< T >::~CVector2

(

)

Destructor.

---

Member Function Documentation

template<typename T >

void mds::img::CVector2< T >::create	(	const tPoint &	p0,
		const tPoint &	p1
	)

Creates the vector from two given points.

template<typename T >

static tComponent mds::img::CVector2< T >::dotProduct	(	const CVector2< T > &	u,
		const CVector2< T > &	v
	)		[static]

Dot product of two vectors.

template<typename T >

tComponent mds::img::CVector2< T >::getLength

(

)

const

Returns the vector length.

template<typename T>

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

(

)

const [inherited]

Returns multiplication of all coordinates.

template<typename T>

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

(

)

const [inherited]

Returns sum of all coordinates.

template<typename T>

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

(

)

[inherited]

Returns reference to the x-coordinate.

template<typename T>

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

(

)

const [inherited]

template<typename T>

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

Returns XY coordinates.

template<typename T>

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

(

)

[inherited]

Returns reference to the y-coordinate.

template<typename T>

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

(

)

const [inherited]

template<typename T >

bool mds::img::CVector2< T >::isSimilarTo

(

const CVector2< T > &

r

)

Returns true if two vectors are almost the same.

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

(

)

[static, inherited]

Locks the object.

template<typename T >

CVector2& mds::img::CVector2< T >::normalize

(

)

Normalizes the vector coordinates.

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>

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

(

const CCoordinates2< T > &

p

)

[inherited]

template<typename T>

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

(

const tComponent &

c

)

[inherited]

template<typename T>

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

(

const CCoordinates2< T > &

p

)

[inherited]

template<typename T>

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

(

const tComponent &

c

)

[inherited]

template<typename T>

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

(

const CCoordinates2< T > &

p

)

[inherited]

template<typename T>

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

(

const tComponent &

c

)

[inherited]

template<typename T>

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

(

const CCoordinates2< T > &

p

)

[inherited]

template<typename T>

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

(

const tComponent &

c

)

[inherited]

template<typename T >

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

(

const tBase &

p

)

Assignment operator.

template<typename T>

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

(

const tComponent &

px

)

[inherited]

Changes coordinates.

template<typename T>

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

Sets XY point coordinates.

template<typename T>

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

(

const tComponent &

py

)

[inherited]

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

(

)

[static, inherited]

Locks the object.

template<typename T>

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

(

)

[inherited]

Returns reference to the x-coordinate.

template<typename T>

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

(

)

const [inherited]

template<typename T>

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

(

)

[inherited]

Returns reference to the y-coordinate.

template<typename T>

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

(

)

const [inherited]

---

Friends And Related Function Documentation

template<typename T>

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

template<typename T>

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

template<typename T>

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

template<typename T>

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

template<typename T>

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

template<typename T>

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

---

Member Data Documentation

template<typename T>

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

Coordinates in 2D space.

template<typename T>

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

---

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

• mdsVector3.h