PLMath::Vector3i Class Reference

3D integer vector More...

#include <Vector3i.h>

List of all members.

Public Member Functions
	Vector3i ()
	Default constructor setting all components to 0.
	Vector3i (int nX, int nY, int nZ)
	Constructor.
PLMATH_API	Vector3i (const Vector2i &vVector, int nZ)
	Constructor.
	~Vector3i ()
	Destructor.
	operator int * ()
	operator const int * () const
int &	operator[] (int nIndex)
const int &	operator[] (int nIndex) const
void	Set (int nX, int nY, int nZ)
	Set vector.
void	SetX (int nX)
	Set X component.
void	SetY (int nY)
	Set Y component.
PLMATH_API void	SetXYZ (const Vector2i &vXY, int nZ=0)
	Set X, Y and Z component.
void	SetZ (int nZ)
	Set Z component.
Vector3i &	operator= (const Vector3i &vV)
	Assignment operator.
bool	operator== (const Vector3i &vV) const
	Compare operator.
bool	operator!= (const Vector3i &vV) const
	Compare operator.
bool	operator< (const Vector3i &vV) const
	Compares two vectors lexicographically.
bool	operator> (const Vector3i &vV) const
	Compares two vectors lexicographically.
bool	operator<= (const Vector3i &vV) const
	Compares two vectors lexicographically.
bool	operator>= (const Vector3i &vV) const
	Compares two vectors lexicographically.
Vector3i	operator+ (const Vector3i &vV) const
	Addition operator.
Vector3i &	operator+= (const Vector3i &vV)
	Addition operator.
Vector3i	operator- (const Vector3i &vV) const
	Subtraction operator.
Vector3i &	operator-= (const Vector3i &vV)
	Subtraction operator.
Vector3i	operator* (float fFactor) const
	Multiplication operator.
Vector3i &	operator*= (float fFactor)
	Multiplication operator.
Vector3i	operator/ (float fFactor) const
	Division operator.
Vector3i &	operator/= (float fFactor)
	Division operator.
PLMATH_API PLCore::String	ToString () const
	To string.
PLMATH_API bool	FromString (const PLCore::String &sString)
	From string.
Public Attributes
union {
int   nV [3]
	Vector element array access.
struct {
int   x
int   y
int   z
}
	Known vector element names when dealing with positions or directions.
struct {
int   width
int   height
int   depth
}
	Known vector element names when dealing with sizes.
};
	Some direct vector element accesses.
Static Public Attributes
static PLMATH_API const Vector3i	Zero
static PLMATH_API const Vector3i	One
static PLMATH_API const Vector3i	NegativeOne
static PLMATH_API const Vector3i	UnitX
static PLMATH_API const Vector3i	UnitY
static PLMATH_API const Vector3i	UnitZ
static PLMATH_API const Vector3i	NegativeUnitX
static PLMATH_API const Vector3i	NegativeUnitY
static PLMATH_API const Vector3i	NegativeUnitZ

---

Detailed Description

3D integer vector

---

Constructor & Destructor Documentation

PLMath::Vector3i::Vector3i

(

)

[inline]

Default constructor setting all components to 0.

PLMath::Vector3i::Vector3i	(	int	nX,
		int	nY,
		int	nZ
	)		[inline]

Constructor.

Parameters:

[in]	nX	X component
[in]	nY	Y component
[in]	nZ	Z component

PLMATH_API PLMath::Vector3i::Vector3i	(	const Vector2i &	vVector,
		int	nZ
	)

Constructor.

Parameters:

[in]	vVector	2D vector to copy the x and y values from
[in]	nZ	Z component

PLMath::Vector3i::~Vector3i

(

)

[inline]

Destructor.

---

Member Function Documentation

PLMath::Vector3i::operator int *

(

)

[inline]

PLMath::Vector3i::operator const int *

(

)

const [inline]

int & PLMath::Vector3i::operator[]

(

int

nIndex

)

[inline]

const int & PLMath::Vector3i::operator[]

(

int

nIndex

)

const [inline]

void PLMath::Vector3i::Set	(	int	nX,
		int	nY,
		int	nZ
	)		[inline]

Set vector.

Set X, Y and Z value.

Parameters:

[in]	nX	X component
[in]	nY	Y component
[in]	nZ	Z component

void PLMath::Vector3i::SetX

(

int

nX

)

[inline]

Set X component.

Set x.

Parameters:

[in]

nX

X component

void PLMath::Vector3i::SetY

(

int

nY

)

[inline]

Set Y component.

Set y.

Parameters:

[in]

nY

Y component

PLMATH_API void PLMath::Vector3i::SetXYZ	(	const Vector2i &	vXY,
		int	nZ = 0
	)

Set X, Y and Z component.

Parameters:

[in]	vXY	Vector2 instance to take the X and Y components from
[in]	nZ	Z component value

void PLMath::Vector3i::SetZ

(

int

nZ

)

[inline]

Set Z component.

Set z.

Parameters:

[in]

nZ

Z component

Vector3i & PLMath::Vector3i::operator=

(

const Vector3i &

vV

)

[inline]

Assignment operator.

Parameters:

[in]

vV

Source vector to copy

Returns:

This vector

bool PLMath::Vector3i::operator==

(

const Vector3i &

vV

)

const [inline]

Compare operator.

Parameters:

[in]

vV

Vector to compare with

Returns:

'true' if equal, else 'false'

bool PLMath::Vector3i::operator!=

(

const Vector3i &

vV

)

const [inline]

Compare operator.

Parameters:

[in]

vV

Vector to compare with

Returns:

'true' if not equal, else 'false'

bool PLMath::Vector3i::operator<

(

const Vector3i &

vV

)

const [inline]

Compares two vectors lexicographically.

Parameters:

[in]

vV

Vector to compare with

Returns:

'true' if ALL components of this vector are less, else 'false'

Note:

• A lexicographical order for 3-dimensional vectors is used (see http://en.wikipedia.org/wiki/Ordered_vector_space)

bool PLMath::Vector3i::operator>

(

const Vector3i &

vV

)

const [inline]

Compares two vectors lexicographically.

Parameters:

[in]

vV

Vector to compare with

Returns:

'true' if ALL components of this vector are greater, else 'false'

See also:

• "operator <"

bool PLMath::Vector3i::operator<=

(

const Vector3i &

vV

)

const [inline]

Compares two vectors lexicographically.

Parameters:

[in]

vV

Vector to compare with

Returns:

'true' if ALL components of this vector are less or equal, else 'false'

See also:

• "operator <"

bool PLMath::Vector3i::operator>=

(

const Vector3i &

vV

)

const [inline]

Compares two vectors lexicographically.

Parameters:

[in]

vV

Vector to compare with

Returns:

'true' if ALL components of this vector are greater or equal, else 'false'

See also:

• "operator <"

Vector3i PLMath::Vector3i::operator+

(

const Vector3i &

vV

)

const [inline]

Addition operator.

Parameters:

[in]

vV

Vector to add

Returns:

The resulting vector

Vector3i & PLMath::Vector3i::operator+=

(

const Vector3i &

vV

)

[inline]

Addition operator.

Parameters:

[in]

vV

Vector to add

Returns:

This vector

Vector3i PLMath::Vector3i::operator-

(

const Vector3i &

vV

)

const [inline]

Subtraction operator.

Parameters:

[in]

vV

Vector to subtract

Returns:

The resulting vector

Vector3i & PLMath::Vector3i::operator-=

(

const Vector3i &

vV

)

[inline]

Subtraction operator.

Parameters:

[in]

vV

Vector to subtract

Returns:

This vector

Vector3i PLMath::Vector3i::operator*

(

float

fFactor

)

const [inline]

Multiplication operator.

Parameters:

[in]

fFactor

Floating point factor

Returns:

The resulting vector

Vector3i & PLMath::Vector3i::operator*=

(

float

fFactor

)

[inline]

Multiplication operator.

Parameters:

[in]

fFactor

Floating point factor

Returns:

This vector

Vector3i PLMath::Vector3i::operator/

(

float

fFactor

)

const [inline]

Division operator.

Parameters:

[in]

fFactor

Floating point divisor

Returns:

The resulting vector

Vector3i & PLMath::Vector3i::operator/=

(

float

fFactor

)

[inline]

Division operator.

Parameters:

[in]

fFactor

Floating point divisor

Returns:

This vector

PLMATH_API PLCore::String PLMath::Vector3i::ToString

(

)

const

To string.

Returns:

String with the data

PLMATH_API bool PLMath::Vector3i::FromString

(

const PLCore::String &

sString

)

From string.

Parameters:

[in]

sString

String with the data

---

Member Data Documentation

PLMATH_API const Vector3i PLMath::Vector3i::Zero [static]

0, 0, 0

PLMATH_API const Vector3i PLMath::Vector3i::One [static]

1, 1, 1

PLMATH_API const Vector3i PLMath::Vector3i::NegativeOne [static]

-1, -1, -1

PLMATH_API const Vector3i PLMath::Vector3i::UnitX [static]

1, 0, 0

PLMATH_API const Vector3i PLMath::Vector3i::UnitY [static]

0, 1, 0

PLMATH_API const Vector3i PLMath::Vector3i::UnitZ [static]

0, 0, 1

PLMATH_API const Vector3i PLMath::Vector3i::NegativeUnitX [static]

-1, 0, 0

PLMATH_API const Vector3i PLMath::Vector3i::NegativeUnitY [static]

0, -1, 0

PLMATH_API const Vector3i PLMath::Vector3i::NegativeUnitZ [static]

0, 0, -1

int PLMath::Vector3i::nV[3]

Vector element array access.

int PLMath::Vector3i::x

int PLMath::Vector3i::y

int PLMath::Vector3i::z

int PLMath::Vector3i::width

int PLMath::Vector3i::height

int PLMath::Vector3i::depth

union { ... }

Some direct vector element accesses.

---

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

• Vector3i.h
• Vector3i.inl