vec4f.h File Reference

Include dependency graph for vec4f.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	GfVec4f
	Basic type for a vector of 4 float components. More...

Functions
GF_API std::ostream &	operator<< (std::ostream &, GfVec4f const &)
	Output a GfVec4f. More...
GfVec4f	GfCompMult (GfVec4f const &v1, GfVec4f const &v2)
	Returns component-wise multiplication of vectors v1 and v2. More...
GfVec4f	GfCompDiv (GfVec4f const &v1, GfVec4f const &v2)
	Returns component-wise quotient of vectors v1 and v2. More...
float	GfDot (GfVec4f const &v1, GfVec4f const &v2)
	Returns the dot (inner) product of two vectors. More...
float	GfGetLength (GfVec4f const &v)
	Returns the geometric length of v. More...
float	GfNormalize (GfVec4f *v, float eps=GF_MIN_VECTOR_LENGTH)
	Normalizes *v in place to unit length, returning the length before normalization. More...
GfVec4f	GfGetNormalized (GfVec4f const &v, float eps=GF_MIN_VECTOR_LENGTH)
	Returns a normalized (unit-length) vector with the same direction as v. More...
GfVec4f	GfGetProjection (GfVec4f const &a, GfVec4f const &b)
	Returns the projection of a onto b. More...
GfVec4f	GfGetComplement (GfVec4f const &a, GfVec4f const &b)
	Returns the orthogonal complement of a.GetProjection(b). More...
bool	GfIsClose (GfVec4f const &v1, GfVec4f const &v2, double tolerance)
	Tests for equality within a given tolerance, returning true if the length of the difference vector is less than or equal to tolerance. More...

Function Documentation

GfCompDiv()

GfVec4f GfCompDiv ( GfVec4f const &  v1, GfVec4f const &  v2  )

inline

Returns component-wise quotient of vectors v1 and v2.

Definition at line 350 of file vec4f.h.

GfCompMult()

GfVec4f GfCompMult ( GfVec4f const &  v1, GfVec4f const &  v2  )

inline

Returns component-wise multiplication of vectors v1 and v2.

Definition at line 339 of file vec4f.h.

GfDot()

float GfDot ( GfVec4f const &  v1, GfVec4f const &  v2  )

inline

Returns the dot (inner) product of two vectors.

Definition at line 361 of file vec4f.h.

GfGetComplement()

GfVec4f GfGetComplement ( GfVec4f const &  a, GfVec4f const &  b  )

inline

Returns the orthogonal complement of a.GetProjection(b).

That is:

a - a.GetProjection(b)

Definition at line 406 of file vec4f.h.

GfGetLength()

float GfGetLength ( GfVec4f const &  v )

inline

Returns the geometric length of v.

Definition at line 368 of file vec4f.h.

GfGetNormalized()

GfVec4f GfGetNormalized ( GfVec4f const &  v, float  eps = GF_MIN_VECTOR_LENGTH  )

inline

Returns a normalized (unit-length) vector with the same direction as v.

If the length of this vector is smaller than eps, the vector divided by eps is returned.

Definition at line 386 of file vec4f.h.

GfGetProjection()

GfVec4f GfGetProjection ( GfVec4f const &  a, GfVec4f const &  b  )

inline

Returns the projection of a onto b.

That is:

b * (a * b)

Definition at line 396 of file vec4f.h.

GfIsClose()

bool GfIsClose ( GfVec4f const &  v1, GfVec4f const &  v2, double  tolerance  )

inline

Tests for equality within a given tolerance, returning true if the length of the difference vector is less than or equal to tolerance.

Definition at line 414 of file vec4f.h.

GfNormalize()

float GfNormalize ( GfVec4f *  v, float  eps = GF_MIN_VECTOR_LENGTH  )

inline

Normalizes *v in place to unit length, returning the length before normalization.

If the length of *v is smaller than eps then *v is set to *v/eps. The original length of *v is returned.

Definition at line 377 of file vec4f.h.