1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 5 <meta http-equiv="Content-Style-Type" content="text/css" /> 6 <link rel="stylesheet" href="../../../../css/manpage.css" type="text/css" /> 7 <style type="text/css"><!-- 8 span.static_style 9 { 10 font-size : 8pt; 11 color : white; 12 font-weight : bold; 13 background : #44f; 14 border-left : solid 1px #aaf; 15 border-top : solid 1px #aaf; 16 border-right : solid 1px #00c; 17 border-bottom : solid 1px #00c; 18 padding-left : 2px; 19 padding-right : 2px; 20 } 21 22 span.virtual_style 23 { 24 font-size : 8pt; 25 color : white; 26 font-weight : bold; 27 background : #0a0; 28 border-left : solid 1px #0f0; 29 border-top : solid 1px #0f0; 30 border-right : solid 1px #060; 31 border-bottom : solid 1px #060; 32 padding-left : 2px; 33 padding-right : 2px; 34 } 35 36 span.protected_style 37 { 38 font-size : 8pt; 39 color : white; 40 font-weight : bold; 41 background : #444; 42 border-left : solid 1px #ccc; 43 border-top : solid 1px #ccc; 44 border-right : solid 1px #222; 45 border-bottom : solid 1px #222; 46 padding-left : 2px; 47 padding-right : 2px; 48 } 49 --></style> 50 <title>nn::hid::CTR::GyroscopeReader</title> 51 </head> 52 <body> 53 <h1><CODE>nn::hid::CTR::GyroscopeReader</CODE> Class</h1> 54 <h2>Syntax</h2> 55 <div class="section"> 56 <pre class="definition">class GyroscopeReader : private ADLFireWall::NonCopyable<GyroscopeReader></pre> 57 </div> 58 <h2>Description</h2> 59 <div class="section"> 60 <p>Class for loading sampling data from the gyro sensor.</p><p>Note: The gyro sensor has an average sampling cycle of 10 ms. </p><p>Because gyro sensor sampling takes place after an instance of this class has been generated, the loading of sampling data occurs 10 ms after the class instance has been generated. Furthermore, because an instance of <CODE>AccelerometerReader</CODE> is maintained internally, when the gyro sensor is used the accelerometer is also automatically activated. </p><p>You can obtain processed output values using the <CODE><a href="../../../../nn/hid/CTR/GyroscopeReader/EnableAxisRotation.html">nn::hid::GyroscopeReader::EnableAxisRotation</a></CODE> function. By processing the data you can obtain output values as if the sensor was positioned at an incline. For details, see the function reference. </p><p>The axes of the gyro sensor are as follows:<br /> X+: Leftward direction of +Control Pad<br /> Y+: Into the Touch Screen<br /> Z+: Upward direction of +Control Pad<br /></p></div> 61 <a name="constant" id="constant"> 62 <h2>Member Constants</h2> 63 <div class="section"> 64 <table class="members"> 65 <tr> 66 <td width="100"> 67 <span class="static_style" title="static">S</span> 68 </td> 69 <th> 70 <span class="argument"><a href="./GYROSCOPE_DRIFT_COUNT_MAX.html">GYROSCOPE_DRIFT_COUNT_MAX</a></span> 71 </th> 72 <td>The maximum number for the drift correction count. 2 to the nth power. </td> 73 </tr> </table> 74 </div> 75 </a> <a name="function" id="function"> 76 <h2>Member Functions</h2> 77 <div class="section"> 78 <table class="members"> 79 <tr> 80 <td width="100"> </td> 81 <th> 82 <a href="../../../../nn/hid/CTR/GyroscopeReader/GyroscopeReader.html">GyroscopeReader</a> 83 </th> 84 <td>Constructor.</td> 85 </tr> 86 <tr> 87 <td width="100"> </td> 88 <th> 89 <a href="../../../../nn/hid/CTR/GyroscopeReader/~GyroscopeReader.html">~GyroscopeReader</a> 90 </th> 91 <td>Destructor.</td> 92 </tr> 93 <tr> 94 <td width="100"> </td> 95 <th> 96 <a href="../../../../nn/hid/CTR/GyroscopeReader/Read.html">Read</a> 97 </th> 98 <td>Loads sampling data from the gyro sensor, starting with the latest data. Does not load any data that was previously loaded.</td> 99 </tr> 100 <tr> 101 <td width="100"> </td> 102 <th> 103 <a href="../../../../nn/hid/CTR/GyroscopeReader/ReadLatest.html"><CODE>ReadLatest</CODE></a> 104 </th> 105 <td>Loads the latest sampling data from the gyro sensor. This function, unlike the <CODE><a href="../../../../nn/hid/CTR/GyroscopeReader/Read.html">nn::hid::CTR::GyroscopeReader::Read</a></CODE> function, can load the same sampling data more than once.</td> 106 </tr> 107 <tr> 108 <td width="100"> </td> 109 <th> 110 <a href="../../../../nn/hid/CTR/GyroscopeReader/Reset.html">Reset</a> 111 </th> 112 <td>Initializes the internal state. </td> 113 </tr> 114 <tr> 115 <td width="100"> </td> 116 <th> 117 <a href="../../../../nn/hid/CTR/GyroscopeReader/SetAngle.html">SetAngle</a> 118 </th> 119 <td>Uses arbitrary values to reset <code>angle</code> in the <CODE><a href="../../../../nn/hid/CTR/GyroscopeStatus/Overview.html">GyroscopeStatus</a></CODE> structure, which is obtained by the <CODE>Read</CODE> function.</td> 120 </tr> 121 <tr> 122 <td width="100"> </td> 123 <th> 124 <a href="../../../../nn/hid/CTR/GyroscopeReader/SetDirection.html">SetDirection</a> 125 </th> 126 <td>Uses arbitrary values to reset <code>direction</code> in the <CODE><a href="../../../../nn/hid/CTR/GyroscopeStatus/Overview.html">GyroscopeStatus</a></CODE> structure, which is obtained by the <CODE>Read</CODE> function.</td> 127 </tr> 128 <tr> 129 <td width="100"> </td> 130 <th> 131 <a href="../../../../nn/hid/CTR/GyroscopeReader/SetDirectionMagnification.html">SetDirectionMagnification</a> 132 </th> 133 <td>Sets the angular speed value that will be used when internally calculating <CODE>direction</CODE> in the <CODE><a href="../../../../nn/hid/CTR/GyroscopeStatus/Overview.html">GyroscopeStatus</a></CODE> structure, which is obtained by the <CODE>Read</CODE> function.</td> 134 </tr> 135 <tr> 136 <td width="100"> </td> 137 <th> 138 <a href="../../../../nn/hid/CTR/GyroscopeReader/SetAngleMagnification.html">SetAngleMagnification</a> 139 </th> 140 <td>Sets the scaling to be applied in each direction when calculating angular speed.</td> 141 </tr> 142 <tr> 143 <td width="100"> </td> 144 <th> 145 <a href="../../../../nn/hid/CTR/GyroscopeReader/EnableZeroPlay.html">EnableZeroPlay</a> 146 </th> 147 <td>Enables the zero-point tolerance.</td> 148 </tr> 149 <tr> 150 <td width="100"> </td> 151 <th> 152 <a href="../../../../nn/hid/CTR/GyroscopeReader/DisableZeroPlay.html">DisableZeroPlay</a> 153 </th> 154 <td>Disables the zero-point play.</td> 155 </tr> 156 <tr> 157 <td width="100"> </td> 158 <th> 159 <a href="../../../../nn/hid/CTR/GyroscopeReader/IsEnableZeroPlay.html">IsEnableZeroPlay</a> 160 </th> 161 <td>Checks whether zero-point play is enabled.</td> 162 </tr> 163 <tr> 164 <td width="100"> </td> 165 <th> 166 <a href="../../../../nn/hid/CTR/GyroscopeReader/GetZeroPlayEffect.html">GetZeroPlayEffect</a> 167 </th> 168 <td>Gets the effective extent of the zero-point play correction process.</td> 169 </tr> 170 <tr> 171 <td width="100"> </td> 172 <th> 173 <a href="../../../../nn/hid/CTR/GyroscopeReader/SetZeroPlayParam.html">SetZeroPlayParam</a> 174 </th> 175 <td>Sets the zero-point (stationary) play.</td> 176 </tr> 177 <tr> 178 <td width="100"> </td> 179 <th> 180 <a href="../../../../nn/hid/CTR/GyroscopeReader/GetZeroPlayParam.html">GetZeroPlayParam</a> 181 </th> 182 <td>Gets the zero-point play.</td> 183 </tr> 184 <tr> 185 <td width="100"> </td> 186 <th> 187 <a href="../../../../nn/hid/CTR/GyroscopeReader/ResetZeroPlayParam.html">ResetZeroPlayParam</a> 188 </th> 189 <td>Initializes zero-point play.</td> 190 </tr> 191 <tr> 192 <td width="100"> </td> 193 <th> 194 <a href="../../../../nn/hid/CTR/GyroscopeReader/EnableZeroDrift.html">EnableZeroDrift</a> 195 </th> 196 <td>Enables zero-point drift correction.</td> 197 </tr> 198 <tr> 199 <td width="100"> </td> 200 <th> 201 <a href="../../../../nn/hid/CTR/GyroscopeReader/DisableZeroDrift.html">DisableZeroDrift</a> 202 </th> 203 <td>Disables zero-point drift correction.</td> 204 </tr> 205 <tr> 206 <td width="100"> </td> 207 <th> 208 <a href="../../../../nn/hid/CTR/GyroscopeReader/IsEnableZeroDrift.html">IsEnableZeroDrift</a> 209 </th> 210 <td>Checks whether zero-point drift correction is enabled.</td> 211 </tr> 212 <tr> 213 <td width="100"> </td> 214 <th> 215 <a href="../../../../nn/hid/CTR/GyroscopeReader/GetZeroDriftEffect.html">GetZeroDriftEffect</a> 216 </th> 217 <td>Gets the effective extent of zero-point drift correction. </td> 218 </tr> 219 <tr> 220 <td width="100"> </td> 221 <th> 222 <a href="../../../../nn/hid/CTR/GyroscopeReader/ResetZeroDriftMode.html">ResetZeroDriftMode</a> 223 </th> 224 <td>Initializes the zero-point drift correction mode. </td> 225 </tr> 226 <tr> 227 <td width="100"> </td> 228 <th> 229 <a href="../../../../nn/hid/CTR/GyroscopeReader/SetZeroDriftMode.html">SetZeroDriftMode</a> 230 </th> 231 <td>Sets the zero-point drift correction mode. </td> 232 </tr> 233 <tr> 234 <td width="100"> </td> 235 <th> 236 <a href="../../../../nn/hid/CTR/GyroscopeReader/GetZeroDriftMode.html">GetZeroDriftMode</a> 237 </th> 238 <td>Gets the zero-point drift correction mode. </td> 239 </tr> 240 <tr> 241 <td width="100"> </td> 242 <th> 243 <a href="../../../../nn/hid/CTR/GyroscopeReader/EnableAccRevise.html">EnableAccRevise</a> 244 </th> 245 <td>Enables acceleration correction. </td> 246 </tr> 247 <tr> 248 <td width="100"> </td> 249 <th> 250 <a href="../../../../nn/hid/CTR/GyroscopeReader/DisableAccRevise.html">DisableAccRevise</a> 251 </th> 252 <td>Disables acceleration correction. </td> 253 </tr> 254 <tr> 255 <td width="100"> </td> 256 <th> 257 <a href="../../../../nn/hid/CTR/GyroscopeReader/IsEnableAccRevise.html">IsEnableAccRevise</a> 258 </th> 259 <td>Checks whether acceleration correction is enabled.</td> 260 </tr> 261 <tr> 262 <td width="100"> </td> 263 <th> 264 <a href="../../../../nn/hid/CTR/GyroscopeReader/GetAccReviseEffect.html">GetAccReviseEffect</a> 265 </th> 266 <td>Gets the effective extent of acceleration correction.</td> 267 </tr> 268 <tr> 269 <td width="100"> </td> 270 <th> 271 <a href="../../../../nn/hid/CTR/GyroscopeReader/SetAccReviseParam.html">SetAccReviseParam</a> 272 </th> 273 <td>Sets the extent of acceleration correction. </td> 274 </tr> 275 <tr> 276 <td width="100"> </td> 277 <th> 278 <a href="../../../../nn/hid/CTR/GyroscopeReader/GetAccReviseParam.html">GetAccReviseParam</a> 279 </th> 280 <td>Gets the extent of acceleration correction. </td> 281 </tr> 282 <tr> 283 <td width="100"> </td> 284 <th> 285 <a href="../../../../nn/hid/CTR/GyroscopeReader/ResetAccReviseParam.html">ResetAccReviseParam</a> 286 </th> 287 <td>Initializes the extent of acceleration correction. </td> 288 </tr> 289 <tr> 290 <td width="100"> </td> 291 <th> 292 <a href="../../../../nn/hid/CTR/GyroscopeReader/EnableAxisRotation.html">EnableAxisRotation</a> 293 </th> 294 <td>Enables Axial rotation of the gyro sensor.</td> 295 </tr> 296 <tr> 297 <td width="100"> </td> 298 <th> 299 <a href="../../../../nn/hid/CTR/GyroscopeReader/DisableAxisRotation.html">DisableAxisRotation</a> 300 </th> 301 <td>Disables Axial rotation of the gyro sensor.</td> 302 </tr> 303 <tr> 304 <td width="100"> </td> 305 <th> 306 <a href="../../../../nn/hid/CTR/GyroscopeReader/IsEnableAxisRotation.html">IsEnableAxisRotation</a> 307 </th> 308 <td>Checks whether axial rotation is enabled or disabled for the gyro sensor.</td> 309 </tr> 310 <tr> 311 <td width="100"> </td> 312 <th> 313 <a href="../../../../nn/hid/CTR/GyroscopeReader/SetAxisRotationMatrix.html">SetAxisRotationMatrix</a> 314 </th> 315 <td>Sets the rotation matrix that will be used for axial rotation of the gyro sensor.</td> 316 </tr> 317 <tr> 318 <td width="100"> </td> 319 <th> 320 <a href="../../../../nn/hid/CTR/GyroscopeReader/GetAxisRotationMatrix.html">GetAxisRotationMatrix</a> 321 </th> 322 <td>Gets the rotation matrix that will be used for axial rotation of the gyro sensor.</td> 323 </tr> 324 <tr> 325 <td width="100"> </td> 326 <th> 327 <a href="../../../../nn/hid/CTR/GyroscopeReader/ResetAxisRotationMatrix.html">ResetAxisRotationMatrix</a> 328 </th> 329 <td>Initializes the rotation matrix that will be used for axial rotation of the gyro sensor. At this time the rotation matrix is set to a <a href="../../../../nn/math/MTX34/Overview.html">nn::math::MTX34</a> identity matrix, which is equivalent to when axial rotation is disabled.</td> 330 </tr> </table> 331 </div> 332 </a> 333 <h2>Class Hierarchy</h2> 334 <div class="section"> 335 <p class="hierarchy"><span>ADLFireWall::NonCopyable</span><br /> <b>nn::hid::CTR::GyroscopeReader</b> 336 </p> 337 </div> 338 <hr><p>CONFIDENTIAL</p></body> 339</html>