vec4h.h File Reference
+ Include dependency graph for vec4h.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  GfVec4h
 Basic type for a vector of 4 GfHalf components. More...
 

Functions

GF_API std::ostream & operator<< (std::ostream &, GfVec4h const &)
 Output a GfVec4h. More...
 
GfVec4h GfCompMult (GfVec4h const &v1, GfVec4h const &v2)
 Returns component-wise multiplication of vectors v1 and v2. More...
 
GfVec4h GfCompDiv (GfVec4h const &v1, GfVec4h const &v2)
 Returns component-wise quotient of vectors v1 and v2. More...
 
GfHalf GfDot (GfVec4h const &v1, GfVec4h const &v2)
 Returns the dot (inner) product of two vectors. More...
 
GfHalf GfGetLength (GfVec4h const &v)
 Returns the geometric length of v. More...
 
GfHalf GfNormalize (GfVec4h *v, GfHalf eps=0.001)
 Normalizes *v in place to unit length, returning the length before normalization. More...
 
GfVec4h GfGetNormalized (GfVec4h const &v, GfHalf eps=0.001)
 Returns a normalized (unit-length) vector with the same direction as v. More...
 
GfVec4h GfGetProjection (GfVec4h const &a, GfVec4h const &b)
 Returns the projection of a onto b. More...
 
GfVec4h GfGetComplement (GfVec4h const &a, GfVec4h const &b)
 Returns the orthogonal complement of a.GetProjection(b). More...
 
bool GfIsClose (GfVec4h const &v1, GfVec4h 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()

GfVec4h GfCompDiv ( GfVec4h const &  v1,
GfVec4h const &  v2 
)
inline

Returns component-wise quotient of vectors v1 and v2.

Definition at line 357 of file vec4h.h.

◆ GfCompMult()

GfVec4h GfCompMult ( GfVec4h const &  v1,
GfVec4h const &  v2 
)
inline

Returns component-wise multiplication of vectors v1 and v2.

Definition at line 346 of file vec4h.h.

◆ GfDot()

GfHalf GfDot ( GfVec4h const &  v1,
GfVec4h const &  v2 
)
inline

Returns the dot (inner) product of two vectors.

Definition at line 368 of file vec4h.h.

◆ GfGetComplement()

GfVec4h GfGetComplement ( GfVec4h const &  a,
GfVec4h const &  b 
)
inline

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

That is:

a - a.GetProjection(b)

Definition at line 413 of file vec4h.h.

◆ GfGetLength()

GfHalf GfGetLength ( GfVec4h const &  v)
inline

Returns the geometric length of v.

Definition at line 375 of file vec4h.h.

◆ GfGetNormalized()

GfVec4h GfGetNormalized ( GfVec4h const &  v,
GfHalf  eps = 0.001 
)
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 393 of file vec4h.h.

◆ GfGetProjection()

GfVec4h GfGetProjection ( GfVec4h const &  a,
GfVec4h const &  b 
)
inline

Returns the projection of a onto b.

That is:

b * (a * b)

Definition at line 403 of file vec4h.h.

◆ GfIsClose()

bool GfIsClose ( GfVec4h const &  v1,
GfVec4h 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 421 of file vec4h.h.

◆ GfNormalize()

GfHalf GfNormalize ( GfVec4h v,
GfHalf  eps = 0.001 
)
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 384 of file vec4h.h.