 |
|
|
|
Basic type for a vector of 3 float components. More...
#include <vec3f.h>
Public Types | |
| typedef float | ScalarType |
| Scalar element type and dimension. | |
Public Member Functions | |
| GfVec3f ()=default | |
| GfVec3f value-initializes to zero and performs no default initialization, like float or double. | |
| constexpr | GfVec3f (float value) |
| Initialize all elements to a single value. | |
| constexpr | GfVec3f (float s0, float s1, float s2) |
| Initialize all elements with explicit arguments. | |
| template<class Scl > | |
| constexpr | GfVec3f (Scl const *p) |
| Construct with pointer to values. | |
| GfVec3f (class GfVec3d const &other) | |
| Construct from GfVec3d. | |
| GfVec3f (class GfVec3h const &other) | |
| Implicitly convert from GfVec3h. | |
| GfVec3f (class GfVec3i const &other) | |
| Implicitly convert from GfVec3i. | |
| GfVec3f & | Set (float s0, float s1, float s2) |
| Set all elements with passed arguments. | |
| GfVec3f & | Set (float const *a) |
| Set all elements with a pointer to data. | |
| float const * | data () const |
| Direct data access. | |
| float * | data () |
| float const * | GetArray () const |
| float const & | operator[] (size_t i) const |
| Indexing. | |
| float & | operator[] (size_t i) |
| bool | operator== (GfVec3f const &other) const |
| Equality comparison. | |
| bool | operator!= (GfVec3f const &other) const |
| GF_API bool | operator== (class GfVec3d const &other) const |
| Equality comparison. | |
| GF_API bool | operator== (class GfVec3h const &other) const |
| Equality comparison. | |
| GF_API bool | operator== (class GfVec3i const &other) const |
| Equality comparison. | |
| GfVec3f | operator- () const |
| Create a vec with negated elements. | |
| GfVec3f & | operator+= (GfVec3f const &other) |
| Addition. | |
| GfVec3f & | operator-= (GfVec3f const &other) |
| Subtraction. | |
| GfVec3f & | operator*= (double s) |
| Multiplication by scalar. | |
| GfVec3f | operator* (double s) const |
| GfVec3f & | operator/= (double s) |
| Division by scalar. | |
| GfVec3f | operator/ (double s) const |
| float | operator* (GfVec3f const &v) const |
| See GfDot(). | |
| GfVec3f | GetProjection (GfVec3f const &v) const |
Returns the projection of this onto v. | |
| GfVec3f | GetComplement (GfVec3f const &b) const |
Returns the orthogonal complement of this->GetProjection(b). | |
| float | GetLengthSq () const |
| Squared length. | |
| float | GetLength () const |
| Length. | |
| float | Normalize (float eps=GF_MIN_VECTOR_LENGTH) |
| Normalizes the vector in place to unit length, returning the length before normalization. | |
| GfVec3f | GetNormalized (float eps=GF_MIN_VECTOR_LENGTH) const |
| 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. | |
Swizzles | |
Each accessor returns a new vector built from this one's components, in the order named. For example zyx() returns GfVec3f(z, y, x). Every permutation of 2 to 3 of the 3 components is available. Repeated components ( The results are ordinary GfVecs, so all the usual operators, GfDot() and so on apply to them. They are values, not references into this vector, so they cannot be assigned through. | |
| constexpr GfVec2f | xy () const |
| constexpr GfVec2f | xz () const |
| constexpr GfVec2f | yx () const |
| constexpr GfVec2f | yz () const |
| constexpr GfVec2f | zx () const |
| constexpr GfVec2f | zy () const |
| constexpr GfVec3f | xyz () const |
| constexpr GfVec3f | xzy () const |
| constexpr GfVec3f | yxz () const |
| constexpr GfVec3f | yzx () const |
| constexpr GfVec3f | zxy () const |
| constexpr GfVec3f | zyx () const |
Static Public Member Functions | |
| static GfVec3f | XAxis () |
| Create a unit vector along the X-axis. | |
| static GfVec3f | YAxis () |
| Create a unit vector along the Y-axis. | |
| static GfVec3f | ZAxis () |
| Create a unit vector along the Z-axis. | |
| static GfVec3f | Axis (size_t i) |
| Create a unit vector along the i-th axis, zero-based. | |
| 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. | |
Public Attributes | |
Vector Components | |
The vector's components, which are also its storage. These are public and directly readable and writable. The components are contiguous and in declaration order, so For multi-component access see the swizzle accessors below, which return a new vector by value. | |
| float | x |
| float | y |
| float | z |
Static Public Attributes | |
| static const size_t | dimension = 3 |
Friends | |
| size_t | hash_value (GfVec3f const &vec) |
| Hash. | |
| GfVec3f | operator+ (GfVec3f const &l, GfVec3f const &r) |
| GfVec3f | operator- (GfVec3f const &l, GfVec3f const &r) |
| GfVec3f | operator* (double s, GfVec3f const &v) |
Basic type for a vector of 3 float components.
Represents a vector of 3 components of type float. It is intended to be fast and simple.
| float ScalarType |
|
default |
GfVec3f value-initializes to zero and performs no default initialization, like float or double.
|
inlineexplicitconstexpr |
|
inlineconstexpr |
|
inlineexplicitconstexpr |
|
inlinestatic |
| 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.
If the length L of *this is smaller than eps, then v1 and v2 will have magnitude L/eps. As a result, the function delivers a continuous result as *this shrinks in length.
|
inline |
Returns the orthogonal complement of this->GetProjection(b).
That is:
|
inline |
|
inline |
Normalizes the vector in place to unit length, returning the length before normalization.
If the length of the vector is smaller than eps, then the vector is set to vector/eps. The original length of the vector is returned. See also GfNormalize().
|
inline |
|
inline |
|
inline |
| GF_API bool operator== | ( | class GfVec3d const & | other | ) | const |
Equality comparison.
| GF_API bool operator== | ( | class GfVec3h const & | other | ) | const |
Equality comparison.
| GF_API bool operator== | ( | class GfVec3i const & | other | ) | const |
Equality comparison.
|
inline |
|
static |
Orthogonalize and optionally normalize a set of basis vectors.
This uses an iterative method that is very stable even when the vectors are far from orthogonal (close to colinear). The number of iterations and thus the computation time does increase as the vectors become close to colinear, however. Returns a bool specifying whether the solution converged after a number of iterations. If it did not converge, the returned vectors will be as close as possible to orthogonal within the iteration limit. Colinear vectors will be unaltered, and the method will return false.
|
inline |
|
inline |
|
inlinestatic |
|
inlinestatic |
|
inlinestatic |
1.12.0