vec3i.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_VEC3I_H
#define PXR_BASE_GF_VEC3I_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/tf/diagnostic.h"
#include "pxr/base/tf/hash.h"
 
#include <cstddef>
#include <type_traits>
 
#include <iosfwd>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class GfVec2i;
 
template <>
struct GfIsGfVec<class GfVec3i> { static const bool value = true; };
 
class GfVec3i
{
public:
    typedef int ScalarType;
    static const size_t dimension = 3;
 
    int x, y, z;
 
    GfVec3i() = default;
 
    constexpr explicit GfVec3i(int value)
        : x(value), y(value), z(value)
    {
    }
 
    constexpr GfVec3i(int s0, int s1, int s2)
        : x(s0), y(s1), z(s2)
    {
    }
 
    template <class Scl>
    constexpr explicit GfVec3i(Scl const *p)
        : x(p[0]), y(p[1]), z(p[2])
    {
    }
    static GfVec3i XAxis() {
        GfVec3i result(0);
        result[0] = 1;
        return result;
    }
 
    static GfVec3i YAxis() {
        GfVec3i result(0);
        result[1] = 1;
        return result;
    }
 
    static GfVec3i ZAxis() {
        GfVec3i result(0);
        result[2] = 1;
        return result;
    }
 
    static GfVec3i Axis(size_t i) {
        GfVec3i result(0);
        if (i < 3)
            result[i] = 1;
        return result;
    }
 
    GfVec3i &Set(int s0, int s1, int s2) {
        x = s0;
        y = s1;
        z = s2;
        return *this;
    }
 
    GfVec3i &Set(int const *a) {
        return Set(a[0], a[1], a[2]);
    }
 
    int const *data() const { return &x; }
    int *data() { return &x; }
    int const *GetArray() const { return data(); }
 
    int const &operator[](size_t i) const { return data()[i]; }
    int &operator[](size_t i) { return data()[i]; }
 
    friend inline size_t hash_value(GfVec3i const &vec) {
        return TfHash::Combine(vec.x, vec.y, vec.z);
    }
 
    bool operator==(GfVec3i const &other) const {
        return x == other.x &&
               y == other.y &&
               z == other.z;
    }
    bool operator!=(GfVec3i 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 GfVec3h const &other) const;
    
    GfVec3i operator-() const {
        return GfVec3i(-x, -y, -z);
    }
 
    GfVec3i &operator+=(GfVec3i const &other) {
        x += other.x;
        y += other.y;
        z += other.z;
        return *this;
    }
    friend GfVec3i operator+(GfVec3i const &l, GfVec3i const &r) {
        return GfVec3i(l) += r;
    }
 
    GfVec3i &operator-=(GfVec3i const &other) {
        x -= other.x;
        y -= other.y;
        z -= other.z;
        return *this;
    }
    friend GfVec3i operator-(GfVec3i const &l, GfVec3i const &r) {
        return GfVec3i(l) -= r;
    }
 
    GfVec3i &operator*=(double s) {
        x *= s;
        y *= s;
        z *= s;
        return *this;
    }
    GfVec3i operator*(double s) const {
        return GfVec3i(*this) *= s;
    }
    friend GfVec3i operator*(double s, GfVec3i const &v) {
        return v * s;
    }
 
    GfVec3i &operator/=(int s) {
        x /= s;
        y /= s;
        z /= s;
        return *this;
    }
    GfVec3i operator/(int s) const {
        return GfVec3i(*this) /= s;
    }
    
    int operator*(GfVec3i const &v) const {
        return x * v.x + y * v.y + z * v.z;
    }
 
    GfVec3i GetProjection(GfVec3i const &v) const {
        return v * (*this * v);
    }
 
    GfVec3i GetComplement(GfVec3i const &b) const {
        return *this - this->GetProjection(b);
    }
 
    int GetLengthSq() const {
        return *this * *this;
    }
 
 
#if defined (doxygen)
    constexpr GfVec2i xy() const;
    constexpr GfVec2i xz() const;
    constexpr GfVec2i yx() const;
    constexpr GfVec2i yz() const;
    constexpr GfVec2i zx() const;
    constexpr GfVec2i zy() const;
    constexpr GfVec3i xyz() const;
    constexpr GfVec3i xzy() const;
    constexpr GfVec3i yxz() const;
    constexpr GfVec3i yzx() const;
    constexpr GfVec3i zxy() const;
    constexpr GfVec3i 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 = GfVec2i> constexpr Vec xy() const;
    template <class Vec = GfVec2i> constexpr Vec xz() const;
    template <class Vec = GfVec2i> constexpr Vec yx() const;
    template <class Vec = GfVec2i> constexpr Vec yz() const;
    template <class Vec = GfVec2i> constexpr Vec zx() const;
    template <class Vec = GfVec2i> constexpr Vec zy() const;
    template <class Vec = GfVec3i> constexpr Vec xyz() const;
    template <class Vec = GfVec3i> constexpr Vec xzy() const;
    template <class Vec = GfVec3i> constexpr Vec yxz() const;
    template <class Vec = GfVec3i> constexpr Vec yzx() const;
    template <class Vec = GfVec3i> constexpr Vec zxy() const;
    template <class Vec = GfVec3i> constexpr Vec zyx() const;
#endif // doxygen
 };
 
GF_API std::ostream& operator<<(std::ostream &, GfVec3i const &);
 
PXR_NAMESPACE_CLOSE_SCOPE
 
// 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/vec2i.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
 
template <class Vec>
constexpr Vec
GfVec3i::xy() const
{
    static_assert(std::is_same<Vec, GfVec2i>::value);
    return Vec(x, y);
}
 
template <class Vec>
constexpr Vec
GfVec3i::xz() const
{
    static_assert(std::is_same<Vec, GfVec2i>::value);
    return Vec(x, z);
}
 
template <class Vec>
constexpr Vec
GfVec3i::yx() const
{
    static_assert(std::is_same<Vec, GfVec2i>::value);
    return Vec(y, x);
}
 
template <class Vec>
constexpr Vec
GfVec3i::yz() const
{
    static_assert(std::is_same<Vec, GfVec2i>::value);
    return Vec(y, z);
}
 
template <class Vec>
constexpr Vec
GfVec3i::zx() const
{
    static_assert(std::is_same<Vec, GfVec2i>::value);
    return Vec(z, x);
}
 
template <class Vec>
constexpr Vec
GfVec3i::zy() const
{
    static_assert(std::is_same<Vec, GfVec2i>::value);
    return Vec(z, y);
}
 
template <class Vec>
constexpr Vec
GfVec3i::xyz() const
{
    static_assert(std::is_same<Vec, GfVec3i>::value);
    return Vec(x, y, z);
}
 
template <class Vec>
constexpr Vec
GfVec3i::xzy() const
{
    static_assert(std::is_same<Vec, GfVec3i>::value);
    return Vec(x, z, y);
}
 
template <class Vec>
constexpr Vec
GfVec3i::yxz() const
{
    static_assert(std::is_same<Vec, GfVec3i>::value);
    return Vec(y, x, z);
}
 
template <class Vec>
constexpr Vec
GfVec3i::yzx() const
{
    static_assert(std::is_same<Vec, GfVec3i>::value);
    return Vec(y, z, x);
}
 
template <class Vec>
constexpr Vec
GfVec3i::zxy() const
{
    static_assert(std::is_same<Vec, GfVec3i>::value);
    return Vec(z, x, y);
}
 
template <class Vec>
constexpr Vec
GfVec3i::zyx() const
{
    static_assert(std::is_same<Vec, GfVec3i>::value);
    return Vec(z, y, x);
}
 
 
inline GfVec3i
GfCompMult(GfVec3i const &v1, GfVec3i const &v2) {
    return GfVec3i(
        v1.x * v2.x,
        v1.y * v2.y,
        v1.z * v2.z
        );
}
 
inline GfVec3i
GfCompDiv(GfVec3i const &v1, GfVec3i const &v2) {
    return GfVec3i(
        v1.x / v2.x,
        v1.y / v2.y,
        v1.z / v2.z
        );
}
 
inline int
GfDot(GfVec3i const &v1, GfVec3i const &v2) {
    return v1 * v2;
}
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_BASE_GF_VEC3I_H