-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathSensor_8hpp_source.htm
More file actions
118 lines (118 loc) · 16.1 KB
/
Sensor_8hpp_source.htm
File metadata and controls
118 lines (118 loc) · 16.1 KB
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
<!doctype html>
<html class="no-js" lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpp3ds · Documentation</title>
<link rel="stylesheet" href="../css/app.css" />
<link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" />
<script src="../bower_components/modernizr/modernizr.js"></script>
</head>
<body>
<div id="topnav" class="text-center">
<dl class="sub-nav">
<dd id="navlogo"><a href="/">
<img src="../img/logo.svg" />
</a></dd>
<dd><a href="/#what">What is it?</a></dd>
<dd><a href="/#download">Download</a></dd>
<dd><a href="/#faqs">FAQs</a></dd>
<dd class="active"><a href="/docs">Docs</a></dd>
</dl>
</div>
<div id="content">
<!-- Generated by Doxygen 1.8.10 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.htm"><span>Main Page</span></a></li>
<li><a href="modules.htm"><span>Modules</span></a></li>
<li><a href="annotated.htm"><span>Classes</span></a></li>
<li class="current"><a href="files.htm"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.htm"><span>File List</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_0b93ed46ee854382aab85c778b89946e.htm">include</a></li><li class="navelem"><a class="el" href="dir_18d409fe281a3b15bd325ab753ead42a.htm">cpp3ds</a></li><li class="navelem"><a class="el" href="dir_b6f6377c514aded02f52653f040de614.htm">Window</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Sensor.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef CPP3DS_SENSOR_HPP</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define CPP3DS_SENSOR_HPP</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include <cpp3ds/System/Vector3.hpp></span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <cpp3ds/System/Time.hpp></span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="keyword">namespace </span><a class="code" href="namespacecpp3ds.htm">cpp3ds</a> {</div>
<div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="classcpp3ds_1_1Sensor.htm"> 12</a></span> <span class="keyword">class </span><a class="code" href="classcpp3ds_1_1Sensor.htm">Sensor</a> {</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="classcpp3ds_1_1Sensor.htm#a9ca2caf18435dc2764c09f214cea9e2d"> 19</a></span>  <span class="keyword">enum</span> <a class="code" href="classcpp3ds_1_1Sensor.htm#a9ca2caf18435dc2764c09f214cea9e2d">Type</a> {</div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="classcpp3ds_1_1Sensor.htm#a9ca2caf18435dc2764c09f214cea9e2da6a8b95d28ac27e993b7abbf464d3b657"> 20</a></span>  <a class="code" href="classcpp3ds_1_1Sensor.htm#a9ca2caf18435dc2764c09f214cea9e2da6a8b95d28ac27e993b7abbf464d3b657">Accelerometer</a>, </div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classcpp3ds_1_1Sensor.htm#a9ca2caf18435dc2764c09f214cea9e2da0e148e0bdd4989b8aeac2888d5892704"> 21</a></span>  <a class="code" href="classcpp3ds_1_1Sensor.htm#a9ca2caf18435dc2764c09f214cea9e2da0e148e0bdd4989b8aeac2888d5892704">Gyroscope</a>, </div>
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="classcpp3ds_1_1Sensor.htm#a9ca2caf18435dc2764c09f214cea9e2da2bbef83afdbe98b7e44f0187df59a5bf"> 22</a></span>  <a class="code" href="classcpp3ds_1_1Sensor.htm#a9ca2caf18435dc2764c09f214cea9e2da2bbef83afdbe98b7e44f0187df59a5bf">Magnetometer</a>, </div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classcpp3ds_1_1Sensor.htm#a9ca2caf18435dc2764c09f214cea9e2da12a955a116a498806fa1fa764931a51d"> 23</a></span>  <a class="code" href="classcpp3ds_1_1Sensor.htm#a9ca2caf18435dc2764c09f214cea9e2da12a955a116a498806fa1fa764931a51d">Gravity</a>, </div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classcpp3ds_1_1Sensor.htm#a9ca2caf18435dc2764c09f214cea9e2da963b0281f2376d24819fdda790e019a2"> 24</a></span>  <a class="code" href="classcpp3ds_1_1Sensor.htm#a9ca2caf18435dc2764c09f214cea9e2da963b0281f2376d24819fdda790e019a2">UserAcceleration</a>, </div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classcpp3ds_1_1Sensor.htm#a9ca2caf18435dc2764c09f214cea9e2da250beed135156c4ca64543fd50bc3420"> 25</a></span>  <a class="code" href="classcpp3ds_1_1Sensor.htm#a9ca2caf18435dc2764c09f214cea9e2da250beed135156c4ca64543fd50bc3420">Orientation</a>, </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classcpp3ds_1_1Sensor.htm#a9ca2caf18435dc2764c09f214cea9e2da49d5e7fac270bf1baba5ba90a394fbd4"> 27</a></span>  <a class="code" href="classcpp3ds_1_1Sensor.htm#a9ca2caf18435dc2764c09f214cea9e2da49d5e7fac270bf1baba5ba90a394fbd4">Count</a> </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  };</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classcpp3ds_1_1Sensor.htm#a5f2f59b358251f26b1f7804ed2560c2d">isAvailable</a>(<a class="code" href="classcpp3ds_1_1Sensor.htm#a9ca2caf18435dc2764c09f214cea9e2d">Type</a> sensor);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classcpp3ds_1_1Sensor.htm#a3e161c105ece6dc16a7e10980194251a">setEnabled</a>(<a class="code" href="classcpp3ds_1_1Sensor.htm#a9ca2caf18435dc2764c09f214cea9e2d">Type</a> sensor, <span class="keywordtype">bool</span> enabled);</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classcpp3ds_1_1Sensor.htm#a0f77ec0cb03d6663db5cf7d39bbc6101">isEnabled</a>(<a class="code" href="classcpp3ds_1_1Sensor.htm#a9ca2caf18435dc2764c09f214cea9e2d">Type</a> sensor);</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classcpp3ds_1_1Sensor.htm#a33eff0c965be7b6e6939ee565e8999ea">update</a>();</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">static</span> <a class="code" href="classcpp3ds_1_1Vector3.htm">Vector3f</a> <a class="code" href="classcpp3ds_1_1Sensor.htm#ae85cf5a9dd672fd7f8c351f112d7460b">getValue</a>(<a class="code" href="classcpp3ds_1_1Sensor.htm#a9ca2caf18435dc2764c09f214cea9e2d">Type</a> sensor);</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> m_accel_enabled;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> m_gyro_enabled;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">static</span> <a class="code" href="classcpp3ds_1_1Vector3.htm">Vector3f</a> m_accel;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">static</span> <a class="code" href="classcpp3ds_1_1Vector3.htm">Vector3f</a> m_gyro;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> };</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> }</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div>
<div class="ttc" id="classcpp3ds_1_1Sensor_htm_a9ca2caf18435dc2764c09f214cea9e2da6a8b95d28ac27e993b7abbf464d3b657"><div class="ttname"><a href="classcpp3ds_1_1Sensor.htm#a9ca2caf18435dc2764c09f214cea9e2da6a8b95d28ac27e993b7abbf464d3b657">cpp3ds::Sensor::Accelerometer</a></div><div class="ttdoc">Measures the raw acceleration (m/s²) </div><div class="ttdef"><b>Definition:</b> <a href="Sensor_8hpp_source.htm#l00020">Sensor.hpp:20</a></div></div>
<div class="ttc" id="classcpp3ds_1_1Sensor_htm_a9ca2caf18435dc2764c09f214cea9e2d"><div class="ttname"><a href="classcpp3ds_1_1Sensor.htm#a9ca2caf18435dc2764c09f214cea9e2d">cpp3ds::Sensor::Type</a></div><div class="ttdeci">Type</div><div class="ttdoc">Sensor type. </div><div class="ttdef"><b>Definition:</b> <a href="Sensor_8hpp_source.htm#l00019">Sensor.hpp:19</a></div></div>
<div class="ttc" id="classcpp3ds_1_1Sensor_htm_a9ca2caf18435dc2764c09f214cea9e2da250beed135156c4ca64543fd50bc3420"><div class="ttname"><a href="classcpp3ds_1_1Sensor.htm#a9ca2caf18435dc2764c09f214cea9e2da250beed135156c4ca64543fd50bc3420">cpp3ds::Sensor::Orientation</a></div><div class="ttdoc">Measures the absolute 3D orientation (degrees) </div><div class="ttdef"><b>Definition:</b> <a href="Sensor_8hpp_source.htm#l00025">Sensor.hpp:25</a></div></div>
<div class="ttc" id="classcpp3ds_1_1Sensor_htm_a5f2f59b358251f26b1f7804ed2560c2d"><div class="ttname"><a href="classcpp3ds_1_1Sensor.htm#a5f2f59b358251f26b1f7804ed2560c2d">cpp3ds::Sensor::isAvailable</a></div><div class="ttdeci">static bool isAvailable(Type sensor)</div><div class="ttdoc">Check if a sensor is available on the underlying platform. </div></div>
<div class="ttc" id="classcpp3ds_1_1Sensor_htm_a33eff0c965be7b6e6939ee565e8999ea"><div class="ttname"><a href="classcpp3ds_1_1Sensor.htm#a33eff0c965be7b6e6939ee565e8999ea">cpp3ds::Sensor::update</a></div><div class="ttdeci">static void update()</div><div class="ttdoc">Update the state of all the sensors. </div></div>
<div class="ttc" id="namespacecpp3ds_htm"><div class="ttname"><a href="namespacecpp3ds.htm">cpp3ds</a></div><div class="ttdef"><b>Definition:</b> <a href="AlResource_8hpp_source.htm#l00033">AlResource.hpp:33</a></div></div>
<div class="ttc" id="classcpp3ds_1_1Sensor_htm"><div class="ttname"><a href="classcpp3ds_1_1Sensor.htm">cpp3ds::Sensor</a></div><div class="ttdoc">Give access to the real-time state of the sensors. </div><div class="ttdef"><b>Definition:</b> <a href="Sensor_8hpp_source.htm#l00012">Sensor.hpp:12</a></div></div>
<div class="ttc" id="classcpp3ds_1_1Sensor_htm_ae85cf5a9dd672fd7f8c351f112d7460b"><div class="ttname"><a href="classcpp3ds_1_1Sensor.htm#ae85cf5a9dd672fd7f8c351f112d7460b">cpp3ds::Sensor::getValue</a></div><div class="ttdeci">static Vector3f getValue(Type sensor)</div><div class="ttdoc">Get the current sensor value. </div></div>
<div class="ttc" id="classcpp3ds_1_1Sensor_htm_a9ca2caf18435dc2764c09f214cea9e2da0e148e0bdd4989b8aeac2888d5892704"><div class="ttname"><a href="classcpp3ds_1_1Sensor.htm#a9ca2caf18435dc2764c09f214cea9e2da0e148e0bdd4989b8aeac2888d5892704">cpp3ds::Sensor::Gyroscope</a></div><div class="ttdoc">Measures the raw rotation rates (degrees/s) </div><div class="ttdef"><b>Definition:</b> <a href="Sensor_8hpp_source.htm#l00021">Sensor.hpp:21</a></div></div>
<div class="ttc" id="classcpp3ds_1_1Sensor_htm_a3e161c105ece6dc16a7e10980194251a"><div class="ttname"><a href="classcpp3ds_1_1Sensor.htm#a3e161c105ece6dc16a7e10980194251a">cpp3ds::Sensor::setEnabled</a></div><div class="ttdeci">static void setEnabled(Type sensor, bool enabled)</div><div class="ttdoc">Enable or disable a sensor. </div></div>
<div class="ttc" id="classcpp3ds_1_1Sensor_htm_a0f77ec0cb03d6663db5cf7d39bbc6101"><div class="ttname"><a href="classcpp3ds_1_1Sensor.htm#a0f77ec0cb03d6663db5cf7d39bbc6101">cpp3ds::Sensor::isEnabled</a></div><div class="ttdeci">static bool isEnabled(Type sensor)</div><div class="ttdoc">Check if a sensor is enabled. </div></div>
<div class="ttc" id="classcpp3ds_1_1Sensor_htm_a9ca2caf18435dc2764c09f214cea9e2da2bbef83afdbe98b7e44f0187df59a5bf"><div class="ttname"><a href="classcpp3ds_1_1Sensor.htm#a9ca2caf18435dc2764c09f214cea9e2da2bbef83afdbe98b7e44f0187df59a5bf">cpp3ds::Sensor::Magnetometer</a></div><div class="ttdoc">Measures the ambient magnetic field (micro-teslas) </div><div class="ttdef"><b>Definition:</b> <a href="Sensor_8hpp_source.htm#l00022">Sensor.hpp:22</a></div></div>
<div class="ttc" id="classcpp3ds_1_1Sensor_htm_a9ca2caf18435dc2764c09f214cea9e2da963b0281f2376d24819fdda790e019a2"><div class="ttname"><a href="classcpp3ds_1_1Sensor.htm#a9ca2caf18435dc2764c09f214cea9e2da963b0281f2376d24819fdda790e019a2">cpp3ds::Sensor::UserAcceleration</a></div><div class="ttdoc">Measures the direction and intensity of device acceleration, independent of the gravity (m/s²) ...</div><div class="ttdef"><b>Definition:</b> <a href="Sensor_8hpp_source.htm#l00024">Sensor.hpp:24</a></div></div>
<div class="ttc" id="classcpp3ds_1_1Vector3_htm"><div class="ttname"><a href="classcpp3ds_1_1Vector3.htm">cpp3ds::Vector3< float ></a></div></div>
<div class="ttc" id="classcpp3ds_1_1Sensor_htm_a9ca2caf18435dc2764c09f214cea9e2da12a955a116a498806fa1fa764931a51d"><div class="ttname"><a href="classcpp3ds_1_1Sensor.htm#a9ca2caf18435dc2764c09f214cea9e2da12a955a116a498806fa1fa764931a51d">cpp3ds::Sensor::Gravity</a></div><div class="ttdoc">Measures the direction and intensity of gravity, independent of device acceleration (m/s²) ...</div><div class="ttdef"><b>Definition:</b> <a href="Sensor_8hpp_source.htm#l00023">Sensor.hpp:23</a></div></div>
<div class="ttc" id="classcpp3ds_1_1Sensor_htm_a9ca2caf18435dc2764c09f214cea9e2da49d5e7fac270bf1baba5ba90a394fbd4"><div class="ttname"><a href="classcpp3ds_1_1Sensor.htm#a9ca2caf18435dc2764c09f214cea9e2da49d5e7fac270bf1baba5ba90a394fbd4">cpp3ds::Sensor::Count</a></div><div class="ttdoc">Keep last – the total number of sensor types. </div><div class="ttdef"><b>Definition:</b> <a href="Sensor_8hpp_source.htm#l00027">Sensor.hpp:27</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div>
<div id="footer-container">
<div id="footer">
SFML Copyright © Laurent Gomila
</div>
</div>
</body>
</html>