summaryrefslogtreecommitdiff
path: root/include/SFML/Graphics/.svn/text-base/Matrix3.hpp.svn-base
blob: 2d1ea745340262bc810616f6ea7d6057d9be79d2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
////////////////////////////////////////////////////////////
//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2008 Laurent Gomila (laurent.gom@gmail.com)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
////////////////////////////////////////////////////////////

#ifndef SFML_MATRIX3_HPP
#define SFML_MATRIX3_HPP

////////////////////////////////////////////////////////////
// Headers
////////////////////////////////////////////////////////////
#include <SFML/Config.hpp>
#include <SFML/System/Vector2.hpp>
#include <math.h>


namespace sf
{
////////////////////////////////////////////////////////////
/// Utility class to manipulate 3x3 matrices representing
/// 2D transformations
////////////////////////////////////////////////////////////
class SFML_API Matrix3
{
public :

    ////////////////////////////////////////////////////////////
    /// Default constructor (builds an identity matrix)
    ///
    ////////////////////////////////////////////////////////////
    Matrix3();

    ////////////////////////////////////////////////////////////
    /// Construct a matrix from its 9 elements
    ///
    ////////////////////////////////////////////////////////////
    Matrix3(float a00, float a01, float a02,
            float a10, float a11, float a12,
            float a20, float a21, float a22);

    ////////////////////////////////////////////////////////////
    /// Build a matrix from a set of transformations
    ///
    /// \param Center :      Origin for the transformations
    /// \param Translation : Translation offset
    /// \param Rotation :    Rotation angle in degrees
    /// \param Scale :       Scaling factors
    ///
    ////////////////////////////////////////////////////////////
    void SetFromTransformations(const Vector2f& Center, const Vector2f& Translation, float Rotation, const Vector2f& Scale);

    ////////////////////////////////////////////////////////////
    /// Transform a point by the matrix
    ///
    /// \param Point : Point to transform
    ///
    /// \return Transformed point
    ///
    ////////////////////////////////////////////////////////////
    Vector2f Transform(const Vector2f& Point) const;

    ////////////////////////////////////////////////////////////
    /// Return the inverse of the matrix
    ///
    /// \return A new matrix which is the inverse of this
    ///
    ////////////////////////////////////////////////////////////
    Matrix3 GetInverse() const;

    ////////////////////////////////////////////////////////////
    /// Return the elements of the matrix as a 4x4,
    /// in an array of 16 floats
    ///
    /// \return Pointer to the 4x4 matrix elements
    ///
    ////////////////////////////////////////////////////////////
    const float* Get4x4Elements() const;

    ////////////////////////////////////////////////////////////
    /// Operator () overloads to access the matrix elements
    ///
    /// \param Row : Element row (0 based)
    /// \param Col : Element column (0 based)
    ///
    /// \return Matrix element (Row, Col)
    ///
    ////////////////////////////////////////////////////////////
    float  operator ()(unsigned int Row, unsigned int Col) const;
    float& operator ()(unsigned int Row, unsigned int Col);

    ////////////////////////////////////////////////////////////
    /// Operator * overload to multiply two matrices
    ///
    /// \param Mat : Matrix to multiply
    ///
    /// \return this * Mat
    ///
    ////////////////////////////////////////////////////////////
    Matrix3 operator *(const Matrix3& Mat) const;

    ////////////////////////////////////////////////////////////
    /// Operator *= overload to multiply-assign two matrices
    ///
    /// \param Mat : Matrix to multiply
    ///
    /// \return this * Mat
    ///
    ////////////////////////////////////////////////////////////
    Matrix3& operator *=(const Matrix3& Mat);

    ////////////////////////////////////////////////////////////
    // Static member data
    ////////////////////////////////////////////////////////////
    static const Matrix3 Identity; ///< Identity matrix

private :

    ////////////////////////////////////////////////////////////
    // Member data
    ////////////////////////////////////////////////////////////
    float myData[16]; /// Matrix elements (we directly store it as a 4x4 matrix for optimization purpose)
};

#include <SFML/Graphics/Matrix3.inl>

} // namespace sf


#endif // SFML_MATRIX3_HPP