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

Last change on this file was 100, checked in by Sanahuja Guillaume, 6 years ago

doc
File size: 18.1 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: OneAxisRotation.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
53 <li class="current"><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="files.html"><span>File&#160;List</span></a></li>
75 </ul>
76 </div>
77</div><!-- top -->
78<div id="side-nav" class="ui-resizable side-nav-resizable">
79 <div id="nav-tree">
80 <div id="nav-tree-contents">
81 <div id="nav-sync" class="sync"></div>
82 </div>
83 </div>
84 <div id="splitbar" style="-moz-user-select:none;"
85 class="ui-resizable-handle">
86 </div>
87</div>
88<script type="text/javascript">
89$(document).ready(function(){initNavTree('_one_axis_rotation_8h_source.html','');});
90</script>
91<div id="doc-content">
92<!-- window showing the filter options -->
93<div id="MSearchSelectWindow"
94 onmouseover="return searchBox.OnSearchSelectShow()"
95 onmouseout="return searchBox.OnSearchSelectHide()"
96 onkeydown="return searchBox.OnSearchSelectKey(event)">
97</div>
98
99<!-- iframe showing the search results (closed by default) -->
100<div id="MSearchResultsWindow">
101<iframe src="javascript:void(0)" frameborder="0"
102 name="MSearchResults" id="MSearchResults">
103</iframe>
104</div>
105
106<div class="header">
107 <div class="headertitle">
108<div class="title">OneAxisRotation.h</div> </div>
109</div><!--header-->
110<div class="contents">
111<a href="_one_axis_rotation_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// %flair:license{</span></div>
112<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// This file is part of the Flair framework distributed under the</span></div>
113<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// CECILL-C License, Version 1.0.</span></div>
114<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// %flair:license}</span></div>
115<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"></span><span class="preprocessor">#ifndef ONEAXISROTATION_H</span></div>
116<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#define ONEAXISROTATION_H</span></div>
117<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div>
118<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_group_box_8h.html">GroupBox.h</a>&gt;</span></div>
119<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_vector3_d_8h.html">Vector3D.h</a>&gt;</span></div>
120<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div>
121<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="keyword">class </span>OneAxisRotation_impl;</div>
122<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div>
123<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceflair.html">flair</a> {</div>
124<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="keyword">namespace </span>gui {</div>
125<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="keyword">class </span>LayoutPosition;</div>
126<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;}</div>
127<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div>
128<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">namespace </span>core {</div>
129<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">class </span>Euler;</div>
130<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">class </span>Quaternion;</div>
131<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">class </span>RotationMatrix;</div>
132<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div>
133<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classflair_1_1core_1_1_one_axis_rotation.html"> 38</a></span>&#160;<span class="keyword">class </span><a class="code" href="classflair_1_1core_1_1_one_axis_rotation.html">OneAxisRotation</a> : <span class="keyword">public</span> <a class="code" href="classflair_1_1gui_1_1_group_box.html">gui::GroupBox</a> {</div>
134<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">public</span>:</div>
135<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classflair_1_1core_1_1_one_axis_rotation.html#a327edc6a6cdc6af2abc763aea6618495"> 44</a></span>&#160; <span class="keyword">enum</span> <a class="code" href="classflair_1_1core_1_1_one_axis_rotation.html#a327edc6a6cdc6af2abc763aea6618495">RotationType_t</a> {</div>
136<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; PreRotation,<span class="comment">//rotation</span></div>
137<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; PostRotation<span class="comment">//frame change</span></div>
138<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; };</div>
139<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <a class="code" href="classflair_1_1core_1_1_one_axis_rotation.html#a85a24d18b48761166caa4f037b13ebb4">OneAxisRotation</a>(<span class="keyword">const</span> <a class="code" href="classflair_1_1gui_1_1_layout_position.html">gui::LayoutPosition</a> *position, std::string name,<a class="code" href="classflair_1_1core_1_1_one_axis_rotation.html#a327edc6a6cdc6af2abc763aea6618495">RotationType_t</a> rotationType);</div>
140<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;</div>
141<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <a class="code" href="classflair_1_1core_1_1_one_axis_rotation.html#adb99d2f257c0600f9d56813d1b72fe6b">~OneAxisRotation</a>();</div>
142<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</div>
143<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt; <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_one_axis_rotation.html#a59b74b5059d847710803259bd1b8f1c1">ComputeRotation</a>(<a class="code" href="classflair_1_1core_1_1_vector3_d.html">core::Vector3D&lt;T&gt;</a> &amp;vector) <span class="keyword">const</span>;</div>
144<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div>
145<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_one_axis_rotation.html#a59b74b5059d847710803259bd1b8f1c1">ComputeRotation</a>(<a class="code" href="classflair_1_1core_1_1_euler.html">core::Euler</a> &amp;euler) <span class="keyword">const</span>;</div>
146<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;</div>
147<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_one_axis_rotation.html#a59b74b5059d847710803259bd1b8f1c1">ComputeRotation</a>(<a class="code" href="classflair_1_1core_1_1_quaternion.html">core::Quaternion</a> &amp;quaternion) <span class="keyword">const</span>;</div>
148<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div>
149<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_one_axis_rotation.html#a59b74b5059d847710803259bd1b8f1c1">ComputeRotation</a>(<a class="code" href="classflair_1_1core_1_1_rotation_matrix.html">core::RotationMatrix</a> &amp;matrix) <span class="keyword">const</span>;</div>
150<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; </div>
151<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keywordtype">float</span> <a class="code" href="classflair_1_1core_1_1_one_axis_rotation.html#a311d0fbae6722ce463f8f20a1c17545b">GetAngle</a>() <span class="keyword">const</span>;</div>
152<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="keywordtype">int</span> GetAxis() <span class="keyword">const</span>;</div>
153<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;</div>
154<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;<span class="keyword">private</span>:</div>
155<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keyword">const</span> <span class="keyword">class </span>OneAxisRotation_impl *pimpl_;</div>
156<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;};</div>
157<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;</div>
158<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;} <span class="comment">// end namespace core</span></div>
159<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;} <span class="comment">// end namespace flair</span></div>
160<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;</div>
161<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;<span class="preprocessor">#endif // ONEAXISROTATION_H</span></div>
162<div class="ttc" id="namespaceflair_html"><div class="ttname"><a href="namespaceflair.html">flair</a></div><div class="ttdoc">namespace of the flair Framework </div><div class="ttdef"><b>Definition:</b> Ahrs.h:19</div></div>
163<div class="ttc" id="classflair_1_1core_1_1_one_axis_rotation_html_adb99d2f257c0600f9d56813d1b72fe6b"><div class="ttname"><a href="classflair_1_1core_1_1_one_axis_rotation.html#adb99d2f257c0600f9d56813d1b72fe6b">flair::core::OneAxisRotation::~OneAxisRotation</a></div><div class="ttdeci">~OneAxisRotation()</div><div class="ttdoc">Destructor. </div></div>
164<div class="ttc" id="classflair_1_1core_1_1_vector3_d_html"><div class="ttname"><a href="classflair_1_1core_1_1_vector3_d.html">flair::core::Vector3D</a></div><div class="ttdoc">Class defining a 3D vector. </div><div class="ttdef"><b>Definition:</b> Vector3D.h:29</div></div>
165<div class="ttc" id="classflair_1_1gui_1_1_group_box_html"><div class="ttname"><a href="classflair_1_1gui_1_1_group_box.html">flair::gui::GroupBox</a></div><div class="ttdoc">Class displaying a QGroupBox on the ground station. </div><div class="ttdef"><b>Definition:</b> GroupBox.h:27</div></div>
166<div class="ttc" id="classflair_1_1core_1_1_one_axis_rotation_html_a85a24d18b48761166caa4f037b13ebb4"><div class="ttname"><a href="classflair_1_1core_1_1_one_axis_rotation.html#a85a24d18b48761166caa4f037b13ebb4">flair::core::OneAxisRotation::OneAxisRotation</a></div><div class="ttdeci">OneAxisRotation(const gui::LayoutPosition *position, std::string name, RotationType_t rotationType)</div><div class="ttdoc">Constructor. </div></div>
167<div class="ttc" id="classflair_1_1core_1_1_euler_html"><div class="ttname"><a href="classflair_1_1core_1_1_euler.html">flair::core::Euler</a></div><div class="ttdoc">Class defining euler angles. </div><div class="ttdef"><b>Definition:</b> Euler.h:27</div></div>
168<div class="ttc" id="classflair_1_1core_1_1_rotation_matrix_html"><div class="ttname"><a href="classflair_1_1core_1_1_rotation_matrix.html">flair::core::RotationMatrix</a></div><div class="ttdoc">Class defining a rotation matrix. </div><div class="ttdef"><b>Definition:</b> RotationMatrix.h:26</div></div>
169<div class="ttc" id="_vector3_d_8h_html"><div class="ttname"><a href="_vector3_d_8h.html">Vector3D.h</a></div><div class="ttdoc">Class defining a 3D vector. </div></div>
170<div class="ttc" id="classflair_1_1core_1_1_one_axis_rotation_html"><div class="ttname"><a href="classflair_1_1core_1_1_one_axis_rotation.html">flair::core::OneAxisRotation</a></div><div class="ttdoc">Class defining a rotation around one axis. </div><div class="ttdef"><b>Definition:</b> OneAxisRotation.h:38</div></div>
171<div class="ttc" id="classflair_1_1core_1_1_one_axis_rotation_html_a311d0fbae6722ce463f8f20a1c17545b"><div class="ttname"><a href="classflair_1_1core_1_1_one_axis_rotation.html#a311d0fbae6722ce463f8f20a1c17545b">flair::core::OneAxisRotation::GetAngle</a></div><div class="ttdeci">float GetAngle() const </div><div class="ttdoc">Get angle. </div></div>
172<div class="ttc" id="classflair_1_1core_1_1_one_axis_rotation_html_a59b74b5059d847710803259bd1b8f1c1"><div class="ttname"><a href="classflair_1_1core_1_1_one_axis_rotation.html#a59b74b5059d847710803259bd1b8f1c1">flair::core::OneAxisRotation::ComputeRotation</a></div><div class="ttdeci">void ComputeRotation(core::Vector3D&lt; T &gt; &amp;vector) const </div><div class="ttdoc">Compute rotation. </div></div>
173<div class="ttc" id="_group_box_8h_html"><div class="ttname"><a href="_group_box_8h.html">GroupBox.h</a></div><div class="ttdoc">Class displaying a QGroupBox on the ground station. </div></div>
174<div class="ttc" id="classflair_1_1gui_1_1_layout_position_html"><div class="ttname"><a href="classflair_1_1gui_1_1_layout_position.html">flair::gui::LayoutPosition</a></div><div class="ttdoc">Class to define a position in a layout on the ground station. </div><div class="ttdef"><b>Definition:</b> LayoutPosition.h:28</div></div>
175<div class="ttc" id="classflair_1_1core_1_1_one_axis_rotation_html_a327edc6a6cdc6af2abc763aea6618495"><div class="ttname"><a href="classflair_1_1core_1_1_one_axis_rotation.html#a327edc6a6cdc6af2abc763aea6618495">flair::core::OneAxisRotation::RotationType_t</a></div><div class="ttdeci">RotationType_t</div><div class="ttdoc">rotation type </div><div class="ttdef"><b>Definition:</b> OneAxisRotation.h:44</div></div>
176<div class="ttc" id="classflair_1_1core_1_1_quaternion_html"><div class="ttname"><a href="classflair_1_1core_1_1_quaternion.html">flair::core::Quaternion</a></div><div class="ttdoc">Class defining a quaternion. </div><div class="ttdef"><b>Definition:</b> Quaternion.h:26</div></div>
177</div><!-- fragment --></div><!-- contents -->
178</div><!-- doc-content -->
179<!-- start footer part -->
180<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
181 <ul>
182 <li class="navelem"><a class="el" href="dir_33c2ee9b1665499374b4225c427cf176.html">igep</a></li><li class="navelem"><a class="el" href="dir_f1fe274389177bd7e17de7949c4ffada.html">flair-src</a></li><li class="navelem"><a class="el" href="dir_3ef62148cf94871b4b6ee5d6e3a989c1.html">lib</a></li><li class="navelem"><a class="el" href="dir_97265977dbbd48c696782ccac102bad5.html">FlairCore</a></li><li class="navelem"><a class="el" href="dir_6c198461db290ac9abcdd44184573216.html">src</a></li><li class="navelem"><a class="el" href="_one_axis_rotation_8h.html">OneAxisRotation.h</a></li>
183 <li class="footer">Generated on Thu Jan 31 2019 12:34:23 for Flair by
184 <a href="http://www.doxygen.org/index.html">
185 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
186 </ul>
187</div>
188</body>
189</html>
Note: See TracBrowser for help on using the repository browser.