matrix3f.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
// matrix3.template.h file to make changes.
 
#ifndef PXR_BASE_GF_MATRIX3F_H
#define PXR_BASE_GF_MATRIX3F_H
 
 
#include "pxr/pxr.h"
#include "pxr/base/gf/api.h"
#include "pxr/base/gf/declare.h"
#include "pxr/base/gf/matrixData.h"
#include "pxr/base/gf/vec3f.h"
#include "pxr/base/gf/traits.h"
#include "pxr/base/tf/hash.h"
 
#include <iosfwd>
#include <vector>
 
PXR_NAMESPACE_OPEN_SCOPE
 
template <>
struct GfIsGfMatrix<class GfMatrix3f> { static const bool value = true; };
 
class GfMatrix3d;
class GfMatrix3f;
class GfRotation;
class GfQuaternion;
class GfQuatf;
 
class GfMatrix3f
{
public:
    typedef float ScalarType;
 
    static const size_t numRows = 3;
    static const size_t numColumns = 3;
 
    GfMatrix3f() = default;
 
    GfMatrix3f(float m00, float m01, float m02, 
               float m10, float m11, float m12, 
               float m20, float m21, float m22) {
        Set(m00, m01, m02, 
            m10, m11, m12, 
            m20, m21, m22);
    }
 
    GfMatrix3f(const float m[3][3]) {
        Set(m);
    }
 
    explicit GfMatrix3f(float s) {
        SetDiagonal(s);
    }
 
    explicit GfMatrix3f(int s) {
        SetDiagonal(s);
    }
 
    explicit GfMatrix3f(const GfVec3f& v) {
        SetDiagonal(v);
    }
 
    GF_API
    explicit GfMatrix3f(const std::vector< std::vector<double> >& v);
 
    GF_API
    explicit GfMatrix3f(const std::vector< std::vector<float> >& v);
 
    GF_API
    GfMatrix3f(const GfRotation& rot);
 
    GF_API
    explicit GfMatrix3f(const GfQuatf& rot);
 
    GF_API
    explicit GfMatrix3f(const class GfMatrix3d& m);
 
    void SetRow(int i, const GfVec3f & v) {
        _mtx[i][0] = v[0];
        _mtx[i][1] = v[1];
        _mtx[i][2] = v[2];
    }
 
    void SetColumn(int i, const GfVec3f & v) {
        _mtx[0][i] = v[0];
        _mtx[1][i] = v[1];
        _mtx[2][i] = v[2];
    }
 
    GfVec3f GetRow(int i) const {
        return GfVec3f(_mtx[i][0], _mtx[i][1], _mtx[i][2]);
    }
 
    GfVec3f GetColumn(int i) const {
        return GfVec3f(_mtx[0][i], _mtx[1][i], _mtx[2][i]);
    }
 
    GfMatrix3f& Set(float m00, float m01, float m02, 
                    float m10, float m11, float m12, 
                    float m20, float m21, float m22) {
        _mtx[0][0] = m00; _mtx[0][1] = m01; _mtx[0][2] = m02; 
        _mtx[1][0] = m10; _mtx[1][1] = m11; _mtx[1][2] = m12; 
        _mtx[2][0] = m20; _mtx[2][1] = m21; _mtx[2][2] = m22;
        return *this;
    }
 
    GfMatrix3f& Set(const float m[3][3]) {
        _mtx[0][0] = m[0][0];
        _mtx[0][1] = m[0][1];
        _mtx[0][2] = m[0][2];
        _mtx[1][0] = m[1][0];
        _mtx[1][1] = m[1][1];
        _mtx[1][2] = m[1][2];
        _mtx[2][0] = m[2][0];
        _mtx[2][1] = m[2][1];
        _mtx[2][2] = m[2][2];
        return *this;
    }
 
    GfMatrix3f& SetIdentity() {
        return SetDiagonal(1);
    }
 
    GfMatrix3f& SetZero() {
        return SetDiagonal(0);
    }
 
    GF_API
    GfMatrix3f& SetDiagonal(float s);
 
    GF_API
    GfMatrix3f& SetDiagonal(const GfVec3f&);
 
    GF_API
    float* Get(float m[3][3]) const;
 
    float* data() {
        return _mtx.GetData();
    }
 
    const float* data() const {
        return _mtx.GetData();
    }
 
    float* GetArray()  {
        return _mtx.GetData();
    }
 
    const float* GetArray() const {
        return _mtx.GetData();
    }
 
    float* operator [](int i) { return _mtx[i]; }
 
    const float* operator [](int i) const { return _mtx[i]; }
 
    friend inline size_t hash_value(GfMatrix3f const &m) {
        return TfHash::Combine(
            m._mtx[0][0],
            m._mtx[0][1],
            m._mtx[0][2],
            m._mtx[1][0],
            m._mtx[1][1],
            m._mtx[1][2],
            m._mtx[2][0],
            m._mtx[2][1],
            m._mtx[2][2]
        );
    }
 
    GF_API
    bool operator ==(const GfMatrix3d& m) const;
 
    GF_API
    bool operator ==(const GfMatrix3f& m) const;
 
    bool operator !=(const GfMatrix3d& m) const {
        return !(*this == m);
    }
 
    bool operator !=(const GfMatrix3f& m) const {
        return !(*this == m);
    }
 
    GF_API
    GfMatrix3f GetTranspose() const;
 
    GF_API
    GfMatrix3f GetInverse(double* det = NULL, double eps = 0) const;
 
    GF_API
    double GetDeterminant() const;
 
    GF_API
    bool Orthonormalize(bool issueWarning=true);
 
    GF_API
    GfMatrix3f GetOrthonormalized(bool issueWarning=true) const;
 
    GF_API
    double GetHandedness() const;
 
    bool IsRightHanded() const {
        return GetHandedness() == 1.0;
    }
 
    bool IsLeftHanded() const {
        return GetHandedness() == -1.0;
    }
 
    GF_API
    GfMatrix3f& operator *=(const GfMatrix3f& m);
 
    GF_API
    GfMatrix3f& operator *=(double);
 
    friend GfMatrix3f operator *(const GfMatrix3f& m1, double d)
    {
        GfMatrix3f m = m1;
        return m *= d;
    }
 
    // Returns the product of a matrix and a float.
    friend GfMatrix3f operator *(double d, const GfMatrix3f& m)
    {
        return m * d;
    }
 
    GF_API
    GfMatrix3f& operator +=(const GfMatrix3f& m);
 
    GF_API
    GfMatrix3f& operator -=(const GfMatrix3f& m);
 
    GF_API
    friend GfMatrix3f operator -(const GfMatrix3f& m);
 
    friend GfMatrix3f operator +(const GfMatrix3f& m1, const GfMatrix3f& m2)
    {
        GfMatrix3f tmp(m1);
        tmp += m2;
        return tmp;
    }
 
    friend GfMatrix3f operator -(const GfMatrix3f& m1, const GfMatrix3f& m2)
    {
        GfMatrix3f tmp(m1);
        tmp -= m2;
        return tmp;
    }
 
    friend GfMatrix3f operator *(const GfMatrix3f& m1, const GfMatrix3f& m2)
    {
        GfMatrix3f tmp(m1);
        tmp *= m2;
        return tmp;
    }
 
    friend GfMatrix3f operator /(const GfMatrix3f& m1, const GfMatrix3f& m2)
    {
        return(m1 * m2.GetInverse());
    }
 
    friend inline GfVec3f operator *(const GfMatrix3f& m, const GfVec3f& vec) {
        return GfVec3f(vec[0] * m._mtx[0][0] + vec[1] * m._mtx[0][1] + vec[2] * m._mtx[0][2],
                       vec[0] * m._mtx[1][0] + vec[1] * m._mtx[1][1] + vec[2] * m._mtx[1][2],
                       vec[0] * m._mtx[2][0] + vec[1] * m._mtx[2][1] + vec[2] * m._mtx[2][2]);
    }
 
    friend inline GfVec3f operator *(const GfVec3f &vec, const GfMatrix3f& m) {
        return GfVec3f(vec[0] * m._mtx[0][0] + vec[1] * m._mtx[1][0] + vec[2] * m._mtx[2][0],
                       vec[0] * m._mtx[0][1] + vec[1] * m._mtx[1][1] + vec[2] * m._mtx[2][1],
                       vec[0] * m._mtx[0][2] + vec[1] * m._mtx[1][2] + vec[2] * m._mtx[2][2]);
    }
 
    GF_API
    GfMatrix3f& SetScale(float scaleFactor);
 
 
    GF_API
    GfMatrix3f& SetRotate(const GfQuatf &rot);
 
    GF_API
    GfMatrix3f& SetRotate(const GfRotation &rot);
 
    GF_API
    GfMatrix3f& SetScale(const GfVec3f &scaleFactors);
 
    GF_API
    GfRotation ExtractRotation() const;
 
    GF_API
    GfVec3f DecomposeRotation(const GfVec3f &axis0,
                              const GfVec3f &axis1,
                              const GfVec3f &axis2 ) const;
 
    GF_API
    GfQuaternion ExtractRotationQuaternion() const;
 
 
private:
    void _SetRotateFromQuat(float r, const GfVec3f& i);
 
 
private:
    GfMatrixData<float, 3, 3> _mtx;
 
    // Friend declarations
    friend class GfMatrix3d;
};
 
 
GF_API 
bool GfIsClose(GfMatrix3f const &m1, GfMatrix3f const &m2, double tolerance);
 
GF_API std::ostream& operator<<(std::ostream &, GfMatrix3f const &);
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_BASE_GF_MATRIX3F_H