1 /*---------------------------------------------------------------------------*
2 Project: Horizon
3 File: hid_DebugPadReader.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: 17553 $
14 *---------------------------------------------------------------------------*/
15
16 /*! @file
17 @brief DebugPadReader クラスを定義します。
18
19 */
20 #ifndef NN_HID_CTR_HID_DEBUG_PAD_READER_H_
21 #define NN_HID_CTR_HID_DEBUG_PAD_READER_H_
22
23 #include <nn/Handle.h>
24 #include <nn/Result.h>
25 #include <nn/types.h>
26 #include <nn/hid/CTR/hid_Result.h>
27 #include <nn/hid/CTR/hid_Api.h>
28 #include <nn/hid/CTR/hid_pad.h>
29 #include <nn/hid/CTR/hid_DeviceStatus.h>
30 #include <nn/util/util_SizedEnum.h>
31 #include <nn/util/util_NonCopyable.h>
32
33 namespace nn {
34 namespace hid {
35 namespace CTR {
36 /*! @brief デバッグ専用のコントロールパッド(デバッグパッド)のサンプリングデータを読み込むクラスです。
37
38 デバッグパッドは 16 msec 周期でサンプリングされます。<BR>
39 アナログスティックのキャリブレーションは、システムの起動時に行います。また、aボタン、十字ボタン左、 +ボタン、-ボタン を実行中に同時に<BR>
40 押してもキャリブレーションを行います。
41
42 */
43
44 class DebugPadReader : private nn::util::NonCopyable<DebugPadReader>
45 {
46 public:
47 /*!
48 @enum StickClampMode
49 @brief SetStickClampMode( ) で設定するアナログスティックのクランプ方法を示す列挙体です。
50 */
51
52 typedef enum
53 {
54 /*! @brief 遊びのある円形クランプ です。内側を十字形にクランプします。*/
55 STICK_CLAMP_MODE_CIRCLE_WITH_PLAY = 0,
56 /*! @brief 遊びのない円形クランプです。 */
57 STICK_CLAMP_MODE_CIRCLE_WITHOUT_PLAY
58 } StickClampMode;
59
60 /*!
61 @brief コンストラクタです。
62
63 インスタンスを生成する前に @ref nn::hid::CTR::Initialize( ) で初期化してください。
64
65 */
66 DebugPadReader(DebugPad& debugPad=GetDebugPad( ))
m_DebugPad(debugPad)67 : m_DebugPad(debugPad)
68 , m_IndexOfRead(-1)
69 , m_IsReadLatestFirst(true)
70 , m_StickClampMode(STICK_CLAMP_MODE_CIRCLE_WITH_PLAY)
71 , m_TickOfRead(-1)
72 {};
73
74 /*!
75 @brief デストラクタです。
76
77 */
~DebugPadReader()78 ~DebugPadReader( ) {};
79
80 /*!
81 @brief デバッグパッドのサンプリングデータを新しいものから順に読み込みます。以前に読み込んだデータは読み込まれません。
82
83 @param[out] pBufs 新しいものから順にサンプリングデータが読み込まれます。
84 @param[out] pReadLen 読み込んだサンプリングデータの数です。
85 @param[in] bufLen pBufs に読み込めるサンプリングデータの数を指定します。
86 @return なし。
87
88 */
89 void Read(DebugPadStatus* pBufs, s32* pReadLen, s32 bufLen);
90
91 /*!
92 @brief 最新のデバッグパッドのサンプリングデータを読み込みます。 nn::hid::CTR::DebugPadReader::Read( ) とちがい同じサンプリングデータを読み込むことが出来ます。
93
94 trigger、release は前回の ReadLatest( ) の読み込み結果に対して生成されます。<BR><BR>
95
96 @param[out] pBuf サンプリングデータが読み込まれます。
97 @return サンプリングデータの読み込み結果を返します。<BR>
98 true ・・・ 読み込めました。<BR>
99 false ・・・ 読み込めませんでした。(システム起動後あるいはスリープ復帰後の最初のサンプリングが行われ次第、読み込めます。)
100
101 */
102 bool ReadLatest(DebugPadStatus* pBuf);
103
104 /*!
105 @brief アナログスティックのクランプ方法を取得します。
106
107 @return 現在設定されているクランプ方法を返します。
108
109 */
110 StickClampMode GetStickClampMode( ) const;
111
112 /*!
113 @brief アナログスティックのクランプ方法を設定します。
114
115 Read( ) と ReadLatest( ) で 得られるアナログスティックの値が設定された方法でクランプされます。クランプの詳細は、@ref nn::hid::CTR::DebugPadReader::StickClampMode を参照してください。<BR>
116 遊びのある 円形クランプ がデフォルトで設定されています。
117
118 @param[in] mode 設定するクランプ方法です。
119 @return なし。
120
121 */
122 void SetStickClampMode(StickClampMode mode);
123
124 protected:
125 DebugPad& m_DebugPad;
126 s32 m_IndexOfRead;
127 bit16 m_LatestHold;
128 bool m_IsReadLatestFirst;
129 nn::util::SizedEnum1<StickClampMode> m_StickClampMode;
130 NN_PADDING4;
131 s64 m_TickOfRead;
132 };
133
134
135 // inline 定義
136
GetStickClampMode()137 inline DebugPadReader::StickClampMode DebugPadReader::GetStickClampMode( ) const
138 {
139 return m_StickClampMode;
140 }
141
SetStickClampMode(DebugPadReader::StickClampMode mode)142 inline void DebugPadReader::SetStickClampMode(DebugPadReader::StickClampMode mode)
143 {
144 m_StickClampMode = mode;
145 }
146
147 } // namespace CTR {
148 } // namespace hid {
149 } // namespace nn {
150
151 #endif // #ifndef NN_HID_CTR_HID_DEBUG_PAD_READER_H_
152