vec3f.h

Go to the documentation of this file.

//
// Copyright 2016 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache 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/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 <boost/functional/hash.hpp>

#include <cstddef>
#include <cmath>

#include <iosfwd>

PXR_NAMESPACE_OPEN_SCOPE

class GfVec3f;

template <>
struct GfIsGfVec<class GfVec3f> { static const bool value = true; };

class GfVec3f
{
public:
    typedef float ScalarType;
    static const size_t dimension = 3;

    GfVec3f() = default;

    constexpr explicit GfVec3f(float value)
        : _data{ value, value, value }
    {
    }

    constexpr GfVec3f(float s0, float s1, float s2)
        : _data{ s0, s1, s2 }
    {
    }

    template <class Scl>
    constexpr explicit GfVec3f(Scl const *p)
        : _data{ p[0], p[1], 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) {
        _data[0] = s0;
        _data[1] = s1;
        _data[2] = s2;
        return *this;
    }

    GfVec3f &Set(float const *a) {
        return Set(a[0], a[1], a[2]);
    }

    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(GfVec3f const &vec) {
        size_t h = 0;
        boost::hash_combine(h, vec[0]);
        boost::hash_combine(h, vec[1]);
        boost::hash_combine(h, vec[2]);
        return h;
    }

    bool operator==(GfVec3f const &other) const {
        return _data[0] == other[0] &&
               _data[1] == other[1] &&
               _data[2] == other[2];
    }
    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(-_data[0], -_data[1], -_data[2]);
    }

    GfVec3f &operator+=(GfVec3f const &other) {
        _data[0] += other[0];
        _data[1] += other[1];
        _data[2] += other[2];
        return *this;
    }
    friend GfVec3f operator+(GfVec3f const &l, GfVec3f const &r) {
        return GfVec3f(l) += r;
    }

    GfVec3f &operator-=(GfVec3f const &other) {
        _data[0] -= other[0];
        _data[1] -= other[1];
        _data[2] -= other[2];
        return *this;
    }
    friend GfVec3f operator-(GfVec3f const &l, GfVec3f const &r) {
        return GfVec3f(l) -= r;
    }

    GfVec3f &operator*=(double s) {
        _data[0] *= s;
        _data[1] *= s;
        _data[2] *= 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 _data[0] * v[0] + _data[1] * v[1] + _data[2] * v[2];
    }

    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;

  
private:
    float _data[3];
};

GF_API std::ostream& operator<<(std::ostream &, GfVec3f const &);


PXR_NAMESPACE_CLOSE_SCOPE

#include "pxr/base/gf/vec3d.h"
#include "pxr/base/gf/vec3h.h"
#include "pxr/base/gf/vec3i.h"

PXR_NAMESPACE_OPEN_SCOPE

inline
GfVec3f::GfVec3f(class GfVec3d const &other)
{
    _data[0] = other[0];
    _data[1] = other[1];
    _data[2] = other[2];
}
inline
GfVec3f::GfVec3f(class GfVec3h const &other)
{
    _data[0] = other[0];
    _data[1] = other[1];
    _data[2] = other[2];
}
inline
GfVec3f::GfVec3f(class GfVec3i const &other)
{
    _data[0] = other[0];
    _data[1] = other[1];
    _data[2] = other[2];
}

inline GfVec3f
GfCompMult(GfVec3f const &v1, GfVec3f const &v2) {
    return GfVec3f(
        v1[0] * v2[0],
        v1[1] * v2[1],
        v1[2] * v2[2]
        );
}

inline GfVec3f
GfCompDiv(GfVec3f const &v1, GfVec3f const &v2) {
    return GfVec3f(
        v1[0] / v2[0],
        v1[1] / v2[1],
        v1[2] / v2[2]
        );
}

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[1] * v2[2] - v1[2] * v2[1],
        v1[2] * v2[0] - v1[0] * v2[2],
        v1[0] * v2[1] - v1[1] * v2[0]);
}

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