matrix3.h

Go to the documentation of this file.

/*
    Sheep - A Rigid Body Dynamics Engine
    Copyright (C) 2001-2004 Francois Beaune
    Contact: http://toxicengine.sourceforge.net/

    This file is part of Sheep.

    Sheep is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    Sheep is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Sheep; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef SHEEP_MATH_MATRIX3_H
#define SHEEP_MATH_MATRIX3_H

#include "common/misc/htmlstream.h"
#include "quaternion.h"
#include "real.h"
#include "vector3.h"

#include <cassert>

namespace sheep {

    class Matrix3 {
    public:
        // Constructors.
        Matrix3();
        Matrix3(Real r);
        Matrix3(const Matrix3 &m);

        // Identity matrix.
        static Matrix3 Identity();

        // Transformations.
        static Matrix3 Rotation(const Quaternion &q);   // q must be normalized
        static Matrix3 Rotation(Real angle, const Vector3 &axis);
        static Matrix3 Rotation(Real rotx, Real roty, Real rotz);   //!< Order of rotations: X, then Y, then Z.
        static Matrix3 Scale(const Vector3 &s);

        void GetEulerAngles(Real *rotx, Real *roty, Real *rotz) const;

        // Assignment operators.
        Matrix3 &operator=(Real r);
        Matrix3 &operator=(const Matrix3 &m);

        // Basic operations.
        Matrix3 operator+(const Matrix3 &m) const;
        Matrix3 operator-(const Matrix3 &m) const;
        Matrix3 operator-() const;
        Matrix3 operator*(Real r) const;
        Matrix3 operator/(Real r) const;
        Matrix3 &operator+=(const Matrix3 &m);
        Matrix3 &operator-=(const Matrix3 &m);
        Matrix3 &operator*=(Real r);
        Matrix3 &operator/=(Real r);

        // Matrix products.
        Matrix3 operator*(const Matrix3 &m) const;
        Matrix3 &operator*=(const Matrix3 &m);

        // Product of a matrix and a vector.
        Vector3 operator*(const Vector3 &v) const;

        // Array subscripting.
        Real &operator[](int i);
        const Real &operator[](int i) const;

        // Fortran-style subscripting (still 0-based).
        Real &operator()(int row, int column);
        const Real &operator()(int row, int column) const;

        // Transpose.
        Matrix3 Transpose() const;

        // Inverse.
        Matrix3 Inverse() const;

        // Determinant.
        Real Determinant() const;

        // Trace.
        Real Trace() const;

    private:
        Real m_v[9];    // matrix values (row-major)
    };

    // Product of a real by a matrix.
    Matrix3 operator*(Real r, const Matrix3 &m);

    //! Deprecated.
    htmlstream& operator<<(htmlstream& s, const Matrix3 &m);

#include "matrix3.inl"

}

#endif  // !SHEEP_MATH_MATRIX3_H

---