vec3h.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_VEC3H_H
#define PXR_BASE_GF_VEC3H_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/gf/half.h"

#include <boost/functional/hash.hpp>

#include <cstddef>
#include <cmath>

#include <iosfwd>

PXR_NAMESPACE_OPEN_SCOPE

class GfVec3h;

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

class GfVec3h
{
public:
    typedef GfHalf ScalarType;
    static const size_t dimension = 3;

    GfVec3h() = default;

    constexpr explicit GfVec3h(GfHalf value)
        : _data{ value, value, value }
    {
    }

    constexpr GfVec3h(GfHalf s0, GfHalf s1, GfHalf s2)
        : _data{ s0, s1, s2 }
    {
    }

    template <class Scl>
    constexpr explicit GfVec3h(Scl const *p)
        : _data{ p[0], p[1], p[2] }
    {
    }

    explicit GfVec3h(class GfVec3d const &other);

    explicit GfVec3h(class GfVec3f const &other);

    GfVec3h(class GfVec3i const &other);
 
    static GfVec3h XAxis() {
        GfVec3h result(0);
        result[0] = 1;
        return result;
    }
    static GfVec3h YAxis() {
        GfVec3h result(0);
        result[1] = 1;
        return result;
    }
    static GfVec3h ZAxis() {
        GfVec3h result(0);
        result[2] = 1;
        return result;
    }

    static GfVec3h Axis(size_t i) {
        GfVec3h result(0);
        if (i < 3)
            result[i] = 1;
        return result;
    }

    GfVec3h &Set(GfHalf s0, GfHalf s1, GfHalf s2) {
        _data[0] = s0;
        _data[1] = s1;
        _data[2] = s2;
        return *this;
    }

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

    GfHalf const *data() const { return _data; }
    GfHalf *data() { return _data; }
    GfHalf const *GetArray() const { return data(); }

    GfHalf const &operator[](size_t i) const { return _data[i]; }
    GfHalf &operator[](size_t i) { return _data[i]; }

    friend inline size_t hash_value(GfVec3h 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==(GfVec3h const &other) const {
        return _data[0] == other[0] &&
               _data[1] == other[1] &&
               _data[2] == other[2];
    }
    bool operator!=(GfVec3h 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 GfVec3f const &other) const;
    GF_API
    bool operator==(class GfVec3i const &other) const;
    
    GfVec3h operator-() const {
        return GfVec3h(-_data[0], -_data[1], -_data[2]);
    }

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

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

    GfVec3h &operator*=(double s) {
        _data[0] *= s;
        _data[1] *= s;
        _data[2] *= s;
        return *this;
    }
    GfVec3h operator*(double s) const {
        return GfVec3h(*this) *= s;
    }
    friend GfVec3h operator*(double s, GfVec3h const &v) {
        return v * s;
    }

    // TODO should divide by the scalar type.
    GfVec3h &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);
    }
    GfVec3h operator/(double s) const {
        return *this * (1.0 / s);
    }
    
    GfHalf operator*(GfVec3h const &v) const {
        return _data[0] * v[0] + _data[1] * v[1] + _data[2] * v[2];
    }

    GfVec3h GetProjection(GfVec3h const &v) const {
        return v * (*this * v);
    }

    GfVec3h GetComplement(GfVec3h const &b) const {
        return *this - this->GetProjection(b);
    }

    GfHalf GetLengthSq() const {
        return *this * *this;
    }

    GfHalf GetLength() const {
        return GfSqrt(GetLengthSq());
    }

    GfHalf Normalize(GfHalf eps = 0.001) {
        // TODO this seems suspect...  suggest dividing by length so long as
        // length is not zero.
        GfHalf length = GetLength();
        *this /= (length > eps) ? length : eps;
        return length;
    }

    GfVec3h GetNormalized(GfHalf eps = 0.001) const {
        GfVec3h normalized(*this);
        normalized.Normalize(eps);
        return normalized;
    }

    GF_API
    static bool OrthogonalizeBasis(
        GfVec3h *tx, GfVec3h *ty, GfVec3h *tz,
        const bool normalize,
        double eps = GF_MIN_ORTHO_TOLERANCE);

    GF_API
    void BuildOrthonormalFrame(GfVec3h *v1, GfVec3h *v2,
                    GfHalf eps = 0.001) const;

  
private:
    GfHalf _data[3];
};

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


PXR_NAMESPACE_CLOSE_SCOPE

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

PXR_NAMESPACE_OPEN_SCOPE

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

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

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

inline GfHalf
GfDot(GfVec3h const &v1, GfVec3h const &v2) {
    return v1 * v2;
}


inline GfHalf
GfGetLength(GfVec3h const &v)
{
    return v.GetLength();
}

inline GfHalf
GfNormalize(GfVec3h *v, GfHalf eps = 0.001)
{
    return v->Normalize(eps);
}

inline GfVec3h
GfGetNormalized(GfVec3h const &v, GfHalf eps = 0.001)
{
    return v.GetNormalized(eps);
}

inline GfVec3h
GfGetProjection(GfVec3h const &a, GfVec3h const &b)
{
    return a.GetProjection(b);
}

inline GfVec3h
GfGetComplement(GfVec3h const &a, GfVec3h const &b)
{
    return a.GetComplement(b);
}

inline bool
GfIsClose(GfVec3h const &v1, GfVec3h const &v2, double tolerance)
{
    GfVec3h delta = v1 - v2;
    return delta.GetLengthSq() <= tolerance * tolerance;
}


GF_API bool
GfOrthogonalizeBasis(GfVec3h *tx, GfVec3h *ty, GfVec3h *tz,
                     bool normalize, double eps = GF_MIN_ORTHO_TOLERANCE);

GF_API void
GfBuildOrthonormalFrame(GfVec3h const &v0,
                        GfVec3h* v1,
                        GfVec3h* v2,
                        GfHalf eps = 0.001);

inline GfVec3h
GfCross(GfVec3h const &v1, GfVec3h const &v2)
{
    return GfVec3h(
        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 GfVec3h
operator^(GfVec3h const &v1, GfVec3h const &v2)
{
    return GfCross(v1, v2);
}

GF_API GfVec3h
GfSlerp(double alpha, GfVec3h const &v0, GfVec3h const &v1);

 
 
PXR_NAMESPACE_CLOSE_SCOPE

#endif // PXR_BASE_GF_VEC3H_H