vec3d.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/vec3f.h"
#include "pxr/base/gf/vec3h.h"
#include "pxr/base/gf/vec3i.h"

Include dependency graph for vec3d.h:

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

Go to the source code of this file.

Classes
struct	GfIsGfVec< class GfVec3d >
class	GfVec3d

Functions
GF_API std::ostream &	operator<< (std::ostream &, GfVec3d const &)
GfVec3d	GfCompMult (GfVec3d const &v1, GfVec3d const &v2)
	Returns component-wise multiplication of vectors v1 and v2. More...
GfVec3d	GfCompDiv (GfVec3d const &v1, GfVec3d const &v2)
	Returns component-wise quotient of vectors v1 and v2. More...
double	GfDot (GfVec3d const &v1, GfVec3d const &v2)
	Returns the dot (inner) product of two vectors. More...
double	GfGetLength (GfVec3d const &v)
	Returns the geometric length of v. More...
double	GfNormalize (GfVec3d *v, double eps=GF_MIN_VECTOR_LENGTH)
GfVec3d	GfGetNormalized (GfVec3d const &v, double eps=GF_MIN_VECTOR_LENGTH)
GfVec3d	GfGetProjection (GfVec3d const &a, GfVec3d const &b)
GfVec3d	GfGetComplement (GfVec3d const &a, GfVec3d const &b)
bool	GfIsClose (GfVec3d const &v1, GfVec3d const &v2, double tolerance)
GF_API bool	GfOrthogonalizeBasis (GfVec3d *tx, GfVec3d *ty, GfVec3d *tz, bool normalize, double eps=GF_MIN_ORTHO_TOLERANCE)
GF_API void	GfBuildOrthonormalFrame (GfVec3d const &v0, GfVec3d *v1, GfVec3d *v2, double eps=GF_MIN_VECTOR_LENGTH)
GfVec3d	GfCross (GfVec3d const &v1, GfVec3d const &v2)
	Returns the cross product of v1 and v2. More...
GfVec3d	operator^ (GfVec3d const &v1, GfVec3d const &v2)
GF_API GfVec3d	GfSlerp (double alpha, GfVec3d const &v0, GfVec3d const &v1)
	Spherical linear interpolation in three dimensions. More...

Function Documentation

GF_API void GfBuildOrthonormalFrame	(	GfVec3d const &	v0,
		GfVec3d *	v1,
		GfVec3d *	v2,
		double	eps = GF_MIN_VECTOR_LENGTH
	)

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

inline

Returns component-wise quotient of vectors v1 and v2.

Definition at line 341 of file vec3d.h.

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

inline

Returns component-wise multiplication of vectors v1 and v2.

Definition at line 331 of file vec3d.h.

GfVec3d GfCross ( GfVec3d const &  v1, GfVec3d const &  v2  )

inline

Returns the cross product of v1 and v2.

Definition at line 423 of file vec3d.h.

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

inline

Returns the dot (inner) product of two vectors.

Definition at line 351 of file vec3d.h.

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

inline

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

a - a.GetProjection(b)

Definition at line 396 of file vec3d.h.

double GfGetLength ( GfVec3d const &  v )

inline

Returns the geometric length of v.

Definition at line 358 of file vec3d.h.

GfVec3d GfGetNormalized ( GfVec3d 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 376 of file vec3d.h.

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

inline

Returns the projection of a onto b. That is:

b * (a * b)

Definition at line 386 of file vec3d.h.

bool GfIsClose ( GfVec3d const &  v1, GfVec3d 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 404 of file vec3d.h.

double GfNormalize ( GfVec3d *  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 367 of file vec3d.h.

GF_API bool GfOrthogonalizeBasis	(	GfVec3d *	tx,
		GfVec3d *	ty,
		GfVec3d *	tz,
		bool	normalize,
		double	eps = GF_MIN_ORTHO_TOLERANCE
	)

GF_API GfVec3d GfSlerp	(	double	alpha,
		GfVec3d const &	v0,
		GfVec3d const &	v1
	)

Spherical linear interpolation in three dimensions.

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

Output a GfVec3d.

GfVec3d operator^ ( GfVec3d const &  v1, GfVec3d const &  v2  )

inline

Returns the cross product of v1 and v2.

See Also

GfCross()

Definition at line 434 of file vec3d.h.