共通 Nuitrack 操作にとって重要なクラスです。詳細...

#include <Nuitrack.h>

Public Types
typedef std::function< void(IssuesData::Ptr)>	OnIssueUpdate
	問題更新リクエストのためのコールバックタイプ。詳細...

Static Public メンバー関数
static void	init (const std::string &config="")
	Nuitrack を初期化します。詳細...

static void	run ()
	センサーにより提供されたデータの処理を開始します。詳細...

static void	update ()
	Nuitrack の更新を初期化します。詳細...

static void	update (std::shared_ptr< HeaderOnlyAPI_Module > module)
	Nuitrack モジュールデータ更新を開始します。詳細...

static void	waitUpdate (std::shared_ptr< HeaderOnlyAPI_Module > module)
	Nuitrack モジュール更新の初期化を行い、完了するまで待ちます。詳細...

static void	release ()
	データ処理を停止し、既存の Nuitrack モジュールをすべて破壊します。詳細...

static void	setConfigValue (const std::string &key, const std::string &value)
	Nuitrack 設定パラメーターの値を設定します。詳細...

static std::string	getConfigValue (const std::string &key)
	Nuitrack 設定パラメーターの値を取得します。詳細...

static std::string	getInstancesJson ()
	Nuitrack インスタンスベース API の JSON ストリングを取得します。詳細...

static uint64_t	connectOnIssuesUpdate (const OnIssueUpdate &callback)
	問題更新リクエストのためのコールバックを追加します。詳細...

static void	onIssuesUpdateCallback (IssueTrackerData *data)

static void	disconnectOnIssuesUpdate (uint64_t handler)
	問題更新リクエストのためのコールバックを削除します。詳細...

詳細な説明

共通 Nuitrack 操作にとって重要なクラスです。

このクラスは、Nuitrack の共通操作のアクセスポイントです。このクラスは、すべてのメンバー関数が static なため、インスタンスを作成する必要がありません。

センサー使用時に起きことのある問題 (ユーザーがオブジェクトで隠れる / センサー FOV 枠に寄り過ぎ) の中には、Nuitrack::OnIssueUpdate コールバックによって対処できます。Nuitrack::connectOnIssuesUpdate を使って、生じている問題に関する情報を得ることができます。

Nuitrack モジュールや Nuitrack 主要クラスからデータ更新を行うためのコールバックは自動的に呼び出されません。新しいデータのリクエストに Nuitrack::update または Nuitrack::waitUpdate メソッドを使用します。

メンバー Typedef ドキュメント

typedef std::function<void (IssuesData::Ptr)> tdv::nuitrack::Nuitrack::OnIssueUpdate

問題更新リクエストのためのコールバックタイプ。

関連項目: tdv::nuitrack::IssuesData; tdv::nuitrack::Issue; connectOnIssuesUpdate

メンバー関数ドキュメント

static uint64_t tdv::nuitrack::Nuitrack::connectOnIssuesUpdate ( const OnIssueUpdate & callback )

インライン静的

問題更新リクエストのためのコールバックを追加します。

パラメーター

[in] callback 問題更新リクエストの際に呼び出されるコールバック。

戻り値: 登録されたコールバック IDコールバックを削除する際に使用します。

関連項目: disconnectOnIssuesUpdate

static void tdv::nuitrack::Nuitrack::disconnectOnIssuesUpdate ( uint64_t handler )

インライン静的

問題更新リクエストのためのコールバックを削除します。

パラメーター

[in] handler 直前に追加されたコールバックの ID。

関連項目: connectOnIssuesUpdate

static std::string tdv::nuitrack::Nuitrack::getConfigValue ( const std::string & key )

インライン静的

Nuitrack 設定パラメーターの値を取得します。

パラメーター

key パラメーターキー

戻り値: パラメーターの値

例外

tdv::nuitrack::Exception

static std::string tdv::nuitrack::Nuitrack::getInstancesJson ( )

インライン静的

Nuitrack インスタンスベース API の JSON ストリングを取得します。

戻り値: JSON ストリング

例外

tdv::nuitrack::Exception

static void tdv::nuitrack::Nuitrack::init ( const std::string & config = "" )

インライン静的

Nuitrack を初期化します。

他のどの Nuitrack API 関数を使うよりも前に呼び出します。

注意: Android OS の場合: 設定ファイルは、Nuitrack.apk インストール後の未展開アセット (データ) を含むフォルダー内に存在します。

パラメーター

config Nuitrack 初期化のための設定ファイル。

警告: config の値は、自動的に設定されますので、設定を行わないでください。nuitrack.config のパスを指定するのは、nuitrack.config のデフォルトの保存先 (Nuitrack runtime インストール後に定義) が変更されている場合だけです。

例外

tdv::nuitrack::Exception

サンプル:: nuitrack_console_sample/src/main.cpp.

static void tdv::nuitrack::Nuitrack::onIssuesUpdateCallback ( IssueTrackerData * data )

インライン静的

警告: 内部使用のみ。

static void tdv::nuitrack::Nuitrack::release ( )

インライン静的

データ処理を停止し、既存の Nuitrack モジュールをすべて破壊します。

注意: リリース後に Nuitrack を再起動するには、Nuitrack::init を呼び出し、必要なモジュールをすべて作成する必要があります。

例外

tdv::nuitrack::Exception

サンプル:: nuitrack_console_sample/src/main.cpp.

static void tdv::nuitrack::Nuitrack::run ( )

インライン静的

センサーにより提供されたデータの処理を開始します。

データ処理の段階は、既存のモジュールオブジェクトによって決まります。データは非同期的に処理されます。

例外

tdv::nuitrack::Exception

サンプル:: nuitrack_console_sample/src/main.cpp.

static void tdv::nuitrack::Nuitrack::setConfigValue	(	const std::string &	key,
		const std::string &	value
	)

インライン静的

Nuitrack 設定パラメーターの値を設定します。

パラメーター

key	パラメーターキー
value	パラメーターの値

例外

tdv::nuitrack::Exception

static void tdv::nuitrack::Nuitrack::update ( )

インライン静的

Nuitrack の更新を初期化します。

作成されたすべての Nuitrack モジュールから新しいデータをリクエストする。モジュールコールバックすべてが呼び出されます。データの同期は実行されません。

注意: 非ブロッキング操作。

例外

tdv::nuitrack::Exception

static void tdv::nuitrack::Nuitrack::update ( std::shared_ptr< HeaderOnlyAPI_Module > module )

インライン静的

Nuitrack モジュールデータ更新を初期化します。

Nuitrack モジュールから新しいデータをリクエストする。データが利用可能になると、規定のモジュールに対応するコールバックとそれに必要なモジュールすべてが呼び出されます。これらのコールバックに送られたデータは同期されますので、コールバックのコールはすべて一致します。コールバックの呼び出し指示は、モジュール依存性のつながりに基づいて定義されます (独立から依存)。特定のモジュールに属するコールバックの呼び出し指示は、モジュールの内部組織に基づいて定義されます。