vec2d.h File Reference

#include "pxr/pxr.h"
#include "pxr/base/tf/diagnostic.h"
#include "pxr/base/gf/api.h"
#include "pxr/base/gf/limits.h"
#include "pxr/base/gf/traits.h"
#include "pxr/base/gf/math.h"
#include "pxr/base/tf/hash.h"
#include <cstddef>
#include <cmath>
#include <iosfwd>
#include "pxr/base/gf/vec2f.h"
#include "pxr/base/gf/vec2h.h"
#include "pxr/base/gf/vec2i.h"

Include dependency graph for vec2d.h:

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

Go to the source code of this file.

Classes
struct	GfIsGfVec< class GfVec2d >
class	GfVec2d

Functions
GF_API std::ostream &	operator<< (std::ostream &, GfVec2d const &)
GfVec2d	GfCompMult (GfVec2d const &v1, GfVec2d const &v2)
	Returns component-wise multiplication of vectors v1 and v2. More...
GfVec2d	GfCompDiv (GfVec2d const &v1, GfVec2d const &v2)
	Returns component-wise quotient of vectors v1 and v2. More...
double	GfDot (GfVec2d const &v1, GfVec2d const &v2)
	Returns the dot (inner) product of two vectors. More...
double	GfGetLength (GfVec2d const &v)
	Returns the geometric length of v. More...
double	GfNormalize (GfVec2d *v, double eps=GF_MIN_VECTOR_LENGTH)
GfVec2d	GfGetNormalized (GfVec2d const &v, double eps=GF_MIN_VECTOR_LENGTH)
GfVec2d	GfGetProjection (GfVec2d const &a, GfVec2d const &b)
GfVec2d	GfGetComplement (GfVec2d const &a, GfVec2d const &b)
bool	GfIsClose (GfVec2d const &v1, GfVec2d const &v2, double tolerance)

Function Documentation

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

inline

Returns component-wise quotient of vectors v1 and v2.

Definition at line 320 of file vec2d.h.

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

inline

Returns component-wise multiplication of vectors v1 and v2.

Definition at line 311 of file vec2d.h.

double GfDot ( GfVec2d const &  v1, GfVec2d const &  v2  )

inline

Returns the dot (inner) product of two vectors.

Definition at line 329 of file vec2d.h.

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

inline

Returns the orthogonal complement of a.GetProjection(b). That is:

a - a.GetProjection(b)

Definition at line 374 of file vec2d.h.

double GfGetLength ( GfVec2d const &  v )

inline

Returns the geometric length of v.

Definition at line 336 of file vec2d.h.

GfVec2d GfGetNormalized ( GfVec2d 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 354 of file vec2d.h.

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

inline

Returns the projection of a onto b. That is:

b * (a * b)

Definition at line 364 of file vec2d.h.

bool GfIsClose ( GfVec2d const &  v1, GfVec2d 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 382 of file vec2d.h.

double GfNormalize ( GfVec2d *  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 345 of file vec2d.h.

GF_API std::ostream& operator<<	(	std::ostream &	,
		GfVec2d const &
	)

Output a GfVec2d.