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

Last change on this file since 14 was 14, checked in by Sanahuja Guillaume, 5 years ago

doc

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