SONY

mocopi mobile SDK
読み取り中…
検索中…
一致する文字列を見つけられません
Mocopi.Mobile.Sdk.MocopiManager クラス

mocopiセンサーに関わる処理をまとめたクラス
[詳解]

公開メンバ関数

void StartDiscovery (bool excludeSettedPart=false)
 Bluetoothでmocopiセンサーの検索を開始する。

 
void StopDiscovery ()
 mocopiセンサーの検索を停止する。

 
string GetPart (EnumParts part)
 設定された接続部位をもとにmocopiセンサー名を取得する。

 
bool SetPart (EnumParts part, string sensorName)
 指定した接続部位と指定したmocopiセンサーを紐づける。

 
bool RemovePart (EnumParts part)
 接続部位とセンサー名の紐づけを削除する。

 
void CreateBond (string sensorName, EnumParts part)
 mocopiセンサーのペアリングを行う。

 
void StartSensor ()
 ペアリングを行ったmocopiセンサーすべてを接続する。

 
void StartSingleSensor (EnumParts part)
 指定部位のmocopiセンサーと接続を行う。

 
List< EnumPartsGetPartsListWithTargetBody (EnumTargetBodyType bodyType)
 指定したトラッキングタイプで使用する接続部位のリストを取得する。

 
bool IsAllPartsSetted ()
 現在のトラッキングタイプに対応するすべての接続部位に対してmocopiセンサーとの紐づけが完了しているか。

 
bool IsAllPartsSetted (EnumTargetBodyType bodyType)
 指定したトラッキングタイプに対応する全接続部位とセンサーとの紐づけが完了しているか。

 
bool IsAllSensorsReady ()
 使用する接続部位すべてのmocopiセンサーが接続状態か。

 
bool GetPartFromSensorName (string sensorName, out EnumParts part)
 mocopiセンサー名から紐づけされた接続部位を取得する。

 
void DisconnectSensors ()
 接続状態のmocopiセンサーすべてを切断する。

 
void DisconnectSensor (EnumParts part)
 指定部位のmocopiセンサーの接続を切断する。

 
void StopSensor ()
 トラッキング停止と全センサー切断を行う。
Stop tracking and Disconnect All sensors.
 
MocopiHeightStruct GetHeight ()
 キャリブレーションに使用する身長情報を取得する。

 
bool SetHeight (MocopiHeightStruct heightStruct)
 キャリブレーションに使用する身長を設定する。

 
async Task< bool > StartCalibration ()
 キャリブレーションを開始する。

 
bool CancelCalibration ()
 キャリブレーションをキャンセルする。

 
bool StartTracking ()
 トラッキングを開始する。

 
void StopTracking ()
 トラッキングを停止する。

 
bool SetRootPosition (Vector3 position)
 アバターのポジションをリセットする。

 
bool SetFixedHip (bool fixedHip)
 アバターの腰を固定するかを設定する

 
bool ResetPose ()
 アバターのポーズを初期姿勢にリセットする。

 
bool IsSensorConnected (EnumParts part)
 指定部位のmocopiセンサーが接続されているか。

 
void SetTargetBody (EnumTargetBodyType targetBodyType)
 指定したトラッキングタイプを設定して、mocopiセンサーの紐づけを更新する。

 
EnumTargetBodyType GetTargetBody ()
 現在のトラッキングタイプを取得する。

 
bool GetBatteryLevel (string sensorName)
 mocopiセンサーのバッテリー残量を取得する。

 
bool GetOsSettingStatus (EnumOsSettingType type)
 OS設定を取得する(Bluetooth/位置情報)。

 
bool GetAppPermissionStatus (EnumPermissionType type)
 アプリの権限設定を取得する(Bluetooth/位置情報/ストレージ利用)。

 
bool StartMotionRecording ()
 モーション記録を開始する。

 
bool StopMotionRecording ()
 モーション記録を停止する。

 
bool SaveMotionFiles (string fileName="")
 モーションデータをBVHファイルに保存する。

 
bool RenameMotionFile (string oldFileName, string newFilename)
 BVHファイルの名前を変更する。

 
bool DeleteMotionFile (string fileName)
 BVHファイルを削除する。

 
bool GetMotionFileInformations ()
 BVHファイル一覧の情報(ファイル名、サイズ)を取得する。

 
bool SelectMotionExternalStorageUri ()
 BVHファイルの保存先ディレクトリを選択する。

 
string GetMotionExternalStorageUri ()
 BVHファイルの保存先ディレクトリを取得する。

 
void StartMotionStreamingRead (string fileName, int motionFormat)
 BVH読み込みできる状態を開始する。

 
void ReadMotionFrame (int frame)
 BVHファイルの1フレームを読み込む。

 
void StopMotionStreamingRead ()
 BVH読み込みできる状態を停止する。

 
void GetVerifiedFirmwareVersionList ()
 検証済みmocopiセンサーのファームウェアバージョンのリストを取得する。

 
bool IsLatestFirmwareVersion (EnumParts[] parts)
 指定した接続部位のmocopiセンサーのファームウェアバージョンが最新か確認する。

 
Tuple CheckFirmwareVersion (string sensorName)
 指定したmocopiセンサーのファームウェアバージョンを確認する。

 
bool IsSensorConnectedStably (string sensorName)
 キャリブレーションの結果を取得する。

 
EnumFirmwareVersionResultForStableCalibration IsSupportedVersionOfStableCalibration (string sensorName)
 ファームウェアが高性能キャリブレーションに対応しているバージョンかチェック
 
string GetSplitCode ()
 Get split code for Motion file list
 
void RemoveAllCallback ()
 すべてのコールバックを削除する。

 
void AddCallbackOnSensorFound (UnityAction< string > callback)
 OnSensorFoundのコールバックを登録する。

 
void RemoveCallbackOnSensorFound (UnityAction< string > callback)
 OnSensorFoundのコールバックを削除する。

 
void AddCallbackOnSensorConnected (UnityAction< EnumParts, string, EnumCallbackStatus, EnumSensorConnectionErrorStatus?> callback)
 OnSensorConnectedのコールバックを登録する。

 
void RemoveCallbackOnSensorConnected (UnityAction< EnumParts, string, EnumCallbackStatus, EnumSensorConnectionErrorStatus?> callback)
 OnSensorConnectedのコールバックを削除する。

 
void AddCallbackOnSensorDisconnected (UnityAction< string > callback)
 OnSensorDisconnectedのコールバックを登録する。

 
void RemoveCallbackOnSensorDisconnected (UnityAction< string > callback)
 OnSensorDisconnectedのコールバックを削除する。

 
void AddCallbackOnAllSensorReady (UnityAction< EnumCallbackStatus > callback)
 OnAllSensorReadyのコールバックを登録する。

 
void RemoveCallbackOnAllSensorReady (UnityAction< EnumCallbackStatus > callback)
 OnAllSensorReady のコールバックを削除する。

 
void AddCallbackOnCalibrationUpdated (UnityAction< EnumCalibrationCallbackStatus, EnumCalibrationStatus?, string[]> callback)
 OnCalibrationUpdatedのコールバックを登録する。

 
void RemoveCallbackOnCalibrationUpdated (UnityAction< EnumCalibrationCallbackStatus, EnumCalibrationStatus?, string[]> callback)
 OnCalibrationUpdatedのコールバックを削除する。

 
void AddCallbackOnRecordingMotionUpdated (UnityAction< string, EnumRecordingMotionAllStatus > callback)
 OnRecordingMotionUpdatedのコールバックを登録する。

 
void RemoveCallbackOnRecordingMotionUpdated (UnityAction< string, EnumRecordingMotionAllStatus > callback)
 OnRecordingMotionUpdatedのコールバックを削除する。

 
void AddCallbackOnMotionConvertProgressUpdated (UnityAction< int > callback)
 OnMotionConvertProgressUpdatedのコールバックを登録する。

 
void RemoveCallbackOnMotionConvertProgressUpdated (UnityAction< int > callback)
 OnMotionConvertProgressUpdatedのコールバックを削除する。

 
  void AddCallbackOnGetRecordedMotionFileInformations (UnityAction<(string fileName, long fileSize)[]> callback)
 OnGetRecordedMotionFileInformations のコールバックを登録する。

 
void RemoveCallbackOnGetRecordedMotionFileInformations (UnityAction<(string fileName, long fileSize)[]> callback)
 OnGetRecordedMotionFileInformationsのコールバックを登録する。

 
void AddCallbackOnRenameMotionFileCompleted (UnityAction< bool > callback)
 OnRenameMotionFileCompletedのコールバックを登録する。

 
void RemoveCallbackOnRenameMotionFileCompleted (UnityAction< bool > callback)
 OnRenameMotionFileCompletedのコールバックを削除する。

 
void AddCallbackOnDeleteMotionFileCompleted (UnityAction< bool > callback)
 OnDeleteMotionFileCompletedのコールバックを登録する。

 
void RemoveCallbackOnDeleteMotionFileCompleted (UnityAction< bool > callback)
 OnDeleteMotionFileCompletedのコールバックを削除する。

 
void AddCallbackOnRecordingMotionExternalStorageUriSelected (UnityAction< bool > callback)
 OnRecordingMotionExternalStorageUriSelected のコールバックを登録する。

 
void RemoveCallbackOnRecordingMotionExternalStorageUriSelected (UnityAction< bool > callback)
 OnRecordingMotionExternalStorageUriSelectedのコールバックを削除する。

 
void AddCallbackOnFixedHipSwitched (UnityAction< bool > callback)
 OnFixedHipSwitchedのコールバックを登録する。

 
void RemoveCallbackOnFixedHipSwitched (UnityAction< bool > callback)
 OnFixedHipSwitchedのコールバックを削除する。

 
void AddCallbackOnSkeletonDefinitionUpdated (UnityAction< SkeletonDefinitionData > callback)
 OnSkeletonDefinitionUpdatedのコールバックを登録する。

 
void RemoveCallbackOnSkeletonDefinitionUpdated (UnityAction< SkeletonDefinitionData > callback)
 OnSkeletonDefinitionUpdatedのコールバックを削除する。

 
void AddCallbackOnSkeletonUpdated (UnityAction< SkeletonData > callback)
 OnSkeletonUpdatedのコールバックを登録する。

 
void RemoveCallbackOnSkeletonUpdated (UnityAction< SkeletonData > callback)
 OnSkeletonUpdatedのコールバックを削除する。

 
void AddCallbackOnSensorBatteryLevelUpdated (UnityAction< string, int, EnumCallbackStatus > callback)
 OnSensorBatteryLevelUpdate のコールバックを登録する。

 
void RemoveCallbackOnSensorBatteryLevelUpdated (UnityAction< string, int, EnumCallbackStatus > callback)
 OnSensorBatteryLevelUpdate のコールバックを削除する。

 
void OnSensorConnectedStably (string sensorName, int result)
 mocopiセンサーファームウェアからのmocopiセンサーキャリブレーションの計測完了コールバックを受け取り、アプリへ通知するコールバックをキック。

 

公開変数類

MocopiEventHandlerSettings EventHandleSettings
 ユーザー設定用のコールバック群

 
Dictionary< EnumParts, string > ConnectedSensorsDictionary = new Dictionary<EnumParts, string>()
 接続中mocopiセンサーのディクショナリ

 

プロパティ

static MocopiManager Instance [get]
 シングルトン用の自分自身のインスタンス

 
MocopiAvatar MocopiAvatar [get, set]
 mocopiで使用するアバター

 
LogUtility Logger [get]
 ログ出力用クラス

 
static EnumRunMode RunMode [get, set]
 SDKの動作モード

 
EnumTargetBodyType TargetBodyType [get]
 トラッキングタイプ

 
bool IsCalibrationCompleted [get]
 キャリブレーションに成功したか。

 
bool IsDiscoverying = false [get]
 センサー探索中かどうか。

 
bool IsTracking = false [get]
 トラッキング中かどうか。

 
bool IsFixedHip = false [get]
 腰固定するかどうか。

 
bool IsRecordingMotion = false [get]
 モーション記録中かどうか。

 
List< string > OlderSensorArray [get]
 mocopiセンサーのファームウェアのバージョンが古い状態のセンサーリスト

 
Version LatestFirmwareVersion = null [get]
 センサーの最新ファームウェアバージョン

 
SynchronizationContext SynchronizationContext [get, set]
 メインスレッド実行用のコンテキスト

 
bool IsAutoMappingBodyPart = false [get, set]
 高度な機能の接続部位への変換を行うかどうか。

 

詳解

mocopiセンサーに関わる処理をまとめたクラス

メソッド詳解

◆ AddCallbackOnAllSensorReady()

void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnAllSensorReady ( UnityAction< EnumCallbackStatus > callback)

OnAllSensorReadyのコールバックを登録する。

mocopiセンサーが接続された時に、コールバックOnAllSensorReadyで通知される。
コールバックの引数: 現在設定されているトラッキングタイプの部位すべてに対して接続完了したか(bool)

引数
callbackコールバック

◆ AddCallbackOnCalibrationUpdated()

void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnCalibrationUpdated ( UnityAction< EnumCalibrationCallbackStatus, EnumCalibrationStatus?, string[]> callback)

OnCalibrationUpdatedのコールバックを登録する。

キャリブレーションステータスが更新された時に、コールバックOnCalibrationUpdatedで通知される。
キャリブレーションは、静止/一歩前進/静止の3つのフェーズがあり、それぞれ状態が変わったときにコールバックで通知される。
キャリブレーション結果がWarningである場合は、トラッキング精度に影響を及ぼす可能性があるので、再度キャリブレーションを行うことを推奨する。
コールバックの引数: キャリブレーションステータス( EnumCalibrationCallbackStatus )
キャリブレーション結果( EnumCalibrationStatus )
キャリブレーションしたmocopiセンサーリスト(string[])

引数
callbackコールバック

◆ AddCallbackOnDeleteMotionFileCompleted()

void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnDeleteMotionFileCompleted ( UnityAction< bool > callback)

OnDeleteMotionFileCompletedのコールバックを登録する。

BVHファイルの削除処理の結果を、コールバックOnDeleteMotionFileCompletedで通知される。
コールバックの引数: 削除に成功したか(bool)

引数
callbackコールバック

◆ AddCallbackOnFixedHipSwitched()

void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnFixedHipSwitched ( UnityAction< bool > callback)

OnFixedHipSwitchedのコールバックを登録する。

アバターの腰を固定する設定が変更された時に、コールバックOnFixedHipSwitchedで通知される。
コールバックの引数: 腰固定ONでtrue。腰固定OFFでfalse。

引数
callbackコールバック

◆ AddCallbackOnGetRecordedMotionFileInformations()

  void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnGetRecordedMotionFileInformations ( UnityAction<(string fileName, long fileSize)[]> callback)

OnGetRecordedMotionFileInformations のコールバックを登録する。

BVHファイルの一覧取得の結果が、コールバックOnGetRecordedMotionFileInformationsで通知される。
コールバックの引数: ファイルごとの情報(配列)
1要素に、ファイル名(string)とファイルサイズ(long)の情報が存在する。


引数
callbackコールバック

◆ AddCallbackOnMotionConvertProgressUpdated()

void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnMotionConvertProgressUpdated ( UnityAction< int > callback)

OnMotionConvertProgressUpdatedのコールバックを登録する。

モーション記録の結果を保存する際の進捗を、コールバックOnMotionConvertProgressUpdatedで通知する。
進捗が100になる前に、なにがしかの理由で中断された場合、保存自体の処理は失敗する。
コールバックの引数: モーション保存の進捗率(int)

引数
callbackコールバック

◆ AddCallbackOnRecordingMotionExternalStorageUriSelected()

void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnRecordingMotionExternalStorageUriSelected ( UnityAction< bool > callback)

OnRecordingMotionExternalStorageUriSelected のコールバックを登録する。

モーション記録をする際の保存先ディレクトリ選択の結果を、コールバックOnRecordingMotionExternalStorageUriSelectedで通知される。
コールバックの引数: ディレクトリ選択に成功したか(bool)

引数
callbackコールバック

◆ AddCallbackOnRecordingMotionUpdated()

void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnRecordingMotionUpdated ( UnityAction< string, EnumRecordingMotionAllStatus > callback)

OnRecordingMotionUpdatedのコールバックを登録する。

モーション記録のステータスが更新された時に、コールバックOnRecordingMotionUpdatedで通知される。
モーション記録の開始時/保存完了時/エラー発生時で、それぞれコールバックで通知される。
コールバックの引数: モーション記録ステータスメッセージ(string)
モーション記録ステータス( EnumRecordingMotionAllStatus )

引数
callbackコールバック

◆ AddCallbackOnRenameMotionFileCompleted()

void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnRenameMotionFileCompleted ( UnityAction< bool > callback)

OnRenameMotionFileCompletedのコールバックを登録する。

BVHファイルの命名変更処理の結果を、コールバックOnRenameMotionFileCompletedで通知される。
コールバックの引数: 命名変更に成功したか(bool)

引数
callbackコールバック

◆ AddCallbackOnSensorBatteryLevelUpdated()

void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnSensorBatteryLevelUpdated ( UnityAction< string, int, EnumCallbackStatus > callback)

OnSensorBatteryLevelUpdate のコールバックを登録する。

mocopiセンサーファームウェアからのバッテリー残量の取得成功コールバックを受け取り、コールバックOnSensorBatteryLevelUpdatedへ通知する。
コールバックの引数: センサー名(string)
mocopiセンサーのバッテリー残量(int)
コールバック結果( EnumCallbackStatus )

引数
callbackコールバック

◆ AddCallbackOnSensorConnected()

void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnSensorConnected ( UnityAction< EnumParts, string, EnumCallbackStatus, EnumSensorConnectionErrorStatus?> callback)

OnSensorConnectedのコールバックを登録する。

mocopiセンサーの接続の結果が、コールバックOnSensorConnectedで通知される。
コールバックの引数: 接続部位( EnumParts )
接続するmocopiセンサー名(string)
コールバック結果( EnumCallbackStatus )
エラーステータス( EnumSensorConnectionErrorStatus )※接続成功した場合はnullが入る

引数
callbackコールバック

◆ AddCallbackOnSensorDisconnected()

void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnSensorDisconnected ( UnityAction< string > callback)

OnSensorDisconnectedのコールバックを登録する。

mocopiセンサーが切断された時に、コールバックOnSensorDisconnectedで通知される。
コールバックの引数: 切断されたmocopiセンサー名(string)

引数
callbackコールバック

◆ AddCallbackOnSensorFound()

void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnSensorFound ( UnityAction< string > callback)

OnSensorFoundのコールバックを登録する。

StartDiscoveryを実行した後、mocopiセンサーが見つかった時に、コールバックOnSensorFoundで通知される。
コールバックの引数: 発見したmocopiセンサー名(string)

引数
callbackコールバック

◆ AddCallbackOnSkeletonDefinitionUpdated()

void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnSkeletonDefinitionUpdated ( UnityAction< SkeletonDefinitionData > callback)

OnSkeletonDefinitionUpdatedのコールバックを登録する。

トラッキング開始時に、コールバックOnSkeletonDefinitionUpdatedで通知される。
コールバックの引数: スケルトン定義データの構造体(SkeletonDefinitionData)

引数
callbackコールバック

◆ AddCallbackOnSkeletonUpdated()

void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnSkeletonUpdated ( UnityAction< SkeletonData > callback)

OnSkeletonUpdatedのコールバックを登録する。

トラッキング時に、スケルトン情報がコールバック OnSkeletonUpdatedで通知される(50FPS)。
コールバックの引数: スケルトンフレームデータの構造体(SkeletonData)

引数
callbackコールバック

◆ CancelCalibration()

bool Mocopi.Mobile.Sdk.MocopiManager.CancelCalibration ( )

キャリブレーションをキャンセルする。

キャリブレーション中でない場合はfalseを返す。

戻り値
キャンセルできればtrue。そうでなければfalse。

◆ CheckFirmwareVersion()

Tuple Mocopi.Mobile.Sdk.MocopiManager.CheckFirmwareVersion ( string sensorName)

指定したmocopiセンサーのファームウェアバージョンを確認する。

指定したmocopiセンサーのファームウェアバージョンとそのバージョンが最新バージョンより新しいのか古いのか、もしくは最新バージョンと同等なのかを返す。

引数
sensorNamemocopiセンサー名
戻り値
「Tuple」と表記されているが、実際は「(EnumFirmwareStatus status, string firmwareVersion)」。バージョンチェックの結果(status)と取得したmocopiセンサーのファームウェアバージョン(firmwareVersion)。

◆ CreateBond()

void Mocopi.Mobile.Sdk.MocopiManager.CreateBond ( string sensorName,
EnumParts part )

mocopiセンサーのペアリングを行う。

接続処理完了時はコールバックOnSensorConnectにて通知される。

引数
sensorNamemocopiセンサー名
引数
part接続部位

◆ DeleteMotionFile()

bool Mocopi.Mobile.Sdk.MocopiManager.DeleteMotionFile ( string fileName)

BVHファイルを削除する。

ファイルが存在しない場合はエラーとなる。

引数
fileName削除するBVHファイル名
戻り値
ファイルの削除が成功した場合はtrue。失敗した場合はfalse。

◆ DisconnectSensor()

void Mocopi.Mobile.Sdk.MocopiManager.DisconnectSensor ( EnumParts part)

指定部位のmocopiセンサーの接続を切断する。

切断はコールバック OnSensorDisconnected にて通知される。
切断mocopiセンサーが接続予約mocopiセンサーリストに含まれていた場合、そのmocopiセンサーを除く。

引数
partmocopiセンサー切断する部位

◆ DisconnectSensors()

void Mocopi.Mobile.Sdk.MocopiManager.DisconnectSensors ( )

接続状態のmocopiセンサーすべてを切断する。

切断はコールバック OnSensorDisconnected にて通知される。
切断するmocopiセンサーが接続待機状態である場合、その接続待機状態をキャンセルする。
接続待機状態に関しては、StartSensorを参照。

◆ GetAppPermissionStatus()

bool Mocopi.Mobile.Sdk.MocopiManager.GetAppPermissionStatus ( EnumPermissionType type)

アプリの権限設定を取得する(Bluetooth/位置情報/ストレージ利用)。

iOSの場合はいかなるときもDisableが返る。

引数
typeアプリの権限設定(Bluetooth/位置情報/ストレージ利用)
戻り値
指定したアプリの権限が許可されているもしくは無効(iOSのみ)であればtrue。許可されていなければfalse。

◆ GetBatteryLevel()

bool Mocopi.Mobile.Sdk.MocopiManager.GetBatteryLevel ( string sensorName)

mocopiセンサーのバッテリー残量を取得する。

バッテリー残量取得の結果はコールバック OnSensorBatteryLevelUpdate にて通知される。

引数
sensorNamemocopiセンサー名
戻り値
バッテリー残量取得の処理を開始できればtrue。できなければfalse。

◆ GetHeight()

MocopiHeightStruct Mocopi.Mobile.Sdk.MocopiManager.GetHeight ( )

キャリブレーションに使用する身長情報を取得する。

取得できる情報は以下。

  • 身長(meter/feet/inch)
  • 設定している単位(meter/feet-inch)
戻り値
身長設定の構造体

◆ GetMotionExternalStorageUri()

string Mocopi.Mobile.Sdk.MocopiManager.GetMotionExternalStorageUri ( )

BVHファイルの保存先ディレクトリを取得する。

SelectMotionExternalStorageUri で選択されたBVHファイルの保存先ディレクトリを取得する。
iOSは本API実行不要。Documentsへの保存が固定となる。 保存先のディレクトリが設定されていない場合は空文字を取得する。

戻り値
保存先ディレクトリパス(URI)。

◆ GetMotionFileInformations()

bool Mocopi.Mobile.Sdk.MocopiManager.GetMotionFileInformations ( )

BVHファイル一覧の情報(ファイル名、サイズ)を取得する。

結果はコールバックOnGetRecordedMotionFileInformationsで取得する。

戻り値

BVHファイル一覧の取得に成功した場合にはtrue。失敗した場合にはfalse。

◆ GetOsSettingStatus()

bool Mocopi.Mobile.Sdk.MocopiManager.GetOsSettingStatus ( EnumOsSettingType type)

OS設定を取得する(Bluetooth/位置情報)。

OS設定がONかOFFかを取得する。
iOSの場合はいかなるときもDisableが返る。

引数
typeOS設定(Bluetooth/位置情報)
戻り値

指定したOS設定がONもしくは無効(iOSのみ)であればtrue。OFFであればfalse。

◆ GetPart()

string Mocopi.Mobile.Sdk.MocopiManager.GetPart ( EnumParts part)

設定された接続部位をもとにmocopiセンサー名を取得する。

存在しない部位を指定した場合nullを返す。

引数
part接続部位

◆ GetPartFromSensorName()

bool Mocopi.Mobile.Sdk.MocopiManager.GetPartFromSensorName ( string sensorName,
out EnumParts part )

mocopiセンサー名から紐づけされた接続部位を取得する。

引数
sensorNamemocopiセンサー名
partmocopiセンサー名に紐づいた接続部位が格納される。
戻り値
指定したmocopiセンサー名がいずれかの部位に紐づけされていればtrue。そうでなければfalse。

◆ GetPartsListWithTargetBody()

List< EnumParts > Mocopi.Mobile.Sdk.MocopiManager.GetPartsListWithTargetBody ( EnumTargetBodyType bodyType)

指定したトラッキングタイプで使用する接続部位のリストを取得する。

引数
bodyType接続モード
戻り値
接続部位のリスト

◆ GetSplitCode()

string Mocopi.Mobile.Sdk.MocopiManager.GetSplitCode ( )

Get split code for Motion file list

戻り値
split code

◆ GetTargetBody()

EnumTargetBodyType Mocopi.Mobile.Sdk.MocopiManager.GetTargetBody ( )

現在のトラッキングタイプを取得する。

mocopiセンサーを身体のどの部位につけるかの情報を取得する。
@

戻り値
トラッキングタイプ(全身(デフォルト)/上半身/下半身)

◆ GetVerifiedFirmwareVersionList()

void Mocopi.Mobile.Sdk.MocopiManager.GetVerifiedFirmwareVersionList ( )

検証済みmocopiセンサーのファームウェアバージョンのリストを取得する。

結果はコールバック OnGetVerifiedFirmwareVersion で通知される。

◆ IsAllPartsSetted() [1/2]

bool Mocopi.Mobile.Sdk.MocopiManager.IsAllPartsSetted ( )

現在のトラッキングタイプに対応するすべての接続部位に対してmocopiセンサーとの紐づけが完了しているか。

現在のトラッキングタイプで必要な部位にmocopiセンサーが紐づいているかを確認する。

戻り値
接続部位すべてに対して、mocopiセンサーの紐づけが完了していればtrue。そうでなければfalse。

◆ IsAllPartsSetted() [2/2]

bool Mocopi.Mobile.Sdk.MocopiManager.IsAllPartsSetted ( EnumTargetBodyType bodyType)

指定したトラッキングタイプに対応する全接続部位とセンサーとの紐づけが完了しているか。

指定したトラッキングタイプに必要な部位にmocopiセンサーが紐づいているかを確認する。

引数
bodyTypeトラッキングタイプ
戻り値
接続部位すべてに対して、mocopiセンサーの紐づけが完了していればtrue。そうでなければfalse。

◆ IsAllSensorsReady()

bool Mocopi.Mobile.Sdk.MocopiManager.IsAllSensorsReady ( )

使用する接続部位すべてのmocopiセンサーが接続状態か。

現在のトラッキングタイプに対応した部位のmocopiセンサーが全て接続状態か確認する。
@

戻り値
使用する接続部位すべてのmocopiセンサーが接続状態であればtrue。そうでなければfalse。

◆ IsLatestFirmwareVersion()

bool Mocopi.Mobile.Sdk.MocopiManager.IsLatestFirmwareVersion ( EnumParts[] parts)

指定した接続部位のmocopiセンサーのファームウェアバージョンが最新か確認する。

CheckFirmwareVersion を先に実行してから実行すること。
CheckFirmwareVersion を事前に実行していない状態で実行した場合はtrueを返す。

引数
partsペアリング済み部位のリスト
戻り値
指定部位すべて最新バージョンであればtrue。ひとつでも古いバージョンのmocopiセンサーがあればfalse。

◆ IsSensorConnected()

bool Mocopi.Mobile.Sdk.MocopiManager.IsSensorConnected ( EnumParts part)

指定部位のmocopiセンサーが接続されているか。

存在しない部位を指定した場合falseを返す。

引数
part接続部位
戻り値
接続されていればtrue。されていなければfalse。

◆ IsSensorConnectedStably()

bool Mocopi.Mobile.Sdk.MocopiManager.IsSensorConnectedStably ( string sensorName)

キャリブレーションの結果を取得する。

一度センサー接続完了後、MocopiLibrary_SetCallback_OnSensorConnectedStably の結果が返ってきたのちに使用可能なAPI。

戻り値
APIコマンド実行に成功時、タイムアウト時はtrue,失敗時にはfalse。

◆ IsSupportedVersionOfStableCalibration()

EnumFirmwareVersionResultForStableCalibration Mocopi.Mobile.Sdk.MocopiManager.IsSupportedVersionOfStableCalibration ( string sensorName)

ファームウェアが高性能キャリブレーションに対応しているバージョンかチェック

引数
sensorNameセンサー名
戻り値
対応しているか

◆ OnSensorConnectedStably()

void Mocopi.Mobile.Sdk.MocopiManager.OnSensorConnectedStably ( string sensorName,
int result )

mocopiセンサーファームウェアからのmocopiセンサーキャリブレーションの計測完了コールバックを受け取り、アプリへ通知するコールバックをキック。

mocopiセンサー接続完了時に発火。

引数
sensorNamemocopiセンサー名
resultmocopiセンサーキャリブレーションの結果

◆ ReadMotionFrame()

void Mocopi.Mobile.Sdk.MocopiManager.ReadMotionFrame ( int frame)

BVHファイルの1フレームを読み込む。

指定されたフレームを読み込む。
成功時にはOnRecordingStreamingReadFrame 、失敗時には OnRecordingStreamingReadFrameFailed コールバックが発火。
@

引数
frame読み込むフレーム

◆ RemoveAllCallback()

void Mocopi.Mobile.Sdk.MocopiManager.RemoveAllCallback ( )

すべてのコールバックを削除する。

◆ RemoveCallbackOnAllSensorReady()

void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnAllSensorReady ( UnityAction< EnumCallbackStatus > callback)

OnAllSensorReady のコールバックを削除する。

引数
callbackコールバック

◆ RemoveCallbackOnCalibrationUpdated()

void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnCalibrationUpdated ( UnityAction< EnumCalibrationCallbackStatus, EnumCalibrationStatus?, string[]> callback)

OnCalibrationUpdatedのコールバックを削除する。

引数
callbackコールバック

◆ RemoveCallbackOnDeleteMotionFileCompleted()

void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnDeleteMotionFileCompleted ( UnityAction< bool > callback)

OnDeleteMotionFileCompletedのコールバックを削除する。

引数
callbackコールバック

◆ RemoveCallbackOnFixedHipSwitched()

void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnFixedHipSwitched ( UnityAction< bool > callback)

OnFixedHipSwitchedのコールバックを削除する。

引数
callbackコールバック

◆ RemoveCallbackOnGetRecordedMotionFileInformations()

void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnGetRecordedMotionFileInformations ( UnityAction<(string fileName, long fileSize)[]> callback)

OnGetRecordedMotionFileInformationsのコールバックを登録する。

引数
callbackコールバック

◆ RemoveCallbackOnMotionConvertProgressUpdated()

void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnMotionConvertProgressUpdated ( UnityAction< int > callback)

OnMotionConvertProgressUpdatedのコールバックを削除する。

引数
callbackコールバック

◆ RemoveCallbackOnRecordingMotionExternalStorageUriSelected()

void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnRecordingMotionExternalStorageUriSelected ( UnityAction< bool > callback)

OnRecordingMotionExternalStorageUriSelectedのコールバックを削除する。

引数
callbackコールバック

◆ RemoveCallbackOnRecordingMotionUpdated()

void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnRecordingMotionUpdated ( UnityAction< string, EnumRecordingMotionAllStatus > callback)

OnRecordingMotionUpdatedのコールバックを削除する。

引数
callbackコールバック

◆ RemoveCallbackOnRenameMotionFileCompleted()

void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnRenameMotionFileCompleted ( UnityAction< bool > callback)

OnRenameMotionFileCompletedのコールバックを削除する。

引数
callbackコールバック

◆ RemoveCallbackOnSensorBatteryLevelUpdated()

void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnSensorBatteryLevelUpdated ( UnityAction< string, int, EnumCallbackStatus > callback)

OnSensorBatteryLevelUpdate のコールバックを削除する。

引数
callbackコールバック

◆ RemoveCallbackOnSensorConnected()

void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnSensorConnected ( UnityAction< EnumParts, string, EnumCallbackStatus, EnumSensorConnectionErrorStatus?> callback)

OnSensorConnectedのコールバックを削除する。

引数
callbackコールバック

◆ RemoveCallbackOnSensorDisconnected()

void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnSensorDisconnected ( UnityAction< string > callback)

OnSensorDisconnectedのコールバックを削除する。

引数
callbackコールバック

◆ RemoveCallbackOnSensorFound()

void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnSensorFound ( UnityAction< string > callback)

OnSensorFoundのコールバックを削除する。

引数
callbackコールバック

◆ RemoveCallbackOnSkeletonDefinitionUpdated()

void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnSkeletonDefinitionUpdated ( UnityAction< SkeletonDefinitionData > callback)

OnSkeletonDefinitionUpdatedのコールバックを削除する。

引数
callbackコールバック

◆ RemoveCallbackOnSkeletonUpdated()

void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnSkeletonUpdated ( UnityAction< SkeletonData > callback)

OnSkeletonUpdatedのコールバックを削除する。

引数
callbackコールバック

◆ RemovePart()

bool Mocopi.Mobile.Sdk.MocopiManager.RemovePart ( EnumParts part)

接続部位とセンサー名の紐づけを削除する。

存在しない部位を指定した場合falseを返す。

引数
part接続部位
戻り値
紐づけ情報の削除成功でtrue。失敗でfalse。

◆ RenameMotionFile()

bool Mocopi.Mobile.Sdk.MocopiManager.RenameMotionFile ( string oldFileName,
string newFilename )

BVHファイルの名前を変更する。

ファイルが存在しない場合はエラーとなる。

引数
oldFileName変更前のBVHファイル名
newFileName新しいBVHファイル名
戻り値
ファイル名の変更が成功した場合はtrue。失敗した場合はfalse。

◆ ResetPose()

bool Mocopi.Mobile.Sdk.MocopiManager.ResetPose ( )

アバターのポーズを初期姿勢にリセットする。

トラッキング中以外は使用不可。
ResetPose実施中は静止している必要がある。

戻り値
アバターのポーズをリセットできればtrue。できなければfalse。

◆ SaveMotionFiles()

bool Mocopi.Mobile.Sdk.MocopiManager.SaveMotionFiles ( string fileName = "")

モーションデータをBVHファイルに保存する。

StartMotionRecording を実行後、モーションデータがSDK内に保持される。
このAPIを実行することで、そのデータをBVHファイルで出力する。

引数
fileName保存ファイル名 ( 拡張子不要 )
戻り値
BVHファイル保存成功でtrue。失敗でfalse。

◆ SelectMotionExternalStorageUri()

bool Mocopi.Mobile.Sdk.MocopiManager.SelectMotionExternalStorageUri ( )

BVHファイルの保存先ディレクトリを選択する。

Androidのみ機能する。本API実行後、ディレクトリ選択画面が表示される。
iOSは本API実行不要。Documentsへの保存が固定となる。

戻り値
ファルダ選択画面の表示に成功した場合true。失敗した場合はfalse。

◆ SetFixedHip()

bool Mocopi.Mobile.Sdk.MocopiManager.SetFixedHip ( bool fixedHip)

アバターの腰を固定するかを設定する

設定の更新はコールバック OnFixedHipSwitched にて通知される。
腰固定設定に変化がない場合、既に腰固定の設定がされている場合はfalseを返す。

引数
fixedHiptrueで腰固定ON。falseで腰固定OFF。
戻り値
セットができればtrue。できなければfalse。

◆ SetHeight()

bool Mocopi.Mobile.Sdk.MocopiManager.SetHeight ( MocopiHeightStruct heightStruct)

キャリブレーションに使用する身長を設定する。

unitがmeterならmeterに、feet-inchであればfeetとinchに値が入っていればよい。
規定の数値内で収まっているのかの確認も行う。

引数
heightStruct身長設定の構造体
戻り値
設定できればtrue。既定値外の数値があればfalse。

◆ SetPart()

bool Mocopi.Mobile.Sdk.MocopiManager.SetPart ( EnumParts part,
string sensorName )

指定した接続部位と指定したmocopiセンサーを紐づける。

指定した接続部位を元にそれぞれの紐づけを行う。
パーツが見つからなかった場合はfalseを返す。

引数
part紐づける接続部位
sensorName紐づけるmocopiセンサー名
戻り値
紐づけ成功でtrue。失敗でfalse。

◆ SetRootPosition()

bool Mocopi.Mobile.Sdk.MocopiManager.SetRootPosition ( Vector3 position)

アバターのポジションをリセットする。

トラッキング中以外は使用不可。

引数
positionアバターのポジション
戻り値
ポジションリセットができればtrue。できなければfalse。

◆ SetTargetBody()

void Mocopi.Mobile.Sdk.MocopiManager.SetTargetBody ( EnumTargetBodyType targetBodyType)

指定したトラッキングタイプを設定して、mocopiセンサーの紐づけを更新する。

トラッキングタイプの設定時に、ペアリング済みのmocopiセンサーがある場合は部位によって装着部位の紐づけを更新する。
例:通常6点モードから下半身6点モードへ設定する場合、RightWristのmocopiセンサーはRightUpperLegに紐づける。

引数
targetBodyType設定するトラッキングタイプ

◆ StartCalibration()

async Task< bool > Mocopi.Mobile.Sdk.MocopiManager.StartCalibration ( )

キャリブレーションを開始する。

キャリブレーションの進捗はそれぞれコールバック OnCalibrationUpdated にて通知される。
キャリブレーション開始に失敗した場合も設定した試行回数分は開始処理を行い、設定試行回数分失敗した場合はキャリブレーション開始を失敗判定となる。

戻り値
キャリブレーション開始ができればtrue。できなければfalse。

◆ StartDiscovery()

void Mocopi.Mobile.Sdk.MocopiManager.StartDiscovery ( bool excludeSettedPart = false)

Bluetoothでmocopiセンサーの検索を開始する。

mocopiセンサーの検索中であればtrue、そうでなければfalseを返す。
mocopiセンサー発見時はコールバック OnSensorFoundにて通知される。
通知ステータス:Discovery
set使用タイミング: センサー接続前まで。

引数
excludeSettedParttrueでペアリング済みのmocopiセンサーを検索対象から除く。
falseでペアリング状況に関係なく検索される。

◆ StartMotionRecording()

bool Mocopi.Mobile.Sdk.MocopiManager.StartMotionRecording ( )

モーション記録を開始する。

トラッキング中以外は使用不可。

戻り値
モーション記録を開始できたらtrue。既に記録中の場合false。

◆ StartMotionStreamingRead()

void Mocopi.Mobile.Sdk.MocopiManager.StartMotionStreamingRead ( string fileName,
int motionFormat )

BVH読み込みできる状態を開始する。

引数
fileNameファイル名
motionFormatBVHファイルフォーマット

◆ StartSensor()

void Mocopi.Mobile.Sdk.MocopiManager.StartSensor ( )

ペアリングを行ったmocopiセンサーすべてを接続する。

現在設定されているトラッキングタイプの部位すべてに対して接続処理が開始される。
接続処理完了時はmocopiセンサーごとにコールバックOnSensorConnectにて通知され、
すべての接続処理が完了するとコールバックOnAllSensorReadyにて通知される。

◆ StartSingleSensor()

void Mocopi.Mobile.Sdk.MocopiManager.StartSingleSensor ( EnumParts part)

指定部位のmocopiセンサーと接続を行う。

事前にSetPart を実行し、接続部位とセンサー名の紐づけが完了している必要がある。

引数
part接続部位

◆ StartTracking()

bool Mocopi.Mobile.Sdk.MocopiManager.StartTracking ( )

トラッキングを開始する。

既にトラッキングが開始されている場合、キャリブレーション済みでない場合、トラッキング開始の処理を失敗扱いとする。
キャリブレーション自体の成否については、OnCalibrationStateFinishedで判断する。

戻り値
トラッキング開始に成功した場合true、トラッキング開始に失敗した場合false。

◆ StopDiscovery()

void Mocopi.Mobile.Sdk.MocopiManager.StopDiscovery ( )

mocopiセンサーの検索を停止する。

StartDiscoveryを実行してmocopiセンサー検索中となっていない場合は何もしない。

◆ StopMotionRecording()

bool Mocopi.Mobile.Sdk.MocopiManager.StopMotionRecording ( )

モーション記録を停止する。

トラッキング中以外は使用不可。

戻り値
モーション記録を停止した場合true。モーション記録中でない場合false。

◆ StopMotionStreamingRead()

void Mocopi.Mobile.Sdk.MocopiManager.StopMotionStreamingRead ( )

BVH読み込みできる状態を停止する。

◆ StopSensor()

void Mocopi.Mobile.Sdk.MocopiManager.StopSensor ( )

トラッキング停止と全センサー切断を行う。
Stop tracking and Disconnect All sensors.

切断はコールバック OnSensorDisconnected にて通知される。

◆ StopTracking()

void Mocopi.Mobile.Sdk.MocopiManager.StopTracking ( )

トラッキングを停止する。

トラッキング中だった場合トラッキング停止処理を行う。
トラッキング開始していない場合にはなにもしない。
同時にモーション録画処理も終了させる。

メンバ詳解

◆ ConnectedSensorsDictionary

Dictionary<EnumParts, string> Mocopi.Mobile.Sdk.MocopiManager.ConnectedSensorsDictionary = new Dictionary<EnumParts, string>()

接続中mocopiセンサーのディクショナリ

Key : 接続部位(EnumParts), Value : mocopiセンサー名

◆ EventHandleSettings

MocopiEventHandlerSettings Mocopi.Mobile.Sdk.MocopiManager.EventHandleSettings

ユーザー設定用のコールバック群

プロパティ詳解

◆ Instance

MocopiManager Mocopi.Mobile.Sdk.MocopiManager.Instance
staticget

シングルトン用の自分自身のインスタンス

◆ IsAutoMappingBodyPart

bool Mocopi.Mobile.Sdk.MocopiManager.IsAutoMappingBodyPart = false
getset

高度な機能の接続部位への変換を行うかどうか。

◆ IsCalibrationCompleted

bool Mocopi.Mobile.Sdk.MocopiManager.IsCalibrationCompleted
get

キャリブレーションに成功したか。

◆ IsDiscoverying

bool Mocopi.Mobile.Sdk.MocopiManager.IsDiscoverying = false
get

センサー探索中かどうか。

◆ IsFixedHip

bool Mocopi.Mobile.Sdk.MocopiManager.IsFixedHip = false
get

腰固定するかどうか。

◆ IsRecordingMotion

bool Mocopi.Mobile.Sdk.MocopiManager.IsRecordingMotion = false
get

モーション記録中かどうか。

◆ IsTracking

bool Mocopi.Mobile.Sdk.MocopiManager.IsTracking = false
get

トラッキング中かどうか。

◆ LatestFirmwareVersion

Version Mocopi.Mobile.Sdk.MocopiManager.LatestFirmwareVersion = null
get

センサーの最新ファームウェアバージョン

◆ Logger

LogUtility Mocopi.Mobile.Sdk.MocopiManager.Logger
get

ログ出力用クラス

◆ MocopiAvatar

MocopiAvatar Mocopi.Mobile.Sdk.MocopiManager.MocopiAvatar
getset

mocopiで使用するアバター

◆ OlderSensorArray

List<string> Mocopi.Mobile.Sdk.MocopiManager.OlderSensorArray
get

mocopiセンサーのファームウェアのバージョンが古い状態のセンサーリスト

◆ RunMode

EnumRunMode Mocopi.Mobile.Sdk.MocopiManager.RunMode
staticgetset

SDKの動作モード

◆ SynchronizationContext

SynchronizationContext Mocopi.Mobile.Sdk.MocopiManager.SynchronizationContext
getset

メインスレッド実行用のコンテキスト

◆ TargetBodyType

EnumTargetBodyType Mocopi.Mobile.Sdk.MocopiManager.TargetBodyType
get

トラッキングタイプ


このクラス詳解は次のファイルから抽出されました:
  • MocopiManager.cs