UnitVec Class Template Reference

#include <UnitVec.h>

Inheritance diagram for UnitVec:

List of all members.

---

Detailed Description

template<int S>
class SimTK::UnitVec< S >

This class is a Vec3 plus an ironclad guarantee either that:

• the length is one (to within a very small tolerance), or
• all components are NaN.

Public Types
typedef Vec< 3, Real, S >	BaseVec
typedef UnitRow< S >	TransposeType
Public Member Functions
	UnitVec ()
	UnitVec (const UnitVec &u)
template<int S2>
	UnitVec (const UnitVec< S2 > &u)
	UnitVec (const BaseVec &v)
template<int S2>
	UnitVec (const Vec< 3, Real, S2 > &v)
	UnitVec (const Real &x, const Real &y, const Real &z)
	UnitVec (int axis)
UnitVec &	operator= (const UnitVec &u)
template<int S2>
UnitVec &	operator= (const UnitVec< S2 > &u)
const BaseVec &	asVec3 () const
UnitVec< 1 >	negate () const
UnitVec< 1 >	operator- () const
const TransposeType &	operator~ () const
TransposeType &	operator~ ()
const Real &	operator[] (int i) const
const Real &	operator() (int i) const
UnitVec< 1 >	abs () const
UnitVec< 1 >	perp () const
	UnitVec (const BaseVec &v, bool)
template<int S2>
	UnitVec (const Vec< 3, Real, S2 > &v, bool)

---

Member Typedef Documentation

typedef Vec<3,Real,S> BaseVec

typedef UnitRow<S> TransposeType

---

Constructor & Destructor Documentation

UnitVec

(

)

[inline]

UnitVec

(

const UnitVec< S > &

u

)

[inline]

UnitVec

(

const UnitVec< S2 > &

u

)

[inline]

UnitVec

(

const BaseVec &

v

)

[inline, explicit]

UnitVec

(

const Vec< 3, Real, S2 > &

v

)

[inline, explicit]

UnitVec	(	const Real &	x,
		const Real &	y,
		const Real &	z
	)			[inline]

UnitVec

(

int

axis

)

[inline, explicit]

UnitVec	(	const BaseVec &	v,
		bool
	)			[inline]

UnitVec	(	const Vec< 3, Real, S2 > &	v,
		bool
	)			[inline]

---

Member Function Documentation

UnitVec<1> abs

(

)

const [inline]

Reimplemented from Vec< 3, Real, S >.

const BaseVec& asVec3

(

)

const [inline]

UnitVec<1> negate

(

)

const [inline]

Reimplemented from Vec< 3, Real, S >.

const Real& operator()

(

int

i

)

const [inline]

Reimplemented from Vec< 3, Real, S >.

UnitVec<1> operator-

(

)

const [inline]

Reimplemented from Vec< 3, Real, S >.

UnitVec& operator=

(

const UnitVec< S2 > &

u

)

[inline]

UnitVec& operator=

(

const UnitVec< S > &

u

)

[inline]

const Real& operator[]

(

int

i

)

const [inline]

Reimplemented from Vec< 3, Real, S >.

TransposeType& operator~

(

)

[inline]

Reimplemented from Vec< 3, Real, S >.

const TransposeType& operator~

(

)

const [inline]

Reimplemented from Vec< 3, Real, S >.

UnitVec< 1 > perp

(

)

const [inline]

---

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

• UnitVec.h

---