<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <title>SFML - Simple and Fast Multimedia Library</title> <meta http-equiv="Content-Type" content="text/html;charset=UTF-8" /> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="tabs.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="logo"> <img src="./logo.jpg" width="770" height="200" title="SFML home" alt="SFML logo" /> </div> <!-- Generated by Doxygen 1.6.3 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.htm"><span>Main Page</span></a></li> <li><a href="modules.htm"><span>Modules</span></a></li> <li class="current"><a href="annotated.htm"><span>Classes</span></a></li> <li><a href="files.htm"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.htm"><span>Class List</span></a></li> <li><a href="classes.htm"><span>Class Index</span></a></li> <li><a href="hierarchy.htm"><span>Class Hierarchy</span></a></li> <li><a href="functions.htm"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><b>sf</b>::<a class="el" href="classsf_1_1Matrix3.htm">Matrix3</a> </div> </div> <div class="contents"> <h1>sf::Matrix3 Class Reference<br/> <small> [<a class="el" href="group__graphics.htm">Graphics module</a>]</small> </h1><!-- doxytag: class="sf::Matrix3" --> <p>Utility class to manipulate 3x3 matrices of floats. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="Matrix3_8hpp_source.htm">Matrix3.hpp</a>></code></p> <p><a href="classsf_1_1Matrix3-members.htm">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Matrix3.htm#ac91b75704a916deb3febe39e06962b4c">Matrix3</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#ac91b75704a916deb3febe39e06962b4c"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Matrix3.htm#ae0dc2db05f945d1e170f6d540193b309">Matrix3</a> (float a00, float a01, float a02, float a10, float a11, float a12, float a20, float a21, float a22)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a matrix from its 9 elements. <a href="#ae0dc2db05f945d1e170f6d540193b309"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Vector2.htm">Vector2f</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Matrix3.htm#ac2b449b387f2e537833f6444d19b0bb4">Transform</a> (const <a class="el" href="classsf_1_1Vector2.htm">Vector2f</a> &point) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Transform a point by the matrix. <a href="#ac2b449b387f2e537833f6444d19b0bb4"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Matrix3.htm">Matrix3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Matrix3.htm#afa7b544f401812b55ace055043385e8e">GetInverse</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the inverse of the matrix. <a href="#afa7b544f401812b55ace055043385e8e"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const float * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Matrix3.htm#aff23cbd3d056d404a566a62dea4c98c1">Get4x4Elements</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the elements of the matrix. <a href="#aff23cbd3d056d404a566a62dea4c98c1"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Matrix3.htm">Matrix3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Matrix3.htm#a6f460e6fbe5f4f838c00424426959b00">operator*</a> (const <a class="el" href="classsf_1_1Matrix3.htm">Matrix3</a> &right) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Overload of binary operator *. <a href="#a6f460e6fbe5f4f838c00424426959b00"></a><br/></td></tr> <tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classsf_1_1Matrix3.htm">Matrix3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Matrix3.htm#a642c6b3ff82e738a013b841dd23566d8">Transformation</a> (const <a class="el" href="classsf_1_1Vector2.htm">Vector2f</a> &origin, const <a class="el" href="classsf_1_1Vector2.htm">Vector2f</a> &translation, float rotation, const <a class="el" href="classsf_1_1Vector2.htm">Vector2f</a> &scale)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Build a matrix from a set of transformations. <a href="#a642c6b3ff82e738a013b841dd23566d8"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classsf_1_1Matrix3.htm">Matrix3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Matrix3.htm#aec437ecfc6381d6845fc639acb71597e">Projection</a> (const <a class="el" href="classsf_1_1Vector2.htm">Vector2f</a> &center, const <a class="el" href="classsf_1_1Vector2.htm">Vector2f</a> &size, float rotation)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Build a 2D project matrix. <a href="#aec437ecfc6381d6845fc639acb71597e"></a><br/></td></tr> <tr><td colspan="2"><h2>Static Public Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classsf_1_1Matrix3.htm">Matrix3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Matrix3.htm#afa5a43545e529d8b8628ca42289ef40a">Identity</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The identity matrix. <a href="#afa5a43545e529d8b8628ca42289ef40a"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Utility class to manipulate 3x3 matrices of floats. </p> <p><a class="el" href="classsf_1_1Matrix3.htm" title="Utility class to manipulate 3x3 matrices of floats.">Matrix3</a> is only meant for internal use, its interface is limited and its implementation is optimized for OpenGL rendering.</p> <p>This type is not used at all in the public API of SFML. </p> <p>Definition at line <a class="el" href="Matrix3_8hpp_source.htm#l00043">43</a> of file <a class="el" href="Matrix3_8hpp_source.htm">Matrix3.hpp</a>.</p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="ac91b75704a916deb3febe39e06962b4c"></a><!-- doxytag: member="sf::Matrix3::Matrix3" ref="ac91b75704a916deb3febe39e06962b4c" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">sf::Matrix3::Matrix3 </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Default constructor. </p> <p>This constructor creates an identity matrix. </p> </div> </div> <a class="anchor" id="ae0dc2db05f945d1e170f6d540193b309"></a><!-- doxytag: member="sf::Matrix3::Matrix3" ref="ae0dc2db05f945d1e170f6d540193b309" args="(float a00, float a01, float a02, float a10, float a11, float a12, float a20, float a21, float a22)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">sf::Matrix3::Matrix3 </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"> <em>a00</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"> <em>a01</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"> <em>a02</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"> <em>a10</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"> <em>a11</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"> <em>a12</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"> <em>a20</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"> <em>a21</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"> <em>a22</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Construct a matrix from its 9 elements. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>a00</em> </td><td>Element (0, 0) of the matrix </td></tr> <tr><td valign="top"></td><td valign="top"><em>a01</em> </td><td>Element (0, 1) of the matrix </td></tr> <tr><td valign="top"></td><td valign="top"><em>a02</em> </td><td>Element (0, 2) of the matrix </td></tr> <tr><td valign="top"></td><td valign="top"><em>a10</em> </td><td>Element (1, 0) of the matrix </td></tr> <tr><td valign="top"></td><td valign="top"><em>a11</em> </td><td>Element (1, 1) of the matrix </td></tr> <tr><td valign="top"></td><td valign="top"><em>a12</em> </td><td>Element (1, 2) of the matrix </td></tr> <tr><td valign="top"></td><td valign="top"><em>a20</em> </td><td>Element (2, 0) of the matrix </td></tr> <tr><td valign="top"></td><td valign="top"><em>a21</em> </td><td>Element (2, 1) of the matrix </td></tr> <tr><td valign="top"></td><td valign="top"><em>a22</em> </td><td>Element (2, 2) of the matrix </td></tr> </table> </dd> </dl> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="aff23cbd3d056d404a566a62dea4c98c1"></a><!-- doxytag: member="sf::Matrix3::Get4x4Elements" ref="aff23cbd3d056d404a566a62dea4c98c1" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const float* sf::Matrix3::Get4x4Elements </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Return the elements of the matrix. </p> <p>This function returns an array of 16 floats containing the corresponding 4x4 matrix, so that it is directly compatible with OpenGL functions.</p> <dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the 4x4 matrix elements </dd></dl> </div> </div> <a class="anchor" id="afa7b544f401812b55ace055043385e8e"></a><!-- doxytag: member="sf::Matrix3::GetInverse" ref="afa7b544f401812b55ace055043385e8e" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classsf_1_1Matrix3.htm">Matrix3</a> sf::Matrix3::GetInverse </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Return the inverse of the matrix. </p> <p>If the inverse cannot be computed, the identity matrix is returned.</p> <dl class="return"><dt><b>Returns:</b></dt><dd>A new matrix which is the inverse of self </dd></dl> </div> </div> <a class="anchor" id="a6f460e6fbe5f4f838c00424426959b00"></a><!-- doxytag: member="sf::Matrix3::operator*" ref="a6f460e6fbe5f4f838c00424426959b00" args="(const Matrix3 &right) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classsf_1_1Matrix3.htm">Matrix3</a> sf::Matrix3::operator* </td> <td>(</td> <td class="paramtype">const <a class="el" href="classsf_1_1Matrix3.htm">Matrix3</a> & </td> <td class="paramname"> <em>right</em></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Overload of binary operator *. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>right</em> </td><td>Right operand of the multiplication</td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>New matrix which is the result of self * <em>right</em> </dd></dl> </div> </div> <a class="anchor" id="aec437ecfc6381d6845fc639acb71597e"></a><!-- doxytag: member="sf::Matrix3::Projection" ref="aec437ecfc6381d6845fc639acb71597e" args="(const Vector2f &center, const Vector2f &size, float rotation)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classsf_1_1Matrix3.htm">Matrix3</a> sf::Matrix3::Projection </td> <td>(</td> <td class="paramtype">const <a class="el" href="classsf_1_1Vector2.htm">Vector2f</a> & </td> <td class="paramname"> <em>center</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classsf_1_1Vector2.htm">Vector2f</a> & </td> <td class="paramname"> <em>size</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"> <em>rotation</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Build a 2D project matrix. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>center</em> </td><td>Center of the view </td></tr> <tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>Size of the view </td></tr> <tr><td valign="top"></td><td valign="top"><em>rotation</em> </td><td>Angle of rotation of the view, in degrees</td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>New <a class="el" href="classsf_1_1Matrix3.htm" title="Utility class to manipulate 3x3 matrices of floats.">Matrix3</a> containing the projection</dd></dl> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classsf_1_1Matrix3.htm#a642c6b3ff82e738a013b841dd23566d8" title="Build a matrix from a set of transformations.">Transformation</a> </dd></dl> </div> </div> <a class="anchor" id="ac2b449b387f2e537833f6444d19b0bb4"></a><!-- doxytag: member="sf::Matrix3::Transform" ref="ac2b449b387f2e537833f6444d19b0bb4" args="(const Vector2f &point) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classsf_1_1Vector2.htm">Vector2f</a> sf::Matrix3::Transform </td> <td>(</td> <td class="paramtype">const <a class="el" href="classsf_1_1Vector2.htm">Vector2f</a> & </td> <td class="paramname"> <em>point</em></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Transform a point by the matrix. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>point</em> </td><td>Point to transform</td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>Transformed point </dd></dl> </div> </div> <a class="anchor" id="a642c6b3ff82e738a013b841dd23566d8"></a><!-- doxytag: member="sf::Matrix3::Transformation" ref="a642c6b3ff82e738a013b841dd23566d8" args="(const Vector2f &origin, const Vector2f &translation, float rotation, const Vector2f &scale)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classsf_1_1Matrix3.htm">Matrix3</a> sf::Matrix3::Transformation </td> <td>(</td> <td class="paramtype">const <a class="el" href="classsf_1_1Vector2.htm">Vector2f</a> & </td> <td class="paramname"> <em>origin</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classsf_1_1Vector2.htm">Vector2f</a> & </td> <td class="paramname"> <em>translation</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"> <em>rotation</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classsf_1_1Vector2.htm">Vector2f</a> & </td> <td class="paramname"> <em>scale</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Build a matrix from a set of transformations. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>origin</em> </td><td>Origin for the transformations </td></tr> <tr><td valign="top"></td><td valign="top"><em>translation</em> </td><td>Translation offset </td></tr> <tr><td valign="top"></td><td valign="top"><em>rotation</em> </td><td>Rotation angle in degrees </td></tr> <tr><td valign="top"></td><td valign="top"><em>scale</em> </td><td>Scaling factors</td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>New <a class="el" href="classsf_1_1Matrix3.htm" title="Utility class to manipulate 3x3 matrices of floats.">Matrix3</a> containing the transformations</dd></dl> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classsf_1_1Matrix3.htm#aec437ecfc6381d6845fc639acb71597e" title="Build a 2D project matrix.">Projection</a> </dd></dl> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="afa5a43545e529d8b8628ca42289ef40a"></a><!-- doxytag: member="sf::Matrix3::Identity" ref="afa5a43545e529d8b8628ca42289ef40a" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const <a class="el" href="classsf_1_1Matrix3.htm">Matrix3</a> <a class="el" href="classsf_1_1Matrix3.htm#afa5a43545e529d8b8628ca42289ef40a">sf::Matrix3::Identity</a><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>The identity matrix. </p> <p>Definition at line <a class="el" href="Matrix3_8hpp_source.htm#l00148">148</a> of file <a class="el" href="Matrix3_8hpp_source.htm">Matrix3.hpp</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="Matrix3_8hpp_source.htm">Matrix3.hpp</a></li> </ul> </div> <p id="footer"> :: Copyright © 2007-2008 Laurent Gomila, all rights reserved :: Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen 1.5.2</a> :: </p> </body> </html>