git.sesse.net Git - casparcg/blob - dependencies64/sfml/include/SFML/Graphics/Matrix3.hpp

   1 ////////////////////////////////////////////////////////////
   2 //
   3 // SFML - Simple and Fast Multimedia Library
   4 // Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)
   5 //
   6 // This software is provided 'as-is', without any express or implied warranty.
   7 // In no event will the authors be held liable for any damages arising from the use of this software.
   8 //
   9 // Permission is granted to anyone to use this software for any purpose,
  10 // including commercial applications, and to alter it and redistribute it freely,
  11 // subject to the following restrictions:
  12 //
  13 // 1. The origin of this software must not be misrepresented;
  14 //    you must not claim that you wrote the original software.
  15 //    If you use this software in a product, an acknowledgment
  16 //    in the product documentation would be appreciated but is not required.
  17 //
  18 // 2. Altered source versions must be plainly marked as such,
  19 //    and must not be misrepresented as being the original software.
  20 //
  21 // 3. This notice may not be removed or altered from any source distribution.
  22 //
  23 ////////////////////////////////////////////////////////////
  24
  25 #ifndef SFML_MATRIX3_HPP
  26 #define SFML_MATRIX3_HPP
  27
  28 ////////////////////////////////////////////////////////////
  29 // Headers
  30 ////////////////////////////////////////////////////////////
  31 #include <SFML/Config.hpp>
  32 #include <SFML/System/Vector2.hpp>
  33 #include <math.h>
  34
  35
  36 namespace sf
  37 {
  38 ////////////////////////////////////////////////////////////
  39 /// Utility class to manipulate 3x3 matrices representing
  40 /// 2D transformations
  41 ////////////////////////////////////////////////////////////
  42 class SFML_API Matrix3
  43 {
  44 public :
  45
  46     ////////////////////////////////////////////////////////////
  47     /// Default constructor (builds an identity matrix)
  48     ///
  49     ////////////////////////////////////////////////////////////
  50     Matrix3();
  51
  52     ////////////////////////////////////////////////////////////
  53     /// Construct a matrix from its 9 elements
  54     ///
  55     ////////////////////////////////////////////////////////////
  56     Matrix3(float a00, float a01, float a02,
  57             float a10, float a11, float a12,
  58             float a20, float a21, float a22);
  59
  60     ////////////////////////////////////////////////////////////
  61     /// Build a matrix from a set of transformations
  62     ///
  63     /// \param Center :      Origin for the transformations
  64     /// \param Translation : Translation offset
  65     /// \param Rotation :    Rotation angle in degrees
  66     /// \param Scale :       Scaling factors
  67     ///
  68     ////////////////////////////////////////////////////////////
  69     void SetFromTransformations(const Vector2f& Center, const Vector2f& Translation, float Rotation, const Vector2f& Scale);
  70
  71     ////////////////////////////////////////////////////////////
  72     /// Transform a point by the matrix
  73     ///
  74     /// \param Point : Point to transform
  75     ///
  76     /// \return Transformed point
  77     ///
  78     ////////////////////////////////////////////////////////////
  79     Vector2f Transform(const Vector2f& Point) const;
  80
  81     ////////////////////////////////////////////////////////////
  82     /// Return the inverse of the matrix
  83     ///
  84     /// \return A new matrix which is the inverse of this
  85     ///
  86     ////////////////////////////////////////////////////////////
  87     Matrix3 GetInverse() const;
  88
  89     ////////////////////////////////////////////////////////////
  90     /// Return the elements of the matrix as a 4x4,
  91     /// in an array of 16 floats
  92     ///
  93     /// \return Pointer to the 4x4 matrix elements
  94     ///
  95     ////////////////////////////////////////////////////////////
  96     const float* Get4x4Elements() const;
  97
  98     ////////////////////////////////////////////////////////////
  99     /// Operator () overloads to access the matrix elements
 100     ///
 101     /// \param Row : Element row (0 based)
 102     /// \param Col : Element column (0 based)
 103     ///
 104     /// \return Matrix element (Row, Col)
 105     ///
 106     ////////////////////////////////////////////////////////////
 107     float  operator ()(unsigned int Row, unsigned int Col) const;
 108     float& operator ()(unsigned int Row, unsigned int Col);
 109
 110     ////////////////////////////////////////////////////////////
 111     /// Operator * overload to multiply two matrices
 112     ///
 113     /// \param Mat : Matrix to multiply
 114     ///
 115     /// \return this * Mat
 116     ///
 117     ////////////////////////////////////////////////////////////
 118     Matrix3 operator *(const Matrix3& Mat) const;
 119
 120     ////////////////////////////////////////////////////////////
 121     /// Operator *= overload to multiply-assign two matrices
 122     ///
 123     /// \param Mat : Matrix to multiply
 124     ///
 125     /// \return this * Mat
 126     ///
 127     ////////////////////////////////////////////////////////////
 128     Matrix3& operator *=(const Matrix3& Mat);
 129
 130     ////////////////////////////////////////////////////////////
 131     // Static member data
 132     ////////////////////////////////////////////////////////////
 133     static const Matrix3 Identity; ///< Identity matrix
 134
 135 private :
 136
 137     ////////////////////////////////////////////////////////////
 138     // Member data
 139     ////////////////////////////////////////////////////////////
 140     float myData[16]; /// Matrix elements (we directly store it as a 4x4 matrix for optimization purpose)
 141 };
 142
 143 #include <SFML/Graphics/Matrix3.inl>
 144
 145 } // namespace sf
 146
 147
 148 #endif // SFML_MATRIX3_HPP