vec2f.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_VEC2F_H
#define PXR_BASE_GF_VEC2F_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
 
 
template <>
struct GfIsGfVec<class GfVec2f> { static const bool value = true; };
 
class GfVec2f
{
public:
    typedef float ScalarType;
    static const size_t dimension = 2;
 
    float x, y;
 
    GfVec2f() = default;
 
    constexpr explicit GfVec2f(float value)
        : x(value), y(value)
    {
    }
 
    constexpr GfVec2f(float s0, float s1)
        : x(s0), y(s1)
    {
    }
 
    template <class Scl>
    constexpr explicit GfVec2f(Scl const *p)
        : x(p[0]), y(p[1])
    {
    }
 
    explicit GfVec2f(class GfVec2d const &other);
 
    GfVec2f(class GfVec2h const &other);
 
    GfVec2f(class GfVec2i const &other);
    static GfVec2f XAxis() {
        GfVec2f result(0);
        result[0] = 1;
        return result;
    }
 
    static GfVec2f YAxis() {
        GfVec2f result(0);
        result[1] = 1;
        return result;
    }
 
    static GfVec2f Axis(size_t i) {
        GfVec2f result(0);
        if (i < 2)
            result[i] = 1;
        return result;
    }
 
    GfVec2f &Set(float s0, float s1) {
        x = s0;
        y = s1;
        return *this;
    }
 
    GfVec2f &Set(float const *a) {
        return Set(a[0], a[1]);
    }
 
    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(GfVec2f const &vec) {
        return TfHash::Combine(vec.x, vec.y);
    }
 
    bool operator==(GfVec2f const &other) const {
        return x == other.x &&
               y == other.y;
    }
    bool operator!=(GfVec2f const &other) const {
        return !(*this == other);
    }
 
    // TODO Add inequality for other vec types...
    GF_API
    bool operator==(class GfVec2d const &other) const;
    GF_API
    bool operator==(class GfVec2h const &other) const;
    GF_API
    bool operator==(class GfVec2i const &other) const;
    
    GfVec2f operator-() const {
        return GfVec2f(-x, -y);
    }
 
    GfVec2f &operator+=(GfVec2f const &other) {
        x += other.x;
        y += other.y;
        return *this;
    }
    friend GfVec2f operator+(GfVec2f const &l, GfVec2f const &r) {
        return GfVec2f(l) += r;
    }
 
    GfVec2f &operator-=(GfVec2f const &other) {
        x -= other.x;
        y -= other.y;
        return *this;
    }
    friend GfVec2f operator-(GfVec2f const &l, GfVec2f const &r) {
        return GfVec2f(l) -= r;
    }
 
    GfVec2f &operator*=(double s) {
        x *= s;
        y *= s;
        return *this;
    }
    GfVec2f operator*(double s) const {
        return GfVec2f(*this) *= s;
    }
    friend GfVec2f operator*(double s, GfVec2f const &v) {
        return v * s;
    }
 
    // TODO should divide by the scalar type.
    GfVec2f &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);
    }
    GfVec2f operator/(double s) const {
        return *this * (1.0 / s);
    }
    
    float operator*(GfVec2f const &v) const {
        return x * v.x + y * v.y;
    }
 
    GfVec2f GetProjection(GfVec2f const &v) const {
        return v * (*this * v);
    }
 
    GfVec2f GetComplement(GfVec2f 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;
    }
 
    GfVec2f GetNormalized(float eps = GF_MIN_VECTOR_LENGTH) const {
        GfVec2f normalized(*this);
        normalized.Normalize(eps);
        return normalized;
    }
 
  
#if defined (doxygen)
    constexpr GfVec2f xy() const;
    constexpr GfVec2f yx() 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 yx() const;
#endif // doxygen
 };
 
GF_API std::ostream& operator<<(std::ostream &, GfVec2f const &);
 
PXR_NAMESPACE_CLOSE_SCOPE
 
// Other scalar types of the same dimension, for the conversions above.
#include "pxr/base/gf/vec2d.h"
#include "pxr/base/gf/vec2h.h"
#include "pxr/base/gf/vec2i.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
inline
GfVec2f::GfVec2f(class GfVec2d const &other)
{
    x = other.x;
    y = other.y;
}
inline
GfVec2f::GfVec2f(class GfVec2h const &other)
{
    x = other.x;
    y = other.y;
}
inline
GfVec2f::GfVec2f(class GfVec2i const &other)
{
    x = other.x;
    y = other.y;
}
 
template <class Vec>
constexpr Vec
GfVec2f::xy() const
{
    static_assert(std::is_same<Vec, GfVec2f>::value);
    return Vec(x, y);
}
 
template <class Vec>
constexpr Vec
GfVec2f::yx() const
{
    static_assert(std::is_same<Vec, GfVec2f>::value);
    return Vec(y, x);
}
 
 
inline GfVec2f
GfCompMult(GfVec2f const &v1, GfVec2f const &v2) {
    return GfVec2f(
        v1.x * v2.x,
        v1.y * v2.y
        );
}
 
inline GfVec2f
GfCompDiv(GfVec2f const &v1, GfVec2f const &v2) {
    return GfVec2f(
        v1.x / v2.x,
        v1.y / v2.y
        );
}
 
inline float
GfDot(GfVec2f const &v1, GfVec2f const &v2) {
    return v1 * v2;
}
 
 
inline float
GfGetLength(GfVec2f const &v)
{
    return v.GetLength();
}
 
inline float
GfNormalize(GfVec2f *v, float eps = GF_MIN_VECTOR_LENGTH)
{
    return v->Normalize(eps);
}
 
inline GfVec2f
GfGetNormalized(GfVec2f const &v, float eps = GF_MIN_VECTOR_LENGTH)
{
    return v.GetNormalized(eps);
}
 
inline GfVec2f
GfGetProjection(GfVec2f const &a, GfVec2f const &b)
{
    return a.GetProjection(b);
}
 
inline GfVec2f
GfGetComplement(GfVec2f const &a, GfVec2f const &b)
{
    return a.GetComplement(b);
}
 
inline bool
GfIsClose(GfVec2f const &v1, GfVec2f const &v2, double tolerance)
{
    GfVec2f delta = v1 - v2;
    return delta.GetLengthSq() <= tolerance * tolerance;
}
 
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_BASE_GF_VEC2F_H