KS::ksVector3 Class Reference

Public Member Functions
	ksVector3 ()
	ksVector3 (const ksVector3 &v)
	ksVector3 (Scalar x, Scalar y, Scalar z)
	~ksVector3 ()
Scalar &	x ()
Scalar &	y ()
Scalar &	z ()
const Scalar &	x () const
const Scalar &	y () const
const Scalar &	z () const
ksVector3	operator* (const Scalar &c) const
ksVector3	operator/ (const Scalar &c) const
ksVector3	operator+ (const ksVector3 &v) const
ksVector3	operator- (const ksVector3 &v) const
ksVector3	operator- () const
ksVector3 &	operator*= (const Scalar &c)
ksVector3 &	operator/= (const Scalar &c)
ksVector3 &	operator+= (const ksVector3 &v)
ksVector3 &	operator-= (const ksVector3 &v)
bool	operator== (const ksVector3 &v)
bool	operator!= (const ksVector3 &v)
Scalar &	operator[] (const int &i)
float	MagnitudeSquared ()
float	Magnitude ()
void	Normalize ()
bool	IsZero (Scalar tolerance=0.000001f) const
std::string	ToString ()

Static Public Member Functions
static Scalar	Distance (const ksVector3 &v1, const ksVector3 &v2)
static Scalar	DistanceSquared (const ksVector3 &v1, const ksVector3 &v2)
static Scalar	Dot (const ksVector3 &v1, const ksVector3 &v2)
static ksVector3	Cross (const ksVector3 &v1, const ksVector3 &v2)

Constructor & Destructor Documentation

ksVector3() [1/3]

KS::ksVector3::ksVector3 ( )

inline

Default constructor.

ksVector3() [2/3]

KS::ksVector3::ksVector3 ( const ksVector3 &  v )

inline

Copy constructor.

ksVector3() [3/3]

KS::ksVector3::ksVector3 ( Scalar  x, Scalar  y, Scalar  z  )

inline

Initialized constructor.

~ksVector3()

KS::ksVector3::~ksVector3 ( )

inline

Destructor

Member Function Documentation

Cross()

static ksVector3 KS::ksVector3::Cross ( const ksVector3 &  v1, const ksVector3 &  v2  )

inlinestatic

Cross Product of two vectors.

Parameters

const	ksVector3& vector 1
const	ksVector3& vector 2

Returns

ksVector3

Distance()

static Scalar KS::ksVector3::Distance ( const ksVector3 &  v1, const ksVector3 &  v2  )

inlinestatic

Distance between two vectors.

Parameters

const	ksVector3& vector 1
const	ksVector3& vector 2

Returns

Scalar

DistanceSquared()

static Scalar KS::ksVector3::DistanceSquared ( const ksVector3 &  v1, const ksVector3 &  v2  )

inlinestatic

Distance between two vectors.

Parameters

const	ksVector3& vector 1
const	ksVector3& vector 2

Returns

Scalar

Dot()

static Scalar KS::ksVector3::Dot ( const ksVector3 &  v1, const ksVector3 &  v2  )

inlinestatic

Dot product of two vectors.

Parameters

const	ksVector3& vector 1
const	ksVector3& vector 2

Returns

Scalar

IsZero()

bool KS::ksVector3::IsZero ( Scalar  tolerance = 0.000001f ) const

inline

Return true if the vector length squared is less than the tolerance

Returns

Scalar tolerance (Defaults)

bool

Magnitude()

float KS::ksVector3::Magnitude ( )

inline

Returns

float magnitude.

MagnitudeSquared()

float KS::ksVector3::MagnitudeSquared ( )

inline

Returns

float magnitude squared.

Normalize()

void KS::ksVector3::Normalize ( )

inline

Normalize this vector.

operator!=()

bool KS::ksVector3::operator!= ( const ksVector3 &  v )

inline

Not equivalence.

Parameters

const

ksVector3& v

Returns

bool

operator*()

ksVector3 KS::ksVector3::operator* ( const Scalar &  c ) const

inline

Vector scaling.

Parameters

const

Scalar& scaling constant

Returns

ksVector3

operator*=()

ksVector3& KS::ksVector3::operator*= ( const Scalar &  c )

inline

Vector scaling.

Parameters

const

ksVector3& v

Returns

ksVector3&

operator+()

ksVector3 KS::ksVector3::operator+ ( const ksVector3 &  v ) const

inline

Vector translation.

Parameters

const

ksVector3& v

Returns

ksVector3

operator+=()

ksVector3& KS::ksVector3::operator+= ( const ksVector3 &  v )

inline

Vector translation.

Parameters

const

ksVector3& v

Returns

ksVector3&

operator-() [1/2]

ksVector3 KS::ksVector3::operator- ( ) const

inline

Unary minus.

Returns

ksVector3

operator-() [2/2]

ksVector3 KS::ksVector3::operator- ( const ksVector3 &  v ) const

inline

Vector translation.

Parameters

const

ksVector3& v

Returns

ksVector3

operator-=()

ksVector3& KS::ksVector3::operator-= ( const ksVector3 &  v )

inline

Vector translation.

Parameters

const

ksVector3& v

Returns

ksVector3&

operator/()

ksVector3 KS::ksVector3::operator/ ( const Scalar &  c ) const

inline

Vector scaling.

Parameters

const

Scalar& scaling constant

Returns

ksVector3

operator/=()

ksVector3& KS::ksVector3::operator/= ( const Scalar &  c )

inline

Vector scaling.

Parameters

const

ksVector3& v

Returns

ksVector3&

operator==()

bool KS::ksVector3::operator== ( const ksVector3 &  v )

inline

Equivalence.

Parameters

const

ksVector3& v

Returns

bool

operator[]()

Scalar& KS::ksVector3::operator[] ( const int &  i )

inline

Array reference

Parameters

const

int& i

Returns

Scalar&

ToString()

std::string KS::ksVector3::ToString ( )

inline

String

Returns

std::string

---

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

• ksVector3.h