1 /*---------------------------------------------------------------------------*
2   Project:  Horizon
3   File:     hid_DeviceStatus.h
4 
5   Copyright (C)2009 Nintendo Co., Ltd.  All rights reserved.
6 
7   These coded instructions, statements, and computer programs contain
8   proprietary information of Nintendo of America Inc. and/or Nintendo
9   Company Ltd., and are protected by Federal copyright law.  They may
10   not be disclosed to third parties or copied or duplicated in any form,
11   in whole or in part, without the prior written consent of Nintendo.
12 
13   $Rev: 26511 $
14  *---------------------------------------------------------------------------*/
15 
16 /*! @file
17     @brief      デバイスのサンプリングデータを格納する構造体を定義します。
18 
19 */
20 
21 #ifndef NN_HID_CTR_HID_DEVICESTATUS_H_
22 #define NN_HID_CTR_HID_DEVICESTATUS_H_
23 
24 #include <nn/types.h>
25 #include <nn/math/math_Types.h>
26 #include <nn/config.h>
27 
28 namespace nn {
29 namespace hid {
30 namespace CTR {
31 
32 /*! @brief      A ボタン  */
33 const bit32 BUTTON_A                = 0x00000001;
34 /*! @brief      B ボタン  */
35 const bit32 BUTTON_B                = 0x00000002;
36 const bit32 PSEUDO_BUTTON_SELECT    = 0x00000004;
37 /*! @brief      START ボタン  */
38 const bit32 BUTTON_START            = 0x00000008;
39 /*! @brief      十字ボタン 右*/
40 const bit32 BUTTON_RIGHT            = 0x00000010;
41 /*! @brief      十字ボタン 左*/
42 const bit32 BUTTON_LEFT             = 0x00000020;
43 /*! @brief      十字ボタン 上*/
44 const bit32 BUTTON_UP               = 0x00000040;
45 /*! @brief      十字ボタン 下*/
46 const bit32 BUTTON_DOWN             = 0x00000080;
47 /*! @brief      R ボタン  */
48 const bit32 BUTTON_R                = 0x00000100;
49 /*! @brief      L ボタン  */
50 const bit32 BUTTON_L                = 0x00000200;
51 /*! @brief      X ボタン  */
52 const bit32 BUTTON_X                = 0x00000400;
53 /*! @brief      Y ボタン  */
54 const bit32 BUTTON_Y                = 0x00000800;
55 /*!
56     @brief      DEBUG ボタン
57 
58     デバッガソフトウェアにある DBG ボタンに対応しています。
59 */
60 const bit32 BUTTON_DEBUG            = 0x00001000;
61 const bit32 BUTTON_RESERVED         = 0x00002000;
62 /*! @brief      アナログスティックによる十字ボタンエミュレーションの右*/
63 const bit32 BUTTON_EMULATION_RIGHT  = 0x10000000;
64 /*! @brief      アナログスティックによる十字ボタンエミュレーションの左*/
65 const bit32 BUTTON_EMULATION_LEFT   = 0x20000000;
66 /*! @brief      アナログスティックによる十字ボタンエミュレーションの上*/
67 const bit32 BUTTON_EMULATION_UP     = 0x40000000;
68 /*! @brief      アナログスティックによる十字ボタンエミュレーションの下*/
69 const bit32 BUTTON_EMULATION_DOWN   = 0x80000000;
70 
71 /*! @brief      十字ボタン(エミュレーションを含む)以外の入力マスク*/
72 const bit32 BUTTON_MASK             = BUTTON_A | BUTTON_B | BUTTON_START |
73                                       BUTTON_R | BUTTON_L | BUTTON_X | BUTTON_Y | BUTTON_DEBUG;
74 /*! @brief      十字ボタン(エミュレーションを除く)の入力マスク*/
75 const bit32 PLUS_BUTTON_MASK        = BUTTON_RIGHT | BUTTON_LEFT | BUTTON_UP | BUTTON_DOWN;
76 /*! @brief      十字ボタンエミュレーションの入力マスク*/
77 const bit32 PLUS_BUTTON_EMULATION_MASK  = BUTTON_EMULATION_RIGHT | BUTTON_EMULATION_LEFT | BUTTON_EMULATION_UP | BUTTON_EMULATION_DOWN;
78 /*! @brief      全ての入力 */
79 const bit32 ALL_MASK                = BUTTON_MASK | PLUS_BUTTON_MASK | PLUS_BUTTON_EMULATION_MASK;
80 
81 /*! @brief  アナログスティックのサンプリングデータを格納する構造体です。
82 
83 */
84 typedef struct
85 {
86     /*! @brief  x 座標 ( - nn::hid::CTR::LIMIT_OF_STICK_CLAMP_MAX <= x <= nn::hid::CTR::LIMIT_OF_STICK_CLAMP_MAX )*/
87     s16         x;
88     /*! @brief  y 座標 ( - nn::hid::CTR::LIMIT_OF_STICK_CLAMP_MAX <= y <= nn::hid::CTR::LIMIT_OF_STICK_CLAMP_MAX )*/
89     s16         y;
90 } AnalogStickStatus;
91 
92 /*!
93     @brief  ボタン、アナログスティックのサンプリングデータを格納する構造体です。
94 */
95 typedef struct
96 {
97     /*! @brief  ボタンを押している間、ボタンに対応するビット(BUTTON_*)をセットします。*/
98     bit32             hold;
99     /*! @brief  ボタンを押した時だけ、ボタンに対応するビット(BUTTON_*)をセットします。*/
100     bit32             trigger;
101     /*! @brief  ボタンを離した時だけ、ボタンに対応するビット(BUTTON_*)をセットします。*/
102     bit32             release;
103     /*! @brief  アナログスティックの入力値です。 AnalogStickStatus を参照してください。*/
104     AnalogStickStatus stick;
105 } PadStatus;
106 
107 /*!
108     @brief  タッチパネルのサンプリングデータを格納する構造体です。
109 
110            液晶画面の左上隅を原点とした液晶のドットに対応した座標をとります。
111            タッチペンでタッチできない外周 5 ドット は内側へクランプされます。
112 */
113 typedef struct
114 {
115     /*! @brief  x 座標 ( 5 <= x <= 314 )*/
116     u16         x;
117     /*! @brief  y 座標 ( 5 <= y <= 234 )*/
118     u16         y;
119     /*! @brief  接触判定 ( 0 : ペンアップ、1 : タッチ )*/
120     u8          touch;
121     NN_PADDING3;
122 } TouchPanelStatus;
123 
124 /*!
125     @brief  加速度センサのサンプリングデータを格納する構造体です。
126 */
127 typedef struct
128 {
129     /*! @brief  x 座標 ( - nn::hid::CTR::MAX_OF_ACCELEROMETER_VALUE <= x <= nn::hid::CTR::MAX_OF_ACCELEROMETER_VALUE )*/
130     s16         x;
131     /*! @brief  y 座標 ( - nn::hid::CTR::MAX_OF_ACCELEROMETER_VALUE <= y <= nn::hid::CTR::MAX_OF_ACCELEROMETER_VALUE )*/
132     s16         y;
133     /*! @brief  z 座標 ( - nn::hid::CTR::MAX_OF_ACCELEROMETER_VALUE <= z <= nn::hid::CTR::MAX_OF_ACCELEROMETER_VALUE )*/
134     s16         z;
135 }AccelerometerStatus;
136 
137 /*!
138     @brief  加速度センサの加速度値 ( 単位は G ) を格納する構造体です。
139 */
140 typedef struct
141 {
142     /*! @brief  x 座標 ( -1.81 <= x <= 1.81 )<BR> 注意 ) 値域は変更の可能性があります。*/
143     f32         x;
144     /*! @brief  y 座標 ( -1.81 <= y <= 1.81 )<BR> 注意 ) 値域は変更の可能性があります。*/
145     f32         y;
146     /*! @brief  z 座標 ( -1.81 <= z <= 1.81 )<BR> 注意 ) 値域は変更の可能性があります。*/
147     f32         z;
148 }AccelerationFloat;
149 
150 /*!
151     @brief          三次元姿勢を格納する構造体です。
152 */
153 struct Direction{
154 public :
155     /*! @brief 姿勢のx成分です */
156     nn::math::VEC3 x;/**/
157 
158     /*! @brief 姿勢のy成分です */
159     nn::math::VEC3 y;
160 
161     /*! @brief 姿勢のz成分です */
162     nn::math::VEC3 z;
163 
164 public :
165     /*! @brief コンストラクタです */
DirectionDirection166     Direction()
167     {};
168 
169     /*! @brief メンバをベクトルからコピーするコンストラクタです */
DirectionDirection170     Direction(const nn::math::VEC3& vecx,const nn::math::VEC3& vecy,const nn::math::VEC3& vecz)
171     :x(vecx),y(vecy),z(vecz){}
172 
173     /*! @brief 行列の対応要素からメンバに値をコピーするコンストラクタです */
DirectionDirection174     Direction(const nn::math::MTX33 &mtx33)
175     :x(mtx33.v[0]),y(mtx33.v[1]),z(mtx33.v[2]){}
176 
177     /*! @brief メンバからMTX33構造体を生成します */
ToMTX33Direction178     nn::math::MTX33 ToMTX33()
179     {
180         return nn::math::MTX33(
181             x.x,x.y,x.z,
182             y.x,y.y,y.z,
183             z.x,z.y,z.z);
184     }
185 };
186 
187 /*!
188     @brief          ジャイロ情報を保持するための構造体です。
189 
190     レートジャイロスコープセンサにより Pitch、Yaw、Roll の 3 方向の角速度を取得できます。<BR>
191     各方向の値は Read 関数で取得する KmplsStatus 構造体に格納されます。<BR>
192     GyroscopeStatus 構造体は speed, angle, direction メンバで構成され、speed, angle は VEC3 型で定義されています。<BR>
193     VEC3 型の x は Pitch 方向、y は Yaw 方向、 z に Roll 方向の成分として扱われます。<BR>
194     speed は各方向の角速度を表し、360dps (角度/秒)を 1.0 とする値が格納されます。<BR>
195     angle は各方向の角度を表し、360度を 1.0 とする値が格納されます。<BR>
196     direction は 3x3 行列で表現される三次元姿勢になります。
197 */
198 typedef struct {
199     /*! @brief      各方向ごとの角速度の値です。360dps を 1.0 とする値です。 */
200     nn::math::VEC3  speed;
201     /*! @brief      各方向ごとの角速度の値を積算して得られる回転角の値です。360度 を 1.0 とする値です。 */
202     nn::math::VEC3  angle;
203     /*! @brief      ジャイロの三次元姿勢です。 */
204     Direction       direction;
205 } GyroscopeStatus;
206 
207 /*! @brief      デバッグパッド の  十字ボタン 上  */
208 const bit16 DEBUG_PAD_BUTTON_UP           = 0x00000001;
209 /*! @brief      デバッグパッド の  十字ボタン 左 */
210 const bit16 DEBUG_PAD_BUTTON_LEFT         = 0x00000002;
211 /*! @brief      デバッグパッド の ZR トリガー  */
212 const bit16 DEBUG_PAD_TRIGGER_ZR          = 0x00000004;
213 /*! @brief      デバッグパッド の X ボタン  */
214 const bit16 DEBUG_PAD_BUTTON_X            = 0x00000008;
215 /*! @brief      デバッグパッド の A ボタン  */
216 const bit16 DEBUG_PAD_BUTTON_A            = 0x00000010;
217 /*! @brief      デバッグパッド の Y ボタン  */
218 const bit16 DEBUG_PAD_BUTTON_Y            = 0x00000020;
219 /*! @brief      デバッグパッド の B ボタン  */
220 const bit16 DEBUG_PAD_BUTTON_B            = 0x00000040;
221 /*! @brief      デバッグパッド の ZL トリガー  */
222 const bit16 DEBUG_PAD_TRIGGER_ZL          = 0x00000080;
223 const bit16 DEBUG_PAD_RESERVED            = 0x00000100;
224 /*! @brief      デバッグパッド の R トリガー  */
225 const bit16 DEBUG_PAD_TRIGGER_R           = 0x00000200;
226 /*! @brief      デバッグパッド の + ボタン  */
227 const bit16 DEBUG_PAD_BUTTON_PLUS         = 0x00000400;
228 /*! @brief      デバッグパッド の HOME ボタン*/
229 const bit16 DEBUG_PAD_BUTTON_HOME         = 0x00000800;
230 /*! @brief      デバッグパッド の - ボタン  */
231 const bit16 DEBUG_PAD_BUTTON_MINUS        = 0x00001000;
232 /*! @brief      デバッグパッド の L トリガー  */
233 const bit16 DEBUG_PAD_TRIGGER_L           = 0x00002000;
234 /*! @brief      デバッグパッド の  十字ボタン 下 */
235 const bit16 DEBUG_PAD_BUTTON_DOWN         = 0x00004000;
236 /*! @brief      デバッグパッド の  十字ボタン 右 */
237 const bit16 DEBUG_PAD_BUTTON_RIGHT        = 0x00008000;
238 
239 
240 /*!
241     @brief  デバッグパッドのボタン、アナログスティックのサンプリングデータを格納する構造体です。
242 */
243 typedef struct
244 {
245     /*! @brief  ボタンを押している間、ボタンに対応するビット(DEBUG_PAD_*)をセットします。*/
246     bit16             hold;
247     /*! @brief  ボタンを押した時だけ、ボタンに対応するビット(DEBUG_PAD_*)をセットします。*/
248     bit16             trigger;
249     /*! @brief  ボタンを離した時だけ、ボタンに対応するビット(DEBUG_PAD_*)をセットします。*/
250     bit16             release;
251     NN_PADDING2;
252     /*! @brief  左スティックの x 軸( -1.0f ~ 1.0f )*/
253     f32               leftStickX;
254     /*! @brief  左スティックの y 軸( -1.0f ~ 1.0f )*/
255     f32               leftStickY;
256     /*! @brief  右スティックの x 軸( -1.0f ~ 1.0f )*/
257     f32               rightStickX;
258     /*! @brief  右スティックの y 軸( -1.0f ~ 1.0f )*/
259     f32               rightStickY;
260 } DebugPadStatus;
261 
262 
263 
264 } // namespace CTR
265 } // namespace hid
266 } // namespace nn
267 
268 #endif  //  NN_HID_CTR_HID_DEVICESTATUS_H_
269