Matrix4f.h

Go to the documentation of this file.

/* This file is part of the Zenipex Library (zenilib).
 * Copyright (C) 2011 Mitchell Keith Bloch (bazald).
 *
 * zenilib is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * zenilib 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with zenilib.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef ZENI_MATRIX_H
#define ZENI_MATRIX_H

#include <Zeni/Serialization.h>
#include <Zeni/Vector3f.h>
#include <vector>

namespace Zeni {

  struct ZENI_DLL Quaternion;

  class ZENI_DLL Matrix4f {
  public:
    class ZENI_DLL Matrix4f_Row {
    public:
      inline Matrix4f_Row(float * const &row_);

      inline const float & operator[](const int &index) const; 
      inline float & operator[](const int &index); 

    private:
      float *row;
    };

    Matrix4f();
    Matrix4f(
      const float &aw, const float &ax, const float &ay, const float &az,
      const float &bw, const float &bx, const float &by, const float &bz,
      const float &cw, const float &cx, const float &cy, const float &cz,
      const float &dw, const float &dx, const float &dy, const float &dz);
    Matrix4f(const Vector3f &first, const Vector3f &second, const Vector3f &third, const bool &rows = false);
    Matrix4f(const Matrix4f &rhs);

    // Indexing
    inline const Matrix4f_Row operator[](const int &index) const; 
    inline Matrix4f_Row operator[](const int &index); 

    // Fundamental Matrix Constructors
    inline static Matrix4f Zero();
    inline static Matrix4f Identity();
    inline static Matrix4f Scale(const Vector3f &scaling_factor);
    inline static Matrix4f Rotate(const Quaternion &rotation);
    inline static Matrix4f Translate(const Vector3f &translation_factor);
    inline static Matrix4f View(const Point3f &position, const Vector3f &forward, const Vector3f &up);
    inline static Matrix4f Orthographic(const float &left, const float &right, const float &bottom, const float &top, const float &near, const float &far);
    inline static Matrix4f Perspective(const float &fov_rad_y, const float &aspect, const float &near, const float &far);
    inline static Matrix4f Frustum(const Point2f &upper_left, const Point2f &lower_right, const float &near, const float &far);

    // Matrix addition/subtraction
    inline Matrix4f operator+(const Matrix4f &rhs) const; 
    inline Matrix4f operator-(const Matrix4f &rhs) const; 
    inline Matrix4f & operator+=(const Matrix4f &rhs); 
    inline Matrix4f & operator-=(const Matrix4f &rhs); 

    // Matrix Products
    inline Matrix4f operator*(const Matrix4f &rhs) const; 
    inline Matrix4f operator*=(const Matrix4f &rhs); 
    inline Matrix4f operator/(const Matrix4f &rhs) const; 
    inline Matrix4f operator/=(const Matrix4f &rhs); 

    // Matrix Scalar Operations
    inline Matrix4f operator*(const float &rhs) const; 
    inline Matrix4f operator/(const float &rhs) const; 
    inline Matrix4f & operator*=(const float &rhs); 
    inline Matrix4f & operator/=(const float &rhs); 
    inline Matrix4f operator-() const; 

    // Other Standard Functions
    Matrix4f & invert(); 
    Matrix4f inverted() const; 
    Matrix4f & transpose(); 
    Matrix4f transposed() const; 
    float determinant() const; 

    // Vector Functions
    inline Vector3f get_column(const int &column) const; 
    inline Vector3f get_row(const int &row) const; 
    Vector3f operator*(const Vector3f &vector) const; 

  private:
    float m_matrix[4][4];
  };

  ZENI_DLL std::ostream & serialize(std::ostream &os, const Matrix4f &value);
  ZENI_DLL std::istream & unserialize(std::istream &is, Matrix4f &value);

}

#endif