This document is for a version of USD that is under development. See this page for the current release.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
vec4d.h File Reference
+ Include dependency graph for vec4d.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  GfVec4d
 Basic type for a vector of 4 double components. More...
 

Functions

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

Function Documentation

◆ GfCompDiv()

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

Returns component-wise quotient of vectors v1 and v2.

Definition at line 333 of file vec4d.h.

◆ GfCompMult()

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

Returns component-wise multiplication of vectors v1 and v2.

Definition at line 322 of file vec4d.h.

◆ GfDot()

double GfDot ( GfVec4d const &  v1,
GfVec4d const &  v2 
)
inline

Returns the dot (inner) product of two vectors.

Definition at line 344 of file vec4d.h.

◆ GfGetComplement()

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

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

That is:

a - a.GetProjection(b)

Definition at line 389 of file vec4d.h.

◆ GfGetLength()

double GfGetLength ( GfVec4d const &  v)
inline

Returns the geometric length of v.

Definition at line 351 of file vec4d.h.

◆ GfGetNormalized()

GfVec4d GfGetNormalized ( GfVec4d const &  v,
double  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 369 of file vec4d.h.

◆ GfGetProjection()

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

Returns the projection of a onto b.

That is:

b * (a * b)

Definition at line 379 of file vec4d.h.

◆ GfIsClose()

bool GfIsClose ( GfVec4d const &  v1,
GfVec4d 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 397 of file vec4d.h.

◆ GfNormalize()

double GfNormalize ( GfVec4d v,
double  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 360 of file vec4d.h.