/*---------------------------------------------------------------------------*
  Project:  Horizon
  File:     hid_DeviceStatus.h

  Copyright (C)2009 Nintendo Co., Ltd.  All rights reserved.

  These coded instructions, statements, and computer programs contain
  proprietary information of Nintendo of America Inc. and/or Nintendo
  Company Ltd., and are protected by Federal copyright law.  They may
  not be disclosed to third parties or copied or duplicated in any form,
  in whole or in part, without the prior written consent of Nintendo.

  $Rev: 32018 $
 *---------------------------------------------------------------------------*/

/*! @file
    @brief      デバイスのサンプリングデータを格納する構造体を定義します。

*/

#ifndef NN_HID_CTR_HID_DEVICESTATUS_H_
#define NN_HID_CTR_HID_DEVICESTATUS_H_

#include <nn/types.h>
#include <nn/math/math_Types.h>
#include <nn/config.h>

namespace nn {
namespace hid {
namespace CTR {

/*! @brief      A ボタン  */
const bit32 BUTTON_A                = 0x00000001;
/*! @brief      B ボタン  */
const bit32 BUTTON_B                = 0x00000002;
const bit32 PSEUDO_BUTTON_SELECT    = 0x00000004;
/*! @brief      START ボタン  */
const bit32 BUTTON_START            = 0x00000008;
/*! @brief      十字ボタン 右*/
const bit32 BUTTON_RIGHT            = 0x00000010;
/*! @brief      十字ボタン 左*/
const bit32 BUTTON_LEFT             = 0x00000020;
/*! @brief      十字ボタン 上*/
const bit32 BUTTON_UP               = 0x00000040;
/*! @brief      十字ボタン 下*/
const bit32 BUTTON_DOWN             = 0x00000080;
/*! @brief      R ボタン  */
const bit32 BUTTON_R                = 0x00000100;
/*! @brief      L ボタン  */
const bit32 BUTTON_L                = 0x00000200;
/*! @brief      X ボタン  */
const bit32 BUTTON_X                = 0x00000400;
/*! @brief      Y ボタン  */
const bit32 BUTTON_Y                = 0x00000800;
/*!
    @brief      DEBUG ボタン

    デバッガソフトウェアにある DBG ボタンに対応しています。
*/
const bit32 BUTTON_DEBUG            = 0x00001000;
const bit32 BUTTON_RESERVED         = 0x00002000;
/*! @brief      アナログスティックによる十字ボタンエミュレーションの右*/
const bit32 BUTTON_EMULATION_RIGHT  = 0x10000000;
/*! @brief      アナログスティックによる十字ボタンエミュレーションの左*/
const bit32 BUTTON_EMULATION_LEFT   = 0x20000000;
/*! @brief      アナログスティックによる十字ボタンエミュレーションの上*/
const bit32 BUTTON_EMULATION_UP     = 0x40000000;
/*! @brief      アナログスティックによる十字ボタンエミュレーションの下*/
const bit32 BUTTON_EMULATION_DOWN   = 0x80000000;

/*! @brief      十字ボタン(エミュレーションを含む)以外の入力マスク*/
const bit32 BUTTON_MASK             = BUTTON_A | BUTTON_B | BUTTON_START |
                                      BUTTON_R | BUTTON_L | BUTTON_X | BUTTON_Y | BUTTON_DEBUG;
/*! @brief      十字ボタン(エミュレーションを除く)の入力マスク*/
const bit32 PLUS_BUTTON_MASK        = BUTTON_RIGHT | BUTTON_LEFT | BUTTON_UP | BUTTON_DOWN;
/*! @brief      十字ボタンエミュレーションの入力マスク*/
const bit32 PLUS_BUTTON_EMULATION_MASK  = BUTTON_EMULATION_RIGHT | BUTTON_EMULATION_LEFT | BUTTON_EMULATION_UP | BUTTON_EMULATION_DOWN;
/*! @brief      全ての入力 */
const bit32 ALL_MASK                = BUTTON_MASK | PLUS_BUTTON_MASK | PLUS_BUTTON_EMULATION_MASK;

/*! @brief  アナログスティックのサンプリングデータを格納する構造体です。

*/
typedef struct
{
    /*! @brief  x 座標 ( - nn::hid::CTR::LIMIT_OF_STICK_CLAMP_MAX <= x <= nn::hid::CTR::LIMIT_OF_STICK_CLAMP_MAX )*/
    s16         x;
    /*! @brief  y 座標 ( - nn::hid::CTR::LIMIT_OF_STICK_CLAMP_MAX <= y <= nn::hid::CTR::LIMIT_OF_STICK_CLAMP_MAX )*/
    s16         y;
} AnalogStickStatus;

/*!
    @brief  ボタン、アナログスティックのサンプリングデータを格納する構造体です。
*/
typedef struct
{
    /*! @brief  ボタンを押している間、ボタンに対応するビット(BUTTON_*)をセットします。*/
    bit32             hold;
    /*! @brief  ボタンを押した時だけ、ボタンに対応するビット(BUTTON_*)をセットします。*/
    bit32             trigger;
    /*! @brief  ボタンを離した時だけ、ボタンに対応するビット(BUTTON_*)をセットします。*/
    bit32             release;
    /*! @brief  アナログスティックの入力値です。 AnalogStickStatus を参照してください。*/
    AnalogStickStatus stick;
} PadStatus;

/*!
    @brief  タッチパネルのサンプリングデータを格納する構造体です。

           液晶画面の左上隅を原点とした液晶のドットに対応した座標をとります。
           タッチペンでタッチできない外周 5 ドット は内側へクランプされます。
*/
typedef struct
{
    /*! @brief  x 座標 ( 5 <= x <= 314 )*/
    u16         x;
    /*! @brief  y 座標 ( 5 <= y <= 234 )*/
    u16         y;
    /*! @brief  接触判定 ( 0 : ペンアップ、1 : タッチ )*/
    u8          touch;
    NN_PADDING3;
} TouchPanelStatus;

/*!
    @brief  加速度センサのサンプリングデータを格納する構造体です。
*/
typedef struct
{
    /*! @brief  x 座標 ( - nn::hid::CTR::MAX_OF_ACCELEROMETER_VALUE <= x <= nn::hid::CTR::MAX_OF_ACCELEROMETER_VALUE )*/
    s16         x;
    /*! @brief  y 座標 ( - nn::hid::CTR::MAX_OF_ACCELEROMETER_VALUE <= y <= nn::hid::CTR::MAX_OF_ACCELEROMETER_VALUE )*/
    s16         y;
    /*! @brief  z 座標 ( - nn::hid::CTR::MAX_OF_ACCELEROMETER_VALUE <= z <= nn::hid::CTR::MAX_OF_ACCELEROMETER_VALUE )*/
    s16         z;
}AccelerometerStatus;

/*!
    @brief  加速度センサの加速度値 ( 単位は G ) を格納する構造体です。
*/
typedef struct
{
    /*! @brief  x 座標 ( -1.81 <= x <= 1.81 )<BR> 注意 ) 値域は変更の可能性があります。*/
    f32         x;
    /*! @brief  y 座標 ( -1.81 <= y <= 1.81 )<BR> 注意 ) 値域は変更の可能性があります。*/
    f32         y;
    /*! @brief  z 座標 ( -1.81 <= z <= 1.81 )<BR> 注意 ) 値域は変更の可能性があります。*/
    f32         z;
}AccelerationFloat;

/*!
    @brief          三次元姿勢を格納する構造体です。
*/
struct Direction{
public :
    /*! @brief 姿勢のx成分です */
    nn::math::VEC3 x;/**/

    /*! @brief 姿勢のy成分です */
    nn::math::VEC3 y;

    /*! @brief 姿勢のz成分です */
    nn::math::VEC3 z;

public :
    /*! @brief コンストラクタです */
    Direction()
    {};

    /*! @brief メンバをベクトルからコピーするコンストラクタです */
    Direction(const nn::math::VEC3& vecx,const nn::math::VEC3& vecy,const nn::math::VEC3& vecz)
    :x(vecx),y(vecy),z(vecz){}

    /*! @brief 行列の対応要素からメンバに値をコピーするコンストラクタです */
    Direction(const nn::math::MTX33 &mtx33)
    :x(mtx33.v[0]),y(mtx33.v[1]),z(mtx33.v[2]){}

    /*! @brief メンバからMTX33構造体を生成します */
    nn::math::MTX33 ToMTX33()
    {
        return nn::math::MTX33(
            x.x,x.y,x.z,
            y.x,y.y,y.z,
            z.x,z.y,z.z);
    }
};

/*!
    @brief          ジャイロセンサから取得した情報を保持するための構造体です。

    GyroscopeStatus 構造体は speed, angle, direction メンバで構成され、speed, angle は nn::math::VEC3 型で定義されています。<BR>
    VEC3 型の x は Pitch 方向、y は Yaw 方向、 z に Roll 方向の成分として扱われます。<BR>
    speed は各方向の角速度を表し、360dps (角度/秒)を 1.0 とする値が格納されます。<BR>
    angle は各方向の角度を表し、360度を 1.0 とする値が格納されます。<BR>
    direction は 3x3 行列で表現される三次元姿勢になります。
*/
typedef struct {
    /*! @brief      各方向ごとの角速度の値です。360dps を 1.0 とする値です。 */
    nn::math::VEC3  speed;
    /*! @brief      各方向ごとの角速度の値を積算して得られる回転角の値です。360度 を 1.0 とする値です。 */
    nn::math::VEC3  angle;
    /*! @brief      ジャイロの三次元姿勢です。 */
    Direction       direction;
} GyroscopeStatus;

/*! @brief      デバッグパッド の  十字ボタン 上  */
const bit16 DEBUG_PAD_BUTTON_UP           = 0x00000001;
/*! @brief      デバッグパッド の  十字ボタン 左 */
const bit16 DEBUG_PAD_BUTTON_LEFT         = 0x00000002;
/*! @brief      デバッグパッド の ZR トリガー  */
const bit16 DEBUG_PAD_TRIGGER_ZR          = 0x00000004;
/*! @brief      デバッグパッド の X ボタン  */
const bit16 DEBUG_PAD_BUTTON_X            = 0x00000008;
/*! @brief      デバッグパッド の A ボタン  */
const bit16 DEBUG_PAD_BUTTON_A            = 0x00000010;
/*! @brief      デバッグパッド の Y ボタン  */
const bit16 DEBUG_PAD_BUTTON_Y            = 0x00000020;
/*! @brief      デバッグパッド の B ボタン  */
const bit16 DEBUG_PAD_BUTTON_B            = 0x00000040;
/*! @brief      デバッグパッド の ZL トリガー  */
const bit16 DEBUG_PAD_TRIGGER_ZL          = 0x00000080;
const bit16 DEBUG_PAD_RESERVED            = 0x00000100;
/*! @brief      デバッグパッド の R トリガー  */
const bit16 DEBUG_PAD_TRIGGER_R           = 0x00000200;
/*! @brief      デバッグパッド の + ボタン  */
const bit16 DEBUG_PAD_BUTTON_PLUS         = 0x00000400;
/*! @brief      デバッグパッド の HOME ボタン*/
const bit16 DEBUG_PAD_BUTTON_HOME         = 0x00000800;
/*! @brief      デバッグパッド の - ボタン  */
const bit16 DEBUG_PAD_BUTTON_MINUS        = 0x00001000;
/*! @brief      デバッグパッド の L トリガー  */
const bit16 DEBUG_PAD_TRIGGER_L           = 0x00002000;
/*! @brief      デバッグパッド の  十字ボタン 下 */
const bit16 DEBUG_PAD_BUTTON_DOWN         = 0x00004000;
/*! @brief      デバッグパッド の  十字ボタン 右 */
const bit16 DEBUG_PAD_BUTTON_RIGHT        = 0x00008000;


/*!
    @brief  デバッグパッドのボタン、アナログスティックのサンプリングデータを格納する構造体です。
*/
typedef struct
{
    /*! @brief  ボタンを押している間、ボタンに対応するビット(DEBUG_PAD_*)をセットします。*/
    bit16             hold;
    /*! @brief  ボタンを押した時だけ、ボタンに対応するビット(DEBUG_PAD_*)をセットします。*/
    bit16             trigger;
    /*! @brief  ボタンを離した時だけ、ボタンに対応するビット(DEBUG_PAD_*)をセットします。*/
    bit16             release;
    NN_PADDING2;
    /*! @brief  左スティックの x 軸( -1.0f ～ 1.0f )*/
    f32               leftStickX;
    /*! @brief  左スティックの y 軸( -1.0f ～ 1.0f )*/
    f32               leftStickY;
    /*! @brief  右スティックの x 軸( -1.0f ～ 1.0f )*/
    f32               rightStickX;
    /*! @brief  右スティックの y 軸( -1.0f ～ 1.0f )*/
    f32               rightStickY;
} DebugPadStatus;



} // namespace CTR
} // namespace hid
} // namespace nn

#endif  //  NN_HID_CTR_HID_DEVICESTATUS_H_