 |
|
|
|
Basic type for a vector of 3 double components. More...
#include <vec3d.h>
Public Types | |
| typedef double | ScalarType |
| Scalar element type and dimension. | |
Public Member Functions | |
| GfVec3d ()=default | |
| GfVec3d value-initializes to zero and performs no default initialization, like float or double. | |
| constexpr | GfVec3d (double value) |
| Initialize all elements to a single value. | |
| constexpr | GfVec3d (double s0, double s1, double s2) |
| Initialize all elements with explicit arguments. | |
| template<class Scl > | |
| constexpr | GfVec3d (Scl const *p) |
| Construct with pointer to values. | |
| GfVec3d (class GfVec3f const &other) | |
| Implicitly convert from GfVec3f. | |
| GfVec3d (class GfVec3h const &other) | |
| Implicitly convert from GfVec3h. | |
| GfVec3d (class GfVec3i const &other) | |
| Implicitly convert from GfVec3i. | |
| GfVec3d & | Set (double s0, double s1, double s2) |
| Set all elements with passed arguments. | |
| GfVec3d & | Set (double const *a) |
| Set all elements with a pointer to data. | |
| double const * | data () const |
| Direct data access. | |
| double * | data () |
| double const * | GetArray () const |
| double const & | operator[] (size_t i) const |
| Indexing. | |
| double & | operator[] (size_t i) |
| bool | operator== (GfVec3d const &other) const |
| Equality comparison. | |
| bool | operator!= (GfVec3d const &other) const |
| GF_API bool | operator== (class GfVec3f 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. | |
| GfVec3d | operator- () const |
| Create a vec with negated elements. | |
| GfVec3d & | operator+= (GfVec3d const &other) |
| Addition. | |
| GfVec3d & | operator-= (GfVec3d const &other) |
| Subtraction. | |
| GfVec3d & | operator*= (double s) |
| Multiplication by scalar. | |
| GfVec3d | operator* (double s) const |
| GfVec3d & | operator/= (double s) |
| Division by scalar. | |
| GfVec3d | operator/ (double s) const |
| double | operator* (GfVec3d const &v) const |
| See GfDot(). | |
| GfVec3d | GetProjection (GfVec3d const &v) const |
Returns the projection of this onto v. | |
| GfVec3d | GetComplement (GfVec3d const &b) const |
Returns the orthogonal complement of this->GetProjection(b). | |
| double | GetLengthSq () const |
| Squared length. | |
| double | GetLength () const |
| Length. | |
| double | Normalize (double eps=GF_MIN_VECTOR_LENGTH) |
| Normalizes the vector in place to unit length, returning the length before normalization. | |
| GfVec3d | GetNormalized (double eps=GF_MIN_VECTOR_LENGTH) const |
| GF_API void | BuildOrthonormalFrame (GfVec3d *v1, GfVec3d *v2, double 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 GfVec3d(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 GfVec2d | xy () const |
| constexpr GfVec2d | xz () const |
| constexpr GfVec2d | yx () const |
| constexpr GfVec2d | yz () const |
| constexpr GfVec2d | zx () const |
| constexpr GfVec2d | zy () const |
| constexpr GfVec3d | xyz () const |
| constexpr GfVec3d | xzy () const |
| constexpr GfVec3d | yxz () const |
| constexpr GfVec3d | yzx () const |
| constexpr GfVec3d | zxy () const |
| constexpr GfVec3d | zyx () const |
Static Public Member Functions | |
| static GfVec3d | XAxis () |
| Create a unit vector along the X-axis. | |
| static GfVec3d | YAxis () |
| Create a unit vector along the Y-axis. | |
| static GfVec3d | ZAxis () |
| Create a unit vector along the Z-axis. | |
| static GfVec3d | Axis (size_t i) |
| Create a unit vector along the i-th axis, zero-based. | |
| static GF_API bool | OrthogonalizeBasis (GfVec3d *tx, GfVec3d *ty, GfVec3d *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. | |
| double | x |
| double | y |
| double | z |
Static Public Attributes | |
| static const size_t | dimension = 3 |
Friends | |
| size_t | hash_value (GfVec3d const &vec) |
| Hash. | |
| GfVec3d | operator+ (GfVec3d const &l, GfVec3d const &r) |
| GfVec3d | operator- (GfVec3d const &l, GfVec3d const &r) |
| GfVec3d | operator* (double s, GfVec3d const &v) |
Basic type for a vector of 3 double components.
Represents a vector of 3 components of type double. It is intended to be fast and simple.
| double ScalarType |
|
default |
GfVec3d value-initializes to zero and performs no default initialization, like float or double.
|
inlineexplicitconstexpr |
|
inlineconstexpr |
|
inlineexplicitconstexpr |
|
inlinestatic |
| GF_API void BuildOrthonormalFrame | ( | GfVec3d * | v1, |
| GfVec3d * | v2, | ||
| double | 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 GfVec3f 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 |
|
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