vec4f.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_VEC4F_H
#define PXR_BASE_GF_VEC4F_H
 
 
#include "pxr/pxr.h"
#include "pxr/base/tf/diagnostic.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/hash.h"
 
#include <cstddef>
#include <cmath>
 
#include <iosfwd>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class GfVec4f;
 
template <>
struct GfIsGfVec<class GfVec4f> { static const bool value = true; };
 
class GfVec4f
{
public:
    typedef float ScalarType;
    static const size_t dimension = 4;
 
    GfVec4f() = default;
 
    constexpr explicit GfVec4f(float value)
        : _data{ value, value, value, value }
    {
    }
 
    constexpr GfVec4f(float s0, float s1, float s2, float s3)
        : _data{ s0, s1, s2, s3 }
    {
    }
 
    template <class Scl>
    constexpr explicit GfVec4f(Scl const *p)
        : _data{ p[0], p[1], p[2], p[3] }
    {
    }
 
    explicit GfVec4f(class GfVec4d const &other);
 
    GfVec4f(class GfVec4h const &other);
 
    GfVec4f(class GfVec4i const &other);
 
    static GfVec4f XAxis() {
        GfVec4f result(0);
        result[0] = 1;
        return result;
    }
    static GfVec4f YAxis() {
        GfVec4f result(0);
        result[1] = 1;
        return result;
    }
    static GfVec4f ZAxis() {
        GfVec4f result(0);
        result[2] = 1;
        return result;
    }
    static GfVec4f WAxis() {
        GfVec4f result(0);
        result[3] = 1;
        return result;
    }
 
    static GfVec4f Axis(size_t i) {
        GfVec4f result(0);
        if (i < 4)
            result[i] = 1;
        return result;
    }
 
    GfVec4f &Set(float s0, float s1, float s2, float s3) {
        _data[0] = s0;
        _data[1] = s1;
        _data[2] = s2;
        _data[3] = s3;
        return *this;
    }
 
    GfVec4f &Set(float const *a) {
        return Set(a[0], a[1], a[2], a[3]);
    }
 
    float const *data() const { return _data; }
    float *data() { return _data; }
    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(GfVec4f const &vec) {
        return TfHash::Combine(vec[0], vec[1], vec[2], vec[3]);
    }
 
    bool operator==(GfVec4f const &other) const {
        return _data[0] == other[0] &&
               _data[1] == other[1] &&
               _data[2] == other[2] &&
               _data[3] == other[3];
    }
    bool operator!=(GfVec4f const &other) const {
        return !(*this == other);
    }
 
    // TODO Add inequality for other vec types...
    GF_API
    bool operator==(class GfVec4d const &other) const;
    GF_API
    bool operator==(class GfVec4h const &other) const;
    GF_API
    bool operator==(class GfVec4i const &other) const;
    
    GfVec4f operator-() const {
        return GfVec4f(-_data[0], -_data[1], -_data[2], -_data[3]);
    }
 
    GfVec4f &operator+=(GfVec4f const &other) {
        _data[0] += other[0];
        _data[1] += other[1];
        _data[2] += other[2];
        _data[3] += other[3];
        return *this;
    }
    friend GfVec4f operator+(GfVec4f const &l, GfVec4f const &r) {
        return GfVec4f(l) += r;
    }
 
    GfVec4f &operator-=(GfVec4f const &other) {
        _data[0] -= other[0];
        _data[1] -= other[1];
        _data[2] -= other[2];
        _data[3] -= other[3];
        return *this;
    }
    friend GfVec4f operator-(GfVec4f const &l, GfVec4f const &r) {
        return GfVec4f(l) -= r;
    }
 
    GfVec4f &operator*=(double s) {
        _data[0] *= s;
        _data[1] *= s;
        _data[2] *= s;
        _data[3] *= s;
        return *this;
    }
    GfVec4f operator*(double s) const {
        return GfVec4f(*this) *= s;
    }
    friend GfVec4f operator*(double s, GfVec4f const &v) {
        return v * s;
    }
 
    // TODO should divide by the scalar type.
    GfVec4f &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);
    }
    GfVec4f operator/(double s) const {
        return *this * (1.0 / s);
    }
    
    float operator*(GfVec4f const &v) const {
        return _data[0] * v[0] + _data[1] * v[1] + _data[2] * v[2] + _data[3] * v[3];
    }
 
    GfVec4f GetProjection(GfVec4f const &v) const {
        return v * (*this * v);
    }
 
    GfVec4f GetComplement(GfVec4f 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;
    }
 
    GfVec4f GetNormalized(float eps = GF_MIN_VECTOR_LENGTH) const {
        GfVec4f normalized(*this);
        normalized.Normalize(eps);
        return normalized;
    }
 
  
private:
    float _data[4];
};
 
GF_API std::ostream& operator<<(std::ostream &, GfVec4f const &);
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#include "pxr/base/gf/vec4d.h"
#include "pxr/base/gf/vec4h.h"
#include "pxr/base/gf/vec4i.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
inline
GfVec4f::GfVec4f(class GfVec4d const &other)
{
    _data[0] = other[0];
    _data[1] = other[1];
    _data[2] = other[2];
    _data[3] = other[3];
}
inline
GfVec4f::GfVec4f(class GfVec4h const &other)
{
    _data[0] = other[0];
    _data[1] = other[1];
    _data[2] = other[2];
    _data[3] = other[3];
}
inline
GfVec4f::GfVec4f(class GfVec4i const &other)
{
    _data[0] = other[0];
    _data[1] = other[1];
    _data[2] = other[2];
    _data[3] = other[3];
}
 
inline GfVec4f
GfCompMult(GfVec4f const &v1, GfVec4f const &v2) {
    return GfVec4f(
        v1[0] * v2[0],
        v1[1] * v2[1],
        v1[2] * v2[2],
        v1[3] * v2[3]
        );
}
 
inline GfVec4f
GfCompDiv(GfVec4f const &v1, GfVec4f const &v2) {
    return GfVec4f(
        v1[0] / v2[0],
        v1[1] / v2[1],
        v1[2] / v2[2],
        v1[3] / v2[3]
        );
}
 
inline float
GfDot(GfVec4f const &v1, GfVec4f const &v2) {
    return v1 * v2;
}
 
 
inline float
GfGetLength(GfVec4f const &v)
{
    return v.GetLength();
}
 
inline float
GfNormalize(GfVec4f *v, float eps = GF_MIN_VECTOR_LENGTH)
{
    return v->Normalize(eps);
}
 
inline GfVec4f
GfGetNormalized(GfVec4f const &v, float eps = GF_MIN_VECTOR_LENGTH)
{
    return v.GetNormalized(eps);
}
 
inline GfVec4f
GfGetProjection(GfVec4f const &a, GfVec4f const &b)
{
    return a.GetProjection(b);
}
 
inline GfVec4f
GfGetComplement(GfVec4f const &a, GfVec4f const &b)
{
    return a.GetComplement(b);
}
 
inline bool
GfIsClose(GfVec4f const &v1, GfVec4f const &v2, double tolerance)
{
    GfVec4f delta = v1 - v2;
    return delta.GetLengthSq() <= tolerance * tolerance;
}
 
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_BASE_GF_VEC4F_H