SO3::SPoint< NUMERIC_TYPE > Class Template Reference

#include <SO3Point.h>

List of all members.

Public Member Functions
	SPoint ()
	SPoint (const NUMERIC_TYPE fX, const NUMERIC_TYPE fY)
	SPoint (const NUMERIC_TYPE scaler)
	SPoint (const NUMERIC_TYPE afCoordinate[2])
	SPoint (NUMERIC_TYPE *const r)
float	operator[] (const size_t i) const
float &	operator[] (const size_t i)
NUMERIC_TYPE *	ptr ()
const NUMERIC_TYPE *	ptr () const
SPoint< NUMERIC_TYPE > &	operator= (const SPoint< NUMERIC_TYPE > &copyPoint)
SPoint< NUMERIC_TYPE > &	operator= (const float fScalar)
bool	operator== (const SPoint< NUMERIC_TYPE > &copyPoint) const
bool	operator!= (const SPoint< NUMERIC_TYPE > &copyPoint) const
SPoint< NUMERIC_TYPE >	operator+ (const SPoint< NUMERIC_TYPE > &copyPoint) const
SPoint< NUMERIC_TYPE >	operator- (const SPoint< NUMERIC_TYPE > &copyPoint) const
SPoint< NUMERIC_TYPE >	operator* (const NUMERIC_TYPE fScalar) const
SPoint< NUMERIC_TYPE >	operator* (const SPoint< NUMERIC_TYPE > &rhs) const
SPoint< NUMERIC_TYPE >	operator/ (const float fScalar) const
SPoint< NUMERIC_TYPE >	operator/ (const SPoint< NUMERIC_TYPE > &rhs) const
const SPoint< NUMERIC_TYPE > &	operator+ () const
SPoint< NUMERIC_TYPE >	operator- () const
SPoint< NUMERIC_TYPE > &	operator+= (const SPoint< NUMERIC_TYPE > &copyPoint)
SPoint< NUMERIC_TYPE > &	operator+= (const NUMERIC_TYPE fScaler)
SPoint< NUMERIC_TYPE > &	operator-= (const SPoint< NUMERIC_TYPE > &copyPoint)
SPoint< NUMERIC_TYPE > &	operator-= (const NUMERIC_TYPE fScaler)
SPoint< NUMERIC_TYPE > &	operator*= (const NUMERIC_TYPE fScalar)
SPoint< NUMERIC_TYPE > &	operator*= (const SPoint< NUMERIC_TYPE > &copyPoint)
SPoint< NUMERIC_TYPE > &	operator/= (const NUMERIC_TYPE fScalar)
SPoint< NUMERIC_TYPE > &	operator/= (const SPoint< NUMERIC_TYPE > &copyPoint)
bool	operator< (const SPoint< NUMERIC_TYPE > &rhs) const
bool	operator> (const SPoint< NUMERIC_TYPE > &rhs) const
Public Attributes
NUMERIC_TYPE	x
NUMERIC_TYPE	y
Static Public Attributes
static const SPoint	ZERO
static const SPoint	UNIT_X
static const SPoint	UNIT_Y
static const SPoint	NEGATIVE_UNIT_X
static const SPoint	NEGATIVE_UNIT_Y
static const SPoint	UNIT_SCALE
Friends
SPoint< NUMERIC_TYPE >	operator* (const NUMERIC_TYPE fScalar, const SPoint< NUMERIC_TYPE > &copyPoint)
SPoint< NUMERIC_TYPE >	operator/ (const NUMERIC_TYPE fScalar, const SPoint< NUMERIC_TYPE > &copyPoint)
SPoint< NUMERIC_TYPE >	operator+ (const SPoint< NUMERIC_TYPE > &lhs, const NUMERIC_TYPE rhs)
SPoint< NUMERIC_TYPE >	operator+ (const NUMERIC_TYPE lhs, const SPoint< NUMERIC_TYPE > &rhs)
SPoint< NUMERIC_TYPE >	operator- (const SPoint< NUMERIC_TYPE > &lhs, const NUMERIC_TYPE rhs)
SPoint< NUMERIC_TYPE >	operator- (const NUMERIC_TYPE lhs, const SPoint< NUMERIC_TYPE > &rhs)

---

Detailed Description

template<typename NUMERIC_TYPE>
class SO3::SPoint< NUMERIC_TYPE >

Point structure (or a 2-dimensional vector).

Definition at line 39 of file SO3Point.h.

---

Constructor & Destructor Documentation

template<typename NUMERIC_TYPE>

SO3::SPoint< NUMERIC_TYPE >::SPoint

(

)

[inline]

template<typename NUMERIC_TYPE>

SO3::SPoint< NUMERIC_TYPE >::SPoint	(	const NUMERIC_TYPE	fX,
		const NUMERIC_TYPE	fY
	)			[inline]

template<typename NUMERIC_TYPE>

SO3::SPoint< NUMERIC_TYPE >::SPoint

(

const NUMERIC_TYPE

scaler

)

[inline, explicit]

template<typename NUMERIC_TYPE>

SO3::SPoint< NUMERIC_TYPE >::SPoint

(

const NUMERIC_TYPE

afCoordinate[2]

)

[inline, explicit]

template<typename NUMERIC_TYPE>

SO3::SPoint< NUMERIC_TYPE >::SPoint

(

NUMERIC_TYPE *const

r

)

[inline, explicit]

---

Member Function Documentation

template<typename NUMERIC_TYPE>

bool SO3::SPoint< NUMERIC_TYPE >::operator!=

(

const SPoint< NUMERIC_TYPE > &

copyPoint

)

const [inline]

Definition at line 129 of file SO3Point.h.

template<typename NUMERIC_TYPE>

SPoint<NUMERIC_TYPE> SO3::SPoint< NUMERIC_TYPE >::operator*

(

const SPoint< NUMERIC_TYPE > &

rhs

)

const [inline]

Definition at line 149 of file SO3Point.h.

template<typename NUMERIC_TYPE>

SPoint<NUMERIC_TYPE> SO3::SPoint< NUMERIC_TYPE >::operator*

(

const NUMERIC_TYPE

fScalar

)

const [inline]

Definition at line 144 of file SO3Point.h.

template<typename NUMERIC_TYPE>

SPoint<NUMERIC_TYPE>& SO3::SPoint< NUMERIC_TYPE >::operator*=

(

const SPoint< NUMERIC_TYPE > &

copyPoint

)

[inline]

Definition at line 241 of file SO3Point.h.

template<typename NUMERIC_TYPE>

SPoint<NUMERIC_TYPE>& SO3::SPoint< NUMERIC_TYPE >::operator*=

(

const NUMERIC_TYPE

fScalar

)

[inline]

Definition at line 234 of file SO3Point.h.

template<typename NUMERIC_TYPE>

const SPoint<NUMERIC_TYPE>& SO3::SPoint< NUMERIC_TYPE >::operator+

(

)

const [inline]

Definition at line 166 of file SO3Point.h.

template<typename NUMERIC_TYPE>

SPoint<NUMERIC_TYPE> SO3::SPoint< NUMERIC_TYPE >::operator+

(

const SPoint< NUMERIC_TYPE > &

copyPoint

)

const [inline]

Definition at line 134 of file SO3Point.h.

template<typename NUMERIC_TYPE>

SPoint<NUMERIC_TYPE>& SO3::SPoint< NUMERIC_TYPE >::operator+=

(

const NUMERIC_TYPE

fScaler

)

[inline]

Definition at line 213 of file SO3Point.h.

template<typename NUMERIC_TYPE>

SPoint<NUMERIC_TYPE>& SO3::SPoint< NUMERIC_TYPE >::operator+=

(

const SPoint< NUMERIC_TYPE > &

copyPoint

)

[inline]

Definition at line 206 of file SO3Point.h.

template<typename NUMERIC_TYPE>

SPoint<NUMERIC_TYPE> SO3::SPoint< NUMERIC_TYPE >::operator-

(

)

const [inline]

Definition at line 171 of file SO3Point.h.

template<typename NUMERIC_TYPE>

SPoint<NUMERIC_TYPE> SO3::SPoint< NUMERIC_TYPE >::operator-

(

const SPoint< NUMERIC_TYPE > &

copyPoint

)

const [inline]

Definition at line 139 of file SO3Point.h.

template<typename NUMERIC_TYPE>

SPoint<NUMERIC_TYPE>& SO3::SPoint< NUMERIC_TYPE >::operator-=

(

const NUMERIC_TYPE

fScaler

)

[inline]

Definition at line 227 of file SO3Point.h.

template<typename NUMERIC_TYPE>

SPoint<NUMERIC_TYPE>& SO3::SPoint< NUMERIC_TYPE >::operator-=

(

const SPoint< NUMERIC_TYPE > &

copyPoint

)

[inline]

Definition at line 220 of file SO3Point.h.

template<typename NUMERIC_TYPE>

SPoint<NUMERIC_TYPE> SO3::SPoint< NUMERIC_TYPE >::operator/

(

const SPoint< NUMERIC_TYPE > &

rhs

)

const [inline]

Definition at line 161 of file SO3Point.h.

template<typename NUMERIC_TYPE>

SPoint<NUMERIC_TYPE> SO3::SPoint< NUMERIC_TYPE >::operator/

(

const float

fScalar

)

const [inline]

Definition at line 154 of file SO3Point.h.

template<typename NUMERIC_TYPE>

SPoint<NUMERIC_TYPE>& SO3::SPoint< NUMERIC_TYPE >::operator/=

(

const SPoint< NUMERIC_TYPE > &

copyPoint

)

[inline]

Definition at line 257 of file SO3Point.h.

template<typename NUMERIC_TYPE>

SPoint<NUMERIC_TYPE>& SO3::SPoint< NUMERIC_TYPE >::operator/=

(

const NUMERIC_TYPE

fScalar

)

[inline]

Definition at line 248 of file SO3Point.h.

template<typename NUMERIC_TYPE>

bool SO3::SPoint< NUMERIC_TYPE >::operator<

(

const SPoint< NUMERIC_TYPE > &

rhs

)

const [inline]

Returns true if the point's scalar components are all greater that the ones of the point it is compared against.

Definition at line 267 of file SO3Point.h.

template<typename NUMERIC_TYPE>

SPoint<NUMERIC_TYPE>& SO3::SPoint< NUMERIC_TYPE >::operator=

(

const float

fScalar

)

[inline]

Definition at line 117 of file SO3Point.h.

template<typename NUMERIC_TYPE>

SPoint<NUMERIC_TYPE>& SO3::SPoint< NUMERIC_TYPE >::operator=

(

const SPoint< NUMERIC_TYPE > &

copyPoint

)

[inline]

Assigns the value of the other point.

Parameters:

copyPoint

The other point

Definition at line 110 of file SO3Point.h.

template<typename NUMERIC_TYPE>

bool SO3::SPoint< NUMERIC_TYPE >::operator==

(

const SPoint< NUMERIC_TYPE > &

copyPoint

)

const [inline]

Definition at line 124 of file SO3Point.h.

template<typename NUMERIC_TYPE>

bool SO3::SPoint< NUMERIC_TYPE >::operator>

(

const SPoint< NUMERIC_TYPE > &

rhs

)

const [inline]

Returns true if the point's scalar components are all smaller that the ones of the point it is compared against.

Definition at line 278 of file SO3Point.h.

template<typename NUMERIC_TYPE>

float& SO3::SPoint< NUMERIC_TYPE >::operator[]

(

const size_t

i

)

[inline]

Definition at line 84 of file SO3Point.h.

template<typename NUMERIC_TYPE>

float SO3::SPoint< NUMERIC_TYPE >::operator[]

(

const size_t

i

)

const [inline]

Definition at line 78 of file SO3Point.h.

template<typename NUMERIC_TYPE>

const NUMERIC_TYPE* SO3::SPoint< NUMERIC_TYPE >::ptr

(

)

const [inline]

Pointer accessor for direct copying

Definition at line 101 of file SO3Point.h.

template<typename NUMERIC_TYPE>

NUMERIC_TYPE* SO3::SPoint< NUMERIC_TYPE >::ptr

(

)

[inline]

Pointer accessor for direct copying

Definition at line 93 of file SO3Point.h.

---

Friends And Related Function Documentation

template<typename NUMERIC_TYPE>

SPoint<NUMERIC_TYPE> operator*	(	const NUMERIC_TYPE	fScalar,
		const SPoint< NUMERIC_TYPE > &	copyPoint
	)			[friend]

Definition at line 176 of file SO3Point.h.

template<typename NUMERIC_TYPE>

SPoint<NUMERIC_TYPE> operator+	(	const NUMERIC_TYPE	lhs,
		const SPoint< NUMERIC_TYPE > &	rhs
	)			[friend]

Definition at line 191 of file SO3Point.h.

template<typename NUMERIC_TYPE>

SPoint<NUMERIC_TYPE> operator+	(	const SPoint< NUMERIC_TYPE > &	lhs,
		const NUMERIC_TYPE	rhs
	)			[friend]

Definition at line 186 of file SO3Point.h.

template<typename NUMERIC_TYPE>

SPoint<NUMERIC_TYPE> operator-	(	const NUMERIC_TYPE	lhs,
		const SPoint< NUMERIC_TYPE > &	rhs
	)			[friend]

Definition at line 201 of file SO3Point.h.

template<typename NUMERIC_TYPE>

SPoint<NUMERIC_TYPE> operator-	(	const SPoint< NUMERIC_TYPE > &	lhs,
		const NUMERIC_TYPE	rhs
	)			[friend]

Definition at line 196 of file SO3Point.h.

template<typename NUMERIC_TYPE>

SPoint<NUMERIC_TYPE> operator/	(	const NUMERIC_TYPE	fScalar,
		const SPoint< NUMERIC_TYPE > &	copyPoint
	)			[friend]

Definition at line 181 of file SO3Point.h.

---

Member Data Documentation

template<typename NUMERIC_TYPE>

const SPoint< double > SO3::SPoint< NUMERIC_TYPE >::NEGATIVE_UNIT_X [static]

Definition at line 49 of file SO3Point.h.

template<typename NUMERIC_TYPE>

const SPoint< double > SO3::SPoint< NUMERIC_TYPE >::NEGATIVE_UNIT_Y [static]

Definition at line 50 of file SO3Point.h.

template<typename NUMERIC_TYPE>

const SPoint< double > SO3::SPoint< NUMERIC_TYPE >::UNIT_SCALE [static]

Definition at line 51 of file SO3Point.h.

template<typename NUMERIC_TYPE>

const SPoint< double > SO3::SPoint< NUMERIC_TYPE >::UNIT_X [static]

Definition at line 47 of file SO3Point.h.

template<typename NUMERIC_TYPE>

const SPoint< double > SO3::SPoint< NUMERIC_TYPE >::UNIT_Y [static]

Definition at line 48 of file SO3Point.h.

template<typename NUMERIC_TYPE>

NUMERIC_TYPE SO3::SPoint< NUMERIC_TYPE >::x

Definition at line 42 of file SO3Point.h.

template<typename NUMERIC_TYPE>

NUMERIC_TYPE SO3::SPoint< NUMERIC_TYPE >::y

Definition at line 43 of file SO3Point.h.

template<typename NUMERIC_TYPE>

const SPoint< double > SO3::SPoint< NUMERIC_TYPE >::ZERO [static]

Definition at line 46 of file SO3Point.h.

---

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

• SO3Engine/SO3Utils/SO3Point.h
• SO3Engine/SO3Utils/SO3Point.cpp