vec3f.h

Go to the documentation of this file.

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
// This file is generated by a script.  Do not edit directly.  Edit the
// vec.template.h file to make changes.
 
#ifndef PXR_BASE_GF_VEC3F_H
#define PXR_BASE_GF_VEC3F_H
 
 
#include "pxr/pxr.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/diagnostic.h"
#include "pxr/base/tf/hash.h"
 
#include <cstddef>
#include <type_traits>
#include <cmath>
 
#include <iosfwd>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class GfVec2f;
 
template <>
struct GfIsGfVec<class GfVec3f> { static const bool value = true; };
 
class GfVec3f
{
public:
    typedef float ScalarType;
    static const size_t dimension = 3;
 
    float x, y, z;
 
    GfVec3f() = default;
 
    constexpr explicit GfVec3f(float value)
        : x(value), y(value), z(value)
    {
    }
 
    constexpr GfVec3f(float s0, float s1, float s2)
        : x(s0), y(s1), z(s2)
    {
    }
 
    template <class Scl>
    constexpr explicit GfVec3f(Scl const *p)
        : x(p[0]), y(p[1]), z(p[2])
    {
    }
 
    explicit GfVec3f(class GfVec3d const &other);
 
    GfVec3f(class GfVec3h const &other);
 
    GfVec3f(class GfVec3i const &other);
    static GfVec3f XAxis() {
        GfVec3f result(0);
        result[0] = 1;
        return result;
    }
 
    static GfVec3f YAxis() {
        GfVec3f result(0);
        result[1] = 1;
        return result;
    }
 
    static GfVec3f ZAxis() {
        GfVec3f result(0);
        result[2] = 1;
        return result;
    }
 
    static GfVec3f Axis(size_t i) {
        GfVec3f result(0);
        if (i < 3)
            result[i] = 1;
        return result;
    }
 
    GfVec3f &Set(float s0, float s1, float s2) {
        x = s0;
        y = s1;
        z = s2;
        return *this;
    }
 
    GfVec3f &Set(float const *a) {
        return Set(a[0], a[1], a[2]);
    }
 
    float const *data() const { return &x; }
    float *data() { return &x; }
    float const *GetArray() const { return data(); }
 
    float const &operator[](size_t i) const { return data()[i]; }
    float &operator[](size_t i) { return data()[i]; }
 
    friend inline size_t hash_value(GfVec3f const &vec) {
        return TfHash::Combine(vec.x, vec.y, vec.z);
    }
 
    bool operator==(GfVec3f const &other) const {
        return x == other.x &&
               y == other.y &&
               z == other.z;
    }
    bool operator!=(GfVec3f const &other) const {
        return !(*this == other);
    }
 
    // TODO Add inequality for other vec types...
    GF_API
    bool operator==(class GfVec3d const &other) const;
    GF_API
    bool operator==(class GfVec3h const &other) const;
    GF_API
    bool operator==(class GfVec3i const &other) const;
    
    GfVec3f operator-() const {
        return GfVec3f(-x, -y, -z);
    }
 
    GfVec3f &operator+=(GfVec3f const &other) {
        x += other.x;
        y += other.y;
        z += other.z;
        return *this;
    }
    friend GfVec3f operator+(GfVec3f const &l, GfVec3f const &r) {
        return GfVec3f(l) += r;
    }
 
    GfVec3f &operator-=(GfVec3f const &other) {
        x -= other.x;
        y -= other.y;
        z -= other.z;
        return *this;
    }
    friend GfVec3f operator-(GfVec3f const &l, GfVec3f const &r) {
        return GfVec3f(l) -= r;
    }
 
    GfVec3f &operator*=(double s) {
        x *= s;
        y *= s;
        z *= s;
        return *this;
    }
    GfVec3f operator*(double s) const {
        return GfVec3f(*this) *= s;
    }
    friend GfVec3f operator*(double s, GfVec3f const &v) {
        return v * s;
    }
 
    // TODO should divide by the scalar type.
    GfVec3f &operator/=(double s) {
        // TODO This should not multiply by 1/s, it should do the division.
        // Doing the division is more numerically stable when s is close to
        // zero.
        return *this *= (1.0 / s);
    }
    GfVec3f operator/(double s) const {
        return *this * (1.0 / s);
    }
    
    float operator*(GfVec3f const &v) const {
        return x * v.x + y * v.y + z * v.z;
    }
 
    GfVec3f GetProjection(GfVec3f const &v) const {
        return v * (*this * v);
    }
 
    GfVec3f GetComplement(GfVec3f const &b) const {
        return *this - this->GetProjection(b);
    }
 
    float GetLengthSq() const {
        return *this * *this;
    }
 
    float GetLength() const {
        return GfSqrt(GetLengthSq());
    }
 
    float Normalize(float eps = GF_MIN_VECTOR_LENGTH) {
        // TODO this seems suspect...  suggest dividing by length so long as
        // length is not zero.
        float length = GetLength();
        *this /= (length > eps) ? length : eps;
        return length;
    }
 
    GfVec3f GetNormalized(float eps = GF_MIN_VECTOR_LENGTH) const {
        GfVec3f normalized(*this);
        normalized.Normalize(eps);
        return normalized;
    }
 
    GF_API
    static bool OrthogonalizeBasis(
        GfVec3f *tx, GfVec3f *ty, GfVec3f *tz,
        const bool normalize,
        double eps = GF_MIN_ORTHO_TOLERANCE);
 
    GF_API
    void BuildOrthonormalFrame(GfVec3f *v1, GfVec3f *v2,
                               float eps = GF_MIN_VECTOR_LENGTH) const;
 
  
#if defined (doxygen)
    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;
#else // !doxygen
    // Note that these are templated on their own return type so that the
    // declarations cost nothing in compile time & debug info unless they are
    // actually called in a TU.  Naming a different type is an error and
    // static_assert()ed against.
    template <class Vec = GfVec2f> constexpr Vec xy() const;
    template <class Vec = GfVec2f> constexpr Vec xz() const;
    template <class Vec = GfVec2f> constexpr Vec yx() const;
    template <class Vec = GfVec2f> constexpr Vec yz() const;
    template <class Vec = GfVec2f> constexpr Vec zx() const;
    template <class Vec = GfVec2f> constexpr Vec zy() const;
    template <class Vec = GfVec3f> constexpr Vec xyz() const;
    template <class Vec = GfVec3f> constexpr Vec xzy() const;
    template <class Vec = GfVec3f> constexpr Vec yxz() const;
    template <class Vec = GfVec3f> constexpr Vec yzx() const;
    template <class Vec = GfVec3f> constexpr Vec zxy() const;
    template <class Vec = GfVec3f> constexpr Vec zyx() const;
#endif // doxygen
 };
 
GF_API std::ostream& operator<<(std::ostream &, GfVec3f const &);
 
PXR_NAMESPACE_CLOSE_SCOPE
 
// Other scalar types of the same dimension, for the conversions above.
#include "pxr/base/gf/vec3d.h"
#include "pxr/base/gf/vec3h.h"
#include "pxr/base/gf/vec3i.h"
// Lower dimensions of the same scalar type, for the swizzles above.  Note that
// lower dimensions never include higher ones, so this introduces no cycle.
#include "pxr/base/gf/vec2f.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
inline
GfVec3f::GfVec3f(class GfVec3d const &other)
{
    x = other.x;
    y = other.y;
    z = other.z;
}
inline
GfVec3f::GfVec3f(class GfVec3h const &other)
{
    x = other.x;
    y = other.y;
    z = other.z;
}
inline
GfVec3f::GfVec3f(class GfVec3i const &other)
{
    x = other.x;
    y = other.y;
    z = other.z;
}
 
template <class Vec>
constexpr Vec
GfVec3f::xy() const
{
    static_assert(std::is_same<Vec, GfVec2f>::value);
    return Vec(x, y);
}
 
template <class Vec>
constexpr Vec
GfVec3f::xz() const
{
    static_assert(std::is_same<Vec, GfVec2f>::value);
    return Vec(x, z);
}
 
template <class Vec>
constexpr Vec
GfVec3f::yx() const
{
    static_assert(std::is_same<Vec, GfVec2f>::value);
    return Vec(y, x);
}
 
template <class Vec>
constexpr Vec
GfVec3f::yz() const
{
    static_assert(std::is_same<Vec, GfVec2f>::value);
    return Vec(y, z);
}
 
template <class Vec>
constexpr Vec
GfVec3f::zx() const
{
    static_assert(std::is_same<Vec, GfVec2f>::value);
    return Vec(z, x);
}
 
template <class Vec>
constexpr Vec
GfVec3f::zy() const
{
    static_assert(std::is_same<Vec, GfVec2f>::value);
    return Vec(z, y);
}
 
template <class Vec>
constexpr Vec
GfVec3f::xyz() const
{
    static_assert(std::is_same<Vec, GfVec3f>::value);
    return Vec(x, y, z);
}
 
template <class Vec>
constexpr Vec
GfVec3f::xzy() const
{
    static_assert(std::is_same<Vec, GfVec3f>::value);
    return Vec(x, z, y);
}
 
template <class Vec>
constexpr Vec
GfVec3f::yxz() const
{
    static_assert(std::is_same<Vec, GfVec3f>::value);
    return Vec(y, x, z);
}
 
template <class Vec>
constexpr Vec
GfVec3f::yzx() const
{
    static_assert(std::is_same<Vec, GfVec3f>::value);
    return Vec(y, z, x);
}
 
template <class Vec>
constexpr Vec
GfVec3f::zxy() const
{
    static_assert(std::is_same<Vec, GfVec3f>::value);
    return Vec(z, x, y);
}
 
template <class Vec>
constexpr Vec
GfVec3f::zyx() const
{
    static_assert(std::is_same<Vec, GfVec3f>::value);
    return Vec(z, y, x);
}
 
 
inline GfVec3f
GfCompMult(GfVec3f const &v1, GfVec3f const &v2) {
    return GfVec3f(
        v1.x * v2.x,
        v1.y * v2.y,
        v1.z * v2.z
        );
}
 
inline GfVec3f
GfCompDiv(GfVec3f const &v1, GfVec3f const &v2) {
    return GfVec3f(
        v1.x / v2.x,
        v1.y / v2.y,
        v1.z / v2.z
        );
}
 
inline float
GfDot(GfVec3f const &v1, GfVec3f const &v2) {
    return v1 * v2;
}
 
 
inline float
GfGetLength(GfVec3f const &v)
{
    return v.GetLength();
}
 
inline float
GfNormalize(GfVec3f *v, float eps = GF_MIN_VECTOR_LENGTH)
{
    return v->Normalize(eps);
}
 
inline GfVec3f
GfGetNormalized(GfVec3f const &v, float eps = GF_MIN_VECTOR_LENGTH)
{
    return v.GetNormalized(eps);
}
 
inline GfVec3f
GfGetProjection(GfVec3f const &a, GfVec3f const &b)
{
    return a.GetProjection(b);
}
 
inline GfVec3f
GfGetComplement(GfVec3f const &a, GfVec3f const &b)
{
    return a.GetComplement(b);
}
 
inline bool
GfIsClose(GfVec3f const &v1, GfVec3f const &v2, double tolerance)
{
    GfVec3f delta = v1 - v2;
    return delta.GetLengthSq() <= tolerance * tolerance;
}
 
 
GF_API bool
GfOrthogonalizeBasis(GfVec3f *tx, GfVec3f *ty, GfVec3f *tz,
                     bool normalize, double eps = GF_MIN_ORTHO_TOLERANCE);
 
GF_API void
GfBuildOrthonormalFrame(GfVec3f const &v0,
                        GfVec3f* v1,
                        GfVec3f* v2,
                        float eps = GF_MIN_VECTOR_LENGTH);
 
inline GfVec3f
GfCross(GfVec3f const &v1, GfVec3f const &v2)
{
    return GfVec3f(
        v1.y * v2.z - v1.z * v2.y,
        v1.z * v2.x - v1.x * v2.z,
        v1.x * v2.y - v1.y * v2.x);
}
 
inline GfVec3f
operator^(GfVec3f const &v1, GfVec3f const &v2)
{
    return GfCross(v1, v2);
}
 
GF_API GfVec3f
GfSlerp(double alpha, GfVec3f const &v0, GfVec3f const &v1);
 
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_BASE_GF_VEC3F_H