11#ifndef PXR_BASE_GF_VEC3F_H
12#define PXR_BASE_GF_VEC3F_H
19#include "pxr/base/gf/api.h"
21#include "pxr/base/gf/traits.h"
30PXR_NAMESPACE_OPEN_SCOPE
50 static const size_t dimension = 3;
57 : _data{ value, value, value }
62 constexpr GfVec3f(
float s0,
float s1,
float s2)
70 : _data{ p[0], p[1], p[2] }
121 return Set(a[0], a[1], a[2]);
125 float const *
data()
const {
return _data; }
126 float *
data() {
return _data; }
127 float const *GetArray()
const {
return data(); }
131 float &
operator[](
size_t i) {
return _data[i]; }
140 return _data[0] == other[0] &&
141 _data[1] == other[1] &&
142 _data[2] == other[2];
144 bool operator!=(
GfVec3f const &other)
const {
145 return !(*
this == other);
161 return GfVec3f(-_data[0], -_data[1], -_data[2]);
166 _data[0] += other[0];
167 _data[1] += other[1];
168 _data[2] += other[2];
177 _data[0] -= other[0];
178 _data[1] -= other[1];
179 _data[2] -= other[2];
193 GfVec3f operator*(
double s)
const {
206 return *
this *= (1.0 / s);
208 GfVec3f operator/(
double s)
const {
209 return *
this * (1.0 / s);
214 return _data[0] * v[0] + _data[1] * v[1] + _data[2] * v[2];
222 return v * (*
this * v);
236 return *
this * *
this;
256 *
this /= (length > eps) ? length : eps;
262 normalized.Normalize(eps);
278 const bool normalize,
299PXR_NAMESPACE_CLOSE_SCOPE
305PXR_NAMESPACE_OPEN_SCOPE
378 return v.GetNormalized(eps);
407 return delta.
GetLengthSq() <= tolerance * tolerance;
416GfBuildOrthonormalFrame(
GfVec3f const &v0,
426 v1[1] * v2[2] - v1[2] * v2[1],
427 v1[2] * v2[0] - v1[0] * v2[2],
428 v1[0] * v2[1] - v1[1] * v2[0]);
445PXR_NAMESPACE_CLOSE_SCOPE
Low-level utilities for informing users of various internal and external diagnostic conditions.
Basic type for a vector of 3 double components.
Basic type for a vector of 3 float components.
GfVec3f & Set(float s0, float s1, float s2)
Set all elements with passed arguments.
GF_API bool operator==(class GfVec3h const &other) const
Equality comparison.
constexpr GfVec3f(float s0, float s1, float s2)
Initialize all elements with explicit arguments.
GfVec3f & operator-=(GfVec3f const &other)
Subtraction.
static GfVec3f XAxis()
Create a unit vector along the X-axis.
GF_API bool operator==(class GfVec3d const &other) const
Equality comparison.
static GfVec3f Axis(size_t i)
Create a unit vector along the i-th axis, zero-based.
GfVec3f()=default
Default constructor does no initialization.
constexpr GfVec3f(float value)
Initialize all elements to a single value.
static GF_API bool OrthogonalizeBasis(GfVec3f *tx, GfVec3f *ty, GfVec3f *tz, const bool normalize, double eps=GF_MIN_ORTHO_TOLERANCE)
Orthogonalize and optionally normalize a set of basis vectors.
float GetLength() const
Length.
GfVec3f operator-() const
Create a vec with negated elements.
GfVec3f & operator*=(double s)
Multiplication by scalar.
float Normalize(float eps=GF_MIN_VECTOR_LENGTH)
Normalizes the vector in place to unit length, returning the length before normalization.
GfVec3f GetProjection(GfVec3f const &v) const
Returns the projection of this onto v.
float const & operator[](size_t i) const
Indexing.
GF_API void BuildOrthonormalFrame(GfVec3f *v1, GfVec3f *v2, float eps=GF_MIN_VECTOR_LENGTH) const
Sets v1 and v2 to unit vectors such that v1, v2 and *this are mutually orthogonal.
float GetLengthSq() const
Squared length.
friend size_t hash_value(GfVec3f const &vec)
Hash.
float operator*(GfVec3f const &v) const
See GfDot().
static GfVec3f YAxis()
Create a unit vector along the Y-axis.
constexpr GfVec3f(Scl const *p)
Construct with pointer to values.
bool operator==(GfVec3f const &other) const
Equality comparison.
static GfVec3f ZAxis()
Create a unit vector along the Z-axis.
GfVec3f & operator+=(GfVec3f const &other)
Addition.
GfVec3f & operator/=(double s)
Division by scalar.
GF_API bool operator==(class GfVec3i const &other) const
Equality comparison.
float const * data() const
Direct data access.
float ScalarType
Scalar element type and dimension.
GfVec3f GetComplement(GfVec3f const &b) const
Returns the orthogonal complement of this->GetProjection(b).
GfVec3f & Set(float const *a)
Set all elements with a pointer to data.
Basic type for a vector of 3 GfHalf components.
Basic type for a vector of 3 int components.
static size_t Combine(Args &&... args)
Produce a hash code by combining the hash codes of several objects.
Assorted mathematical utility functions.
double GfSqrt(double f)
Return sqrt(f).
#define GF_MIN_VECTOR_LENGTH
This constant is used to determine whether the length of a vector is too small to handle accurately.
GF_API std::ostream & operator<<(std::ostream &, const GfBBox3d &)
Output a GfBBox3d using the format [(range) matrix zeroArea].
#define GF_MIN_ORTHO_TOLERANCE
This constant is used to determine when a set of basis vectors is close to orthogonal.
Defines useful mathematical limits.
A metafunction with a static const bool member 'value' that is true for GfVec types,...
float GfDot(GfVec3f const &v1, GfVec3f const &v2)
Returns the dot (inner) product of two vectors.
GfVec3f GfGetComplement(GfVec3f const &a, GfVec3f const &b)
Returns the orthogonal complement of a.GetProjection(b).
GfVec3f GfCross(GfVec3f const &v1, GfVec3f const &v2)
Returns the cross product of v1 and v2.
GF_API GfVec3f GfSlerp(double alpha, GfVec3f const &v0, GfVec3f const &v1)
Spherical linear interpolation in three dimensions.
GfVec3f GfGetProjection(GfVec3f const &a, GfVec3f const &b)
Returns the projection of a onto b.
bool GfIsClose(GfVec3f const &v1, GfVec3f const &v2, double tolerance)
Tests for equality within a given tolerance, returning true if the length of the difference vector is...
GfVec3f GfCompDiv(GfVec3f const &v1, GfVec3f const &v2)
Returns component-wise quotient of vectors v1 and v2.
float GfGetLength(GfVec3f const &v)
Returns the geometric length of v.
GfVec3f GfCompMult(GfVec3f const &v1, GfVec3f const &v2)
Returns component-wise multiplication of vectors v1 and v2.
float GfNormalize(GfVec3f *v, float eps=GF_MIN_VECTOR_LENGTH)
Normalizes *v in place to unit length, returning the length before normalization.
GfVec3f GfGetNormalized(GfVec3f const &v, float eps=GF_MIN_VECTOR_LENGTH)
Returns a normalized (unit-length) vector with the same direction as v.
GfVec3f operator^(GfVec3f const &v1, GfVec3f const &v2)
Returns the cross product of v1 and v2.