JvsRotaryInput.h

[詳解]

/// @file
/// @brief JVSロータリ入力情報を提供するクラス JvsRotaryInput のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_JVSROTARYINPUT_H
#define AMDAEMON_JVSROTARYINPUT_H

#include "amdaemon/env.h"
#include "amdaemon/util/container.h"

#include <vector>
#include <cstdint>
#include <cstddef>

namespace amdaemon
{
/// @addtogroup g_jvs
/// @{

    // 内部クラスの前方宣言
    class InnerIndexHolder;

    /// @brief JVSロータリ入力情報を提供するクラス。
    /// @see Jvs, JvsNode
    ///
    /// このクラスのインスタンスをアプリ側で直接生成することはできない。
    /// JvsNode クラスのメンバ関数 JvsNode#getAnalogInput から取得すること。
    class JvsRotaryInput
    {
    public:
        /// @brief コンストラクタ。
        /// @note アプリ側からは利用できない。
        explicit JvsRotaryInput(InnerIndexHolder);

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

        /// @brief チャンネル数を取得する。
        /// @return チャンネル数。
        std::size_t getChannelCount() const;

        /// @brief 指定チャンネルのロータリ入力値を取得する。
        /// @param[in] channelIndex チャンネルインデックス。
        /// @return ロータリ入力値。
        ///
        /// @exception Exception
        /// 引数 channelIndex にチャンネル数以上の値を指定した場合。
        /// チャンネル数はメンバ関数 #getChannelCount で取得できる。
        ///
        /// この値そのものにはあまり意味が無く、前フレームとの差分値が重要となる。
        std::uint16_t getValue(std::size_t channelIndex) const;

        /// @brief ロータリ入力値配列を取得する。
        /// @return ロータリ入力値配列。
        ///
        /// 範囲for文や各種アルゴリズム関数に渡すことを想定している。
        ///
        /// - チャンネル数を知りたいだけならばメンバ関数 #getChannelCount を用いること。
        /// - 特定チャンネルのロータリ入力値を取得したいだけならばメンバ関数
        ///   #getValue を用いること。
        std::vector<std::uint16_t> getValues() const
        {
            return
                ::amdaemon::util::toContainer<decltype(getValues())>(
                    getChannelCount(),
                    [this](std::size_t i) { return getValue(i); });
        }

    private:
        std::size_t _nodeIndex; ///< ノードインデックス。

    private:
        // コピー禁止
        JvsRotaryInput(const JvsRotaryInput&);              // 宣言のみ
        JvsRotaryInput& operator=(const JvsRotaryInput&);   // 宣言のみ
    };

/// @}
} // namespace amdaemon

#endif // AMDAEMON_JVSROTARYINPUT_H