source: flair-dev/trunk/doc/Flair/classflair_1_1core_1_1_rotation_matrix.html

Last change on this file was 100, checked in by Sanahuja Guillaume, 22 months ago

doc

File size: 15.2 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.9.1"/>
7<title>Flair: flair::core::RotationMatrix Class Reference</title>
8<link href="tabs.css" rel="stylesheet" type="text/css"/>
9<script type="text/javascript" src="jquery.js"></script>
10<script type="text/javascript" src="dynsections.js"></script>
11<link href="navtree.css" rel="stylesheet" type="text/css"/>
12<script type="text/javascript" src="resize.js"></script>
13<script type="text/javascript" src="navtreedata.js"></script>
14<script type="text/javascript" src="navtree.js"></script>
15<script type="text/javascript">
16  $(document).ready(initResizable);
17  $(window).load(resizeHeight);
18</script>
19<link href="search/search.css" rel="stylesheet" type="text/css"/>
20<script type="text/javascript" src="search/searchdata.js"></script>
21<script type="text/javascript" src="search/search.js"></script>
22<script type="text/javascript">
23  $(document).ready(function() { init_search(); });
24</script>
25<link href="doxygen.css" rel="stylesheet" type="text/css" />
26</head>
27<body>
28<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
29<div id="titlearea">
30<table cellspacing="0" cellpadding="0">
31 <tbody>
32 <tr style="height: 56px;">
33  <td id="projectlogo"><img alt="Logo" src="logo_hds.png"/></td>
34  <td style="padding-left: 0.5em;">
35   <div id="projectname">Flair
36   </div>
37   <div id="projectbrief">Framework Libre Air</div>
38  </td>
39 </tr>
40 </tbody>
41</table>
42</div>
43<!-- end header part -->
44<!-- Generated by Doxygen 1.8.9.1 -->
45<script type="text/javascript">
46var searchBox = new SearchBox("searchBox", "search",false,'Search');
47</script>
48  <div id="navrow1" class="tabs">
49    <ul class="tablist">
50      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
51      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
52      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
53      <li><a href="files.html"><span>Files</span></a></li>
54      <li>
55        <div id="MSearchBox" class="MSearchBoxInactive">
56        <span class="left">
57          <img id="MSearchSelect" src="search/mag_sel.png"
58               onmouseover="return searchBox.OnSearchSelectShow()"
59               onmouseout="return searchBox.OnSearchSelectHide()"
60               alt=""/>
61          <input type="text" id="MSearchField" value="Search" accesskey="S"
62               onfocus="searchBox.OnSearchFieldFocus(true)" 
63               onblur="searchBox.OnSearchFieldFocus(false)" 
64               onkeyup="searchBox.OnSearchFieldChange(event)"/>
65          </span><span class="right">
66            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
67          </span>
68        </div>
69      </li>
70    </ul>
71  </div>
72  <div id="navrow2" class="tabs2">
73    <ul class="tablist">
74      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
75      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
76      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
77      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
78    </ul>
79  </div>
80</div><!-- top -->
81<div id="side-nav" class="ui-resizable side-nav-resizable">
82  <div id="nav-tree">
83    <div id="nav-tree-contents">
84      <div id="nav-sync" class="sync"></div>
85    </div>
86  </div>
87  <div id="splitbar" style="-moz-user-select:none;" 
88       class="ui-resizable-handle">
89  </div>
90</div>
91<script type="text/javascript">
92$(document).ready(function(){initNavTree('classflair_1_1core_1_1_rotation_matrix.html','');});
93</script>
94<div id="doc-content">
95<!-- window showing the filter options -->
96<div id="MSearchSelectWindow"
97     onmouseover="return searchBox.OnSearchSelectShow()"
98     onmouseout="return searchBox.OnSearchSelectHide()"
99     onkeydown="return searchBox.OnSearchSelectKey(event)">
100</div>
101
102<!-- iframe showing the search results (closed by default) -->
103<div id="MSearchResultsWindow">
104<iframe src="javascript:void(0)" frameborder="0" 
105        name="MSearchResults" id="MSearchResults">
106</iframe>
107</div>
108
109<div class="header">
110  <div class="summary">
111<a href="#pub-methods">Public Member Functions</a> &#124;
112<a href="#pub-attribs">Public Attributes</a> &#124;
113<a href="classflair_1_1core_1_1_rotation_matrix-members.html">List of all members</a>  </div>
114  <div class="headertitle">
115<div class="title">flair::core::RotationMatrix Class Reference</div>  </div>
116</div><!--header-->
117<div class="contents">
118
119<p>Class defining a rotation matrix. 
120 <a href="classflair_1_1core_1_1_rotation_matrix.html#details">More...</a></p>
121
122<p><code>#include &lt;<a class="el" href="_rotation_matrix_8h_source.html">RotationMatrix.h</a>&gt;</code></p>
123<table class="memberdecls">
124<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
125Public Member Functions</h2></td></tr>
126<tr class="memitem:a1654c70915d03eea7c712a04296b9583"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_rotation_matrix.html#a1654c70915d03eea7c712a04296b9583">RotationMatrix</a> ()</td></tr>
127<tr class="memdesc:a1654c70915d03eea7c712a04296b9583"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a1654c70915d03eea7c712a04296b9583">More...</a><br /></td></tr>
128<tr class="separator:a1654c70915d03eea7c712a04296b9583"><td class="memSeparator" colspan="2">&#160;</td></tr>
129<tr class="memitem:a4c46e6c1cdd66818eaa131822e5bcbb3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_rotation_matrix.html#a4c46e6c1cdd66818eaa131822e5bcbb3">~RotationMatrix</a> ()</td></tr>
130<tr class="memdesc:a4c46e6c1cdd66818eaa131822e5bcbb3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a4c46e6c1cdd66818eaa131822e5bcbb3">More...</a><br /></td></tr>
131<tr class="separator:a4c46e6c1cdd66818eaa131822e5bcbb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
132<tr class="memitem:a21f115fe207aa8c73515026fe921a5f3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_rotation_matrix.html#a21f115fe207aa8c73515026fe921a5f3">ToEuler</a> (<a class="el" href="classflair_1_1core_1_1_euler.html">Euler</a> &amp;euler) const </td></tr>
133<tr class="memdesc:a21f115fe207aa8c73515026fe921a5f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert to euler angles.  <a href="#a21f115fe207aa8c73515026fe921a5f3">More...</a><br /></td></tr>
134<tr class="separator:a21f115fe207aa8c73515026fe921a5f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
135<tr class="memitem:a2c2286d9604028ce59705d2514fc3caf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classflair_1_1core_1_1_euler.html">Euler</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_rotation_matrix.html#a2c2286d9604028ce59705d2514fc3caf">ToEuler</a> (void) const </td></tr>
136<tr class="memdesc:a2c2286d9604028ce59705d2514fc3caf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert to euler angles.  <a href="#a2c2286d9604028ce59705d2514fc3caf">More...</a><br /></td></tr>
137<tr class="separator:a2c2286d9604028ce59705d2514fc3caf"><td class="memSeparator" colspan="2">&#160;</td></tr>
138<tr class="memitem:a41877f4dbe6537791a9c0b282ae83c97"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_rotation_matrix.html#a41877f4dbe6537791a9c0b282ae83c97">ToQuaternion</a> (<a class="el" href="classflair_1_1core_1_1_quaternion.html">Quaternion</a> &amp;quaternion) const </td></tr>
139<tr class="memdesc:a41877f4dbe6537791a9c0b282ae83c97"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert to quaternion.  <a href="#a41877f4dbe6537791a9c0b282ae83c97">More...</a><br /></td></tr>
140<tr class="separator:a41877f4dbe6537791a9c0b282ae83c97"><td class="memSeparator" colspan="2">&#160;</td></tr>
141<tr class="memitem:afaf6104cf10df2980dedcdffe30112ec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classflair_1_1core_1_1_quaternion.html">Quaternion</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_rotation_matrix.html#afaf6104cf10df2980dedcdffe30112ec">ToQuaternion</a> (void) const </td></tr>
142<tr class="memdesc:afaf6104cf10df2980dedcdffe30112ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert to quaternion.  <a href="#afaf6104cf10df2980dedcdffe30112ec">More...</a><br /></td></tr>
143<tr class="separator:afaf6104cf10df2980dedcdffe30112ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
144<tr class="memitem:a98eec70a5fd93937779de9e065f54eeb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a98eec70a5fd93937779de9e065f54eeb"></a>
145float &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator()</b> (size_t row, size_t col)</td></tr>
146<tr class="separator:a98eec70a5fd93937779de9e065f54eeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
147<tr class="memitem:a2b1063336d1c455c09c2951b728237c4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2b1063336d1c455c09c2951b728237c4"></a>
148const float &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator()</b> (size_t row, size_t col) const </td></tr>
149<tr class="separator:a2b1063336d1c455c09c2951b728237c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
150</table><table class="memberdecls">
151<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
152Public Attributes</h2></td></tr>
153<tr class="memitem:a2931667bed155085f243743811f60536"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_rotation_matrix.html#a2931667bed155085f243743811f60536">m</a> [3][3]</td></tr>
154<tr class="memdesc:a2931667bed155085f243743811f60536"><td class="mdescLeft">&#160;</td><td class="mdescRight">matrix  <a href="#a2931667bed155085f243743811f60536">More...</a><br /></td></tr>
155<tr class="separator:a2931667bed155085f243743811f60536"><td class="memSeparator" colspan="2">&#160;</td></tr>
156</table>
157<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
158<div class="textblock"><p>Class defining a rotation matrix. </p>
159</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
160<a class="anchor" id="a1654c70915d03eea7c712a04296b9583"></a>
161<div class="memitem">
162<div class="memproto">
163      <table class="memname">
164        <tr>
165          <td class="memname">flair::core::RotationMatrix::RotationMatrix </td>
166          <td>(</td>
167          <td class="paramname"></td><td>)</td>
168          <td></td>
169        </tr>
170      </table>
171</div><div class="memdoc">
172
173<p>Constructor. </p>
174<p>Construct an identity rotation matrix </p>
175
176</div>
177</div>
178<a class="anchor" id="a4c46e6c1cdd66818eaa131822e5bcbb3"></a>
179<div class="memitem">
180<div class="memproto">
181      <table class="memname">
182        <tr>
183          <td class="memname">flair::core::RotationMatrix::~RotationMatrix </td>
184          <td>(</td>
185          <td class="paramname"></td><td>)</td>
186          <td></td>
187        </tr>
188      </table>
189</div><div class="memdoc">
190
191<p>Destructor. </p>
192
193</div>
194</div>
195<h2 class="groupheader">Member Function Documentation</h2>
196<a class="anchor" id="a21f115fe207aa8c73515026fe921a5f3"></a>
197<div class="memitem">
198<div class="memproto">
199      <table class="memname">
200        <tr>
201          <td class="memname">void flair::core::RotationMatrix::ToEuler </td>
202          <td>(</td>
203          <td class="paramtype"><a class="el" href="classflair_1_1core_1_1_euler.html">Euler</a> &amp;&#160;</td>
204          <td class="paramname"><em>euler</em></td><td>)</td>
205          <td> const</td>
206        </tr>
207      </table>
208</div><div class="memdoc">
209
210<p>Convert to euler angles. </p>
211<dl class="params"><dt>Parameters</dt><dd>
212  <table class="params">
213    <tr><td class="paramname">euler</td><td>output euler angles </td></tr>
214  </table>
215  </dd>
216</dl>
217
218</div>
219</div>
220<a class="anchor" id="a2c2286d9604028ce59705d2514fc3caf"></a>
221<div class="memitem">
222<div class="memproto">
223      <table class="memname">
224        <tr>
225          <td class="memname"><a class="el" href="classflair_1_1core_1_1_euler.html">Euler</a> flair::core::RotationMatrix::ToEuler </td>
226          <td>(</td>
227          <td class="paramtype">void&#160;</td>
228          <td class="paramname"></td><td>)</td>
229          <td> const</td>
230        </tr>
231      </table>
232</div><div class="memdoc">
233
234<p>Convert to euler angles. </p>
235<dl class="section return"><dt>Returns</dt><dd>euler angles </dd></dl>
236
237</div>
238</div>
239<a class="anchor" id="a41877f4dbe6537791a9c0b282ae83c97"></a>
240<div class="memitem">
241<div class="memproto">
242      <table class="memname">
243        <tr>
244          <td class="memname">void flair::core::RotationMatrix::ToQuaternion </td>
245          <td>(</td>
246          <td class="paramtype"><a class="el" href="classflair_1_1core_1_1_quaternion.html">Quaternion</a> &amp;&#160;</td>
247          <td class="paramname"><em>quaternion</em></td><td>)</td>
248          <td> const</td>
249        </tr>
250      </table>
251</div><div class="memdoc">
252
253<p>Convert to quaternion. </p>
254<dl class="params"><dt>Parameters</dt><dd>
255  <table class="params">
256    <tr><td class="paramname">quaternion</td><td>output quaternion </td></tr>
257  </table>
258  </dd>
259</dl>
260
261</div>
262</div>
263<a class="anchor" id="afaf6104cf10df2980dedcdffe30112ec"></a>
264<div class="memitem">
265<div class="memproto">
266      <table class="memname">
267        <tr>
268          <td class="memname"><a class="el" href="classflair_1_1core_1_1_quaternion.html">Quaternion</a> flair::core::RotationMatrix::ToQuaternion </td>
269          <td>(</td>
270          <td class="paramtype">void&#160;</td>
271          <td class="paramname"></td><td>)</td>
272          <td> const</td>
273        </tr>
274      </table>
275</div><div class="memdoc">
276
277<p>Convert to quaternion. </p>
278<dl class="section return"><dt>Returns</dt><dd>quaternion </dd></dl>
279
280</div>
281</div>
282<h2 class="groupheader">Member Data Documentation</h2>
283<a class="anchor" id="a2931667bed155085f243743811f60536"></a>
284<div class="memitem">
285<div class="memproto">
286      <table class="memname">
287        <tr>
288          <td class="memname">float flair::core::RotationMatrix::m[3][3]</td>
289        </tr>
290      </table>
291</div><div class="memdoc">
292
293<p>matrix </p>
294
295</div>
296</div>
297</div><!-- contents -->
298</div><!-- doc-content -->
299<!-- start footer part -->
300<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
301  <ul>
302    <li class="navelem"><a class="el" href="namespaceflair.html">flair</a></li><li class="navelem"><a class="el" href="namespaceflair_1_1core.html">core</a></li><li class="navelem"><a class="el" href="classflair_1_1core_1_1_rotation_matrix.html">RotationMatrix</a></li>
303    <li class="footer">Generated on Thu Jan 31 2019 12:34:23 for Flair by
304    <a href="http://www.doxygen.org/index.html">
305    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
306  </ul>
307</div>
308</body>
309</html>
Note: See TracBrowser for help on using the repository browser.