SwitchInput.h

[詳解]

/// @file
/// @brief InputUnit クラスからスイッチ入力を取得するラッパクラス SwitchInput のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_SWITCHINPUT_H
#define AMDAEMON_SWITCHINPUT_H

#include "amdaemon/env.h"
#include "amdaemon/InputId.h"

namespace amdaemon
{
/// @addtogroup g_io
/// @{

    // InputUnit クラスの前方宣言
    class InputUnit;

    /// @brief InputUnit クラスからスイッチ入力を取得するラッパクラス。
    /// @see Input, InputUnit
    ///
    /// PushSwitchやI/Oボードスイッチ入力等、ON/OFF状態のみを持つ入力に対して用いる。
    ///
    /// @code
    /// #include "amdaemon/Input.h"
    /// 
    /// namespace inputs
    /// {
    ///     // 定数宣言(実値は任意のソースファイルで定義する)
    ///     extern const amdaemon::InputId Up;
    ///     extern const amdaemon::InputId Down;
    /// }
    /// 
    /// void foo()
    /// {
    ///     amdaemon::Input input;
    /// 
    ///     // InputUnit インスタンスから取得
    ///     const auto up = input.getPlayer(0).getSwitch(inputs::Up);
    /// 
    ///     // Up ボタンが押されているか？
    ///     if (up.isOn())
    ///     {
    ///         // 押されている時の処理
    ///     }
    /// 
    ///     // InputUnit インスタンスから直接構築
    ///     const amdaemon::SwitchInput down(input.getPlayer(0), inputs::Down);
    /// 
    ///     // Down ボタンが押されているか？
    ///     if (down.isOn())
    ///     {
    ///         // 押されている時の処理
    ///     }
    /// }
    /// @endcode
    class SwitchInput
    {
    public:
        /// @brief コンストラクタ。
        /// @param[in] unit InputUnit インスタンス参照。
        /// @param[in] id 入力識別ID。
        ///
        /// 引数 id に存在しない入力識別IDを指定した場合でも例外は発生しない。
        /// ただしメンバ関数 #exists は false を返す。
        SwitchInput(const InputUnit& unit, const InputId& id)
            :
            _unit(&unit),
            _id(id)
        {
        }

        // 下記は暗黙の定義を用いる。
        //SwitchInput(const SwitchInput&) = default;
        //‾SwitchInput() = default;
        //SwitchInput& operator=(const SwitchInput&) = default;

        /// @brief 入力が存在するか否かを取得する。
        /// @retval true  存在する場合。
        /// @retval false 存在しない場合。
        inline bool exists() const;

        /// @brief スイッチ入力がON状態であるか否かを取得する。
        /// @retval true  ON状態である場合。
        /// @retval false OFF状態であるか、入力が存在しない場合。
        inline bool isOn() const;

        /// @brief スイッチ入力のON/OFF状態がちょうど切り替わったか否かを取得する。
        /// @retval true  ON/OFF状態がちょうど切り替わった場合。
        /// @retval false ON/OFF状態が切り替わっていないか、入力が存在しない場合。
        inline bool isFlipNow() const;

        /// @brief スイッチ入力がちょうどON状態に切り替わったか否かを取得する。
        /// @retval true  ちょうどON状態に切り替わった場合。
        /// @retval false
        ///     前フレーム時点でON状態であるか、現在OFF状態であるか、
        ///     もしくは入力が存在しない場合。
        inline bool isOnNow() const;

        /// @brief スイッチ入力がちょうどOFF状態に切り替わったか否かを取得する。
        /// @retval true  ちょうどOFF状態に切り替わった場合。
        /// @retval false
        ///     前フレーム時点でOFF状態であるか、現在ON状態であるか、
        ///     もしくは入力が存在しない場合。
        inline bool isOffNow() const;

    private:
        const InputUnit* _unit; ///< InputUnit インスタンス参照。
        InputId _id;            ///< 入力識別ID。
    };

/// @}
} // namespace amdaemon

// 互いに参照しているためこの位置に記述する必要がある
#include "amdaemon/InputUnit.h"

namespace amdaemon
{
    // 入力が存在するか否かを取得する。
    inline bool SwitchInput::exists() const
    {
        return _unit->exists(_id);
    }

    // スイッチ入力がON状態であるか否かを取得する。
    inline bool SwitchInput::isOn() const
    {
        return (this->exists() && _unit->getValue(_id) != 0);
    }

    // スイッチ入力のON/OFF状態がちょうど切り替わったか否かを取得する。
    inline bool SwitchInput::isFlipNow() const
    {
        return (this->exists() && _unit->getDelta(_id) != 0);
    }

    // スイッチ入力がちょうどON状態に切り替わったか否かを取得する。
    inline bool SwitchInput::isOnNow() const
    {
        return (this->exists() && _unit->getDelta(_id) > 0);
    }

    // スイッチ入力がちょうどOFF状態に切り替わったか否かを取得する。
    inline bool SwitchInput::isOffNow() const
    {
        return (this->exists() && _unit->getDelta(_id) < 0);
    }
} // namespace amdaemon

#endif // AMDAEMON_SWITCHINPUT_H