|
mocopi mobile SDK
|
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センサーのペアリングを行う。 | |
| bool | StartSensor () |
| ペアリングを行ったmocopiセンサーすべてを接続する。 | |
| void | StartSingleSensor (EnumParts part) |
| 指定部位のmocopiセンサーと接続を行う。 | |
| List< EnumParts > | GetPartsListWithTargetBody (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 () |
| トラッキング停止と全センサー切断を行う。 | |
| 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 | CheckMotionFormat (string fileName) |
| モーションファイルのフォーマットを確認する。 | |
| void | StartMotionStreamingRead (string fileName, int motionFormat) |
| BVH読み込みできる状態を開始する。 | |
| void | ReadMotionFrame (int frame) |
| BVHファイルの1フレームを読み込む。 | |
| void | StopMotionStreamingRead () |
| BVH読み込みできる状態を停止する。 | |
| void | GetVerifiedFirmwareVersionList () |
| 検証済みmocopiセンサーのファームウェアバージョンのリストを取得する。 | |
| bool | IsLatestFirmwareVersion (EnumParts[] parts) |
| 指定した接続部位のmocopiセンサーのファームウェアバージョンが最新か確認する。 | |
| EnumFirmwareStatus string firmwareVersion | CheckFirmwareVersion (string sensorName) |
| bool | IsSensorConnectedStably (string sensorName) |
| キャリブレーションの結果を取得する。 | |
| EnumFirmwareVersionResultForStableCalibration | IsSupportedVersionOfStableCalibration (string sensorName) |
| ファームウェアが高性能キャリブレーションに対応しているバージョンかチェック | |
| string | GetSplitCode () |
| Get split code for Motion file list | |
| bool | GetSensor (string sensorName, out MocopiSensor foundSensor) |
| センサー情報をセンサー名から取得する。 | |
| bool | GetSensor (EnumParts part, out MocopiSensor foundSensor) |
| センサー情報を部位名から取得する。 | |
| bool | GetSensor (EnumSensorStatus status, string sensorName, out MocopiSensor foundSensor) |
| センサー名とステータスに一致するセンサー情報を取得する。 | |
| List< MocopiSensor > | FindSensorList (EnumSensorStatus status) |
| 指定したステータスに一致するセンサーリストを取得する。 | |
| 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 | AddCallbackOnCheckMotionFormatCompleted (UnityAction< EnumMotionFormat > callback) |
| OnCheckMotionFormatCompleted のコールバックを登録する。 | |
| void | RemoveCallbackOnCheckMotionFormatCompleted (UnityAction< EnumMotionFormat > callback) |
| OnCheckMotionFormatCompleted のコールバックを削除する。 | |
| bool | SwitchButtonNotify (string sensorName, bool isActiveSingle, bool isActiveDouble, bool isActiveTriple) |
| mocopiセンサーのボタンが押された際の通知を設定する。 mocopiセンサー名 1回押したか 2回押したか 3回押したか 正常に設定できた場合、true。設定できなかった場合、false。 mocopiセンサーのボタンが押された際に コールバック OnSensorButtonPressed を発火させるmocopiセンサーと回数を登録する。 | |
公開変数類 | |
| MocopiEventHandlerSettings | EventHandleSettings |
| ユーザー設定用のコールバック群 | |
| EnumFirmwareStatus | status |
| 指定した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センサーに関わる処理をまとめたクラス
| void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnAllSensorReady | ( | UnityAction< EnumCallbackStatus > | callback | ) |
OnAllSensorReadyのコールバックを登録する。
mocopiセンサーが接続された時に、コールバックOnAllSensorReadyで通知される。
コールバックの引数: 現在設定されているトラッキングタイプの部位すべてに対して接続完了したか(bool)
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnCalibrationUpdated | ( | UnityAction< EnumCalibrationCallbackStatus, EnumCalibrationStatus?, string[]> | callback | ) |
OnCalibrationUpdatedのコールバックを登録する。
キャリブレーションステータスが更新された時に、コールバックOnCalibrationUpdatedで通知される。
キャリブレーションは、静止/一歩前進/静止の3つのフェーズがあり、それぞれ状態が変わったときにコールバックで通知される。
キャリブレーション結果がWarningである場合は、トラッキング精度に影響を及ぼす可能性があるので、再度キャリブレーションを行うことを推奨する。
コールバックの引数: キャリブレーションステータス( EnumCalibrationCallbackStatus )
キャリブレーション結果( EnumCalibrationStatus )
キャリブレーションしたmocopiセンサーリスト(string[])
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnCheckMotionFormatCompleted | ( | UnityAction< EnumMotionFormat > | callback | ) |
OnCheckMotionFormatCompleted のコールバックを登録する。
モーションファイルのフォーマット確認完了時、確認結果がコールバックOnCheckMotionFormatCompletedで通知される。
コールバックの引数: モーションファイルのフォーマット確認結果(フォーマット違反ファイル、mocopiで記録したファイル、mocopi外で作成されたファイル)
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnDeleteMotionFileCompleted | ( | UnityAction< bool > | callback | ) |
OnDeleteMotionFileCompletedのコールバックを登録する。
MOTIONファイルの削除処理の結果を、コールバックOnDeleteMotionFileCompletedで通知される。
コールバックの引数: 削除に成功したか(bool)
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnFixedHipSwitched | ( | UnityAction< bool > | callback | ) |
OnFixedHipSwitchedのコールバックを登録する。
アバターの腰を固定する設定が変更された時に、コールバックOnFixedHipSwitchedで通知される。
コールバックの引数: 腰固定ONでtrue。腰固定OFFでfalse。
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnGetRecordedMotionFileInformations | ( | UnityAction<(string fileName, long fileSize)[]> | callback | ) |
OnGetRecordedMotionFileInformations のコールバックを登録する。
MOTIONファイルの一覧取得の結果が、コールバックOnGetRecordedMotionFileInformationsで通知される。
コールバックの引数: ファイルごとの情報(配列)
1要素に、ファイル名(string)とファイルサイズ(long)の情報が存在する。
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnMotionConvertProgressUpdated | ( | UnityAction< int > | callback | ) |
OnMotionConvertProgressUpdatedのコールバックを登録する。
モーション記録の結果を保存する際の進捗を、コールバックOnMotionConvertProgressUpdatedで通知する。
進捗が100になる前に、なにがしかの理由で中断された場合、保存自体の処理は失敗する。
コールバックの引数: モーション保存の進捗率(int)
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnRecordingMotionExternalStorageUriSelected | ( | UnityAction< bool > | callback | ) |
OnRecordingMotionExternalStorageUriSelected のコールバックを登録する。
モーション記録をする際の保存先ディレクトリ選択の結果を、コールバックOnRecordingMotionExternalStorageUriSelectedで通知される。
コールバックの引数: ディレクトリ選択に成功したか(bool)
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnRecordingMotionUpdated | ( | UnityAction< string, EnumRecordingMotionAllStatus > | callback | ) |
OnRecordingMotionUpdatedのコールバックを登録する。
モーション記録のステータスが更新された時に、コールバックOnRecordingMotionUpdatedで通知される。
モーション記録の開始時/保存完了時/エラー発生時で、それぞれコールバックで通知される。
コールバックの引数: モーション記録ステータスメッセージ(string)
モーション記録ステータス( EnumRecordingMotionAllStatus )
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnRenameMotionFileCompleted | ( | UnityAction< bool > | callback | ) |
OnRenameMotionFileCompletedのコールバックを登録する。
MOTIONファイルの命名変更処理の結果を、コールバックOnRenameMotionFileCompletedで通知される。
コールバックの引数: 命名変更に成功したか(bool)
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnSensorBatteryLevelUpdated | ( | UnityAction< string, int, EnumCallbackStatus > | callback | ) |
OnSensorBatteryLevelUpdate のコールバックを登録する。
mocopiセンサーファームウェアからのバッテリー残量の取得成功コールバックを受け取り、コールバックOnSensorBatteryLevelUpdatedへ通知する。
コールバックの引数: センサー名(string)
mocopiセンサーのバッテリー残量(int)
コールバック結果( EnumCallbackStatus )
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnSensorConnected | ( | UnityAction< EnumParts, string, EnumCallbackStatus, EnumSensorConnectionErrorStatus?> | callback | ) |
OnSensorConnectedのコールバックを登録する。
mocopiセンサーの接続の結果が、コールバックOnSensorConnectedで通知される。
コールバックの引数: 接続部位( EnumParts )
接続するmocopiセンサー名(string)
コールバック結果( EnumCallbackStatus )
エラーステータス( EnumSensorConnectionErrorStatus )※接続成功した場合はnullが入る
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnSensorDisconnected | ( | UnityAction< string > | callback | ) |
OnSensorDisconnectedのコールバックを登録する。
mocopiセンサーが切断された時に、コールバックOnSensorDisconnectedで通知される。
コールバックの引数: 切断されたmocopiセンサー名(string)
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnSensorFound | ( | UnityAction< string > | callback | ) |
OnSensorFoundのコールバックを登録する。
StartDiscoveryを実行した後、mocopiセンサーが見つかった時に、コールバックOnSensorFoundで通知される。
コールバックの引数: 発見したmocopiセンサー名(string)
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnSkeletonDefinitionUpdated | ( | UnityAction< SkeletonDefinitionData > | callback | ) |
OnSkeletonDefinitionUpdatedのコールバックを登録する。
トラッキング開始時に、コールバックOnSkeletonDefinitionUpdatedで通知される。
コールバックの引数: スケルトン定義データの構造体(SkeletonDefinitionData)
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.AddCallbackOnSkeletonUpdated | ( | UnityAction< SkeletonData > | callback | ) |
OnSkeletonUpdatedのコールバックを登録する。
トラッキング時に、スケルトン情報がコールバック OnSkeletonUpdatedで通知される(50FPS)。
コールバックの引数: スケルトンフレームデータの構造体(SkeletonData)
| callback | コールバック |
| bool Mocopi.Mobile.Sdk.MocopiManager.CancelCalibration | ( | ) |
キャリブレーションをキャンセルする。
キャリブレーション中でない場合はfalseを返す。
| EnumFirmwareStatus string firmwareVersion Mocopi.Mobile.Sdk.MocopiManager.CheckFirmwareVersion | ( | string | sensorName | ) |
| void Mocopi.Mobile.Sdk.MocopiManager.CheckMotionFormat | ( | string | fileName | ) |
モーションファイルのフォーマットを確認する。
モーションファイル読み込み用のフォーマット確認を行う。
取得完了時にはOnCheckMotionFormatCompleted コールバックが発火。
モーションファイル名
| void Mocopi.Mobile.Sdk.MocopiManager.CreateBond | ( | string | sensorName, |
| EnumParts | part ) |
mocopiセンサーのペアリングを行う。
接続処理完了時はコールバックOnSensorConnectにて通知される。
| sensorName | mocopiセンサー名 |
| part | 接続部位 |
| bool Mocopi.Mobile.Sdk.MocopiManager.DeleteMotionFile | ( | string | fileName | ) |
BVHファイルを削除する。
ファイルが存在しない場合はエラーとなる。
| fileName | 削除するBVHファイル名 |
| void Mocopi.Mobile.Sdk.MocopiManager.DisconnectSensor | ( | EnumParts | part | ) |
指定部位のmocopiセンサーの接続を切断する。
切断はコールバック OnSensorDisconnected にて通知される。
切断mocopiセンサーが接続予約mocopiセンサーリストに含まれていた場合、そのmocopiセンサーを除く。
| part | mocopiセンサー切断する部位 |
| void Mocopi.Mobile.Sdk.MocopiManager.DisconnectSensors | ( | ) |
接続状態のmocopiセンサーすべてを切断する。
切断はコールバック OnSensorDisconnected にて通知される。
切断するmocopiセンサーが接続待機状態である場合、その接続待機状態をキャンセルする。
接続待機状態に関しては、StartSensorを参照。
| List< MocopiSensor > Mocopi.Mobile.Sdk.MocopiManager.FindSensorList | ( | EnumSensorStatus | status | ) |
指定したステータスに一致するセンサーリストを取得する。
| status | センサーステータス センサーリスト |
| bool Mocopi.Mobile.Sdk.MocopiManager.GetAppPermissionStatus | ( | EnumPermissionType | type | ) |
アプリの権限設定を取得する(Bluetooth/位置情報/ストレージ利用)。
iOSの場合はいかなるときもDisableが返る。
| type | アプリの権限設定(Bluetooth/位置情報/ストレージ利用) |
| bool Mocopi.Mobile.Sdk.MocopiManager.GetBatteryLevel | ( | string | sensorName | ) |
mocopiセンサーのバッテリー残量を取得する。
バッテリー残量取得の結果はコールバック OnSensorBatteryLevelUpdate にて通知される。
| sensorName | mocopiセンサー名 |
| MocopiHeightStruct Mocopi.Mobile.Sdk.MocopiManager.GetHeight | ( | ) |
キャリブレーションに使用する身長情報を取得する。
取得できる情報は以下。
| string Mocopi.Mobile.Sdk.MocopiManager.GetMotionExternalStorageUri | ( | ) |
BVHファイルの保存先ディレクトリを取得する。
SelectMotionExternalStorageUri で選択されたMOTIONファイルの保存先ディレクトリを取得する。
iOSは本API実行不要。Documentsへの保存が固定となる。 保存先のディレクトリが設定されていない場合は空文字を取得する。
| bool Mocopi.Mobile.Sdk.MocopiManager.GetMotionFileInformations | ( | ) |
BVHファイル一覧の情報(ファイル名、サイズ)を取得する。
結果はコールバックOnGetRecordedMotionFileInformationsで取得する。
BVHファイル一覧の取得に成功した場合にはtrue。失敗した場合にはfalse。
| bool Mocopi.Mobile.Sdk.MocopiManager.GetOsSettingStatus | ( | EnumOsSettingType | type | ) |
OS設定を取得する(Bluetooth/位置情報)。
OS設定がONかOFFかを取得する。
iOSの場合はいかなるときもDisableが返る。
| type | OS設定(Bluetooth/位置情報) |
指定したOS設定がONもしくは無効(iOSのみ)であればtrue。OFFであればfalse。
| string Mocopi.Mobile.Sdk.MocopiManager.GetPart | ( | EnumParts | part | ) |
設定された接続部位をもとにmocopiセンサー名を取得する。
存在しない部位を指定した場合nullを返す。
| part | 接続部位 |
| bool Mocopi.Mobile.Sdk.MocopiManager.GetPartFromSensorName | ( | string | sensorName, |
| out EnumParts | part ) |
mocopiセンサー名から紐づけされた接続部位を取得する。
| sensorName | mocopiセンサー名 |
| part | mocopiセンサー名に紐づいた接続部位が格納される。 |
| List< EnumParts > Mocopi.Mobile.Sdk.MocopiManager.GetPartsListWithTargetBody | ( | EnumTargetBodyType | bodyType | ) |
指定したトラッキングタイプで使用する接続部位のリストを取得する。
| bodyType | 接続モード |
| bool Mocopi.Mobile.Sdk.MocopiManager.GetSensor | ( | EnumParts | part, |
| out MocopiSensor | foundSensor ) |
センサー情報を部位名から取得する。
| part | 装着部位 [out]該当する部位に紐づいているセンサーがあった場合、センサーオブジェクトを格納する。 存在しない場合はnullを格納する。 センサー情報を取得できればtrue。できなければfalse。 |
| bool Mocopi.Mobile.Sdk.MocopiManager.GetSensor | ( | EnumSensorStatus | status, |
| string | sensorName, | ||
| out MocopiSensor | foundSensor ) |
センサー名とステータスに一致するセンサー情報を取得する。
| status | センサーステータス センサー名 [out]センサーステータスとセンサー名が合致するセンサーがあった場合、センサーオブジェクトを格納する。 存在しない場合はnullを格納する。 |
| bool Mocopi.Mobile.Sdk.MocopiManager.GetSensor | ( | string | sensorName, |
| out MocopiSensor | foundSensor ) |
センサー情報をセンサー名から取得する。
| sensorName | センサー名 [out]該当する名前のセンサーがあった場合、センサーオブジェクトを格納する。 存在しない場合はnullを格納する。 センサー情報を取得できればtrue。できなければfalse。 |
| string Mocopi.Mobile.Sdk.MocopiManager.GetSplitCode | ( | ) |
Get split code for Motion file list
| EnumTargetBodyType Mocopi.Mobile.Sdk.MocopiManager.GetTargetBody | ( | ) |
現在のトラッキングタイプを取得する。
mocopiセンサーを身体のどの部位につけるかの情報を取得する。
トラッキングタイプ(全身(デフォルト)/上半身/下半身)
| void Mocopi.Mobile.Sdk.MocopiManager.GetVerifiedFirmwareVersionList | ( | ) |
検証済みmocopiセンサーのファームウェアバージョンのリストを取得する。
結果はコールバック OnGetVerifiedFirmwareVersion で通知される。
| bool Mocopi.Mobile.Sdk.MocopiManager.IsAllPartsSetted | ( | ) |
現在のトラッキングタイプに対応するすべての接続部位に対してmocopiセンサーとの紐づけが完了しているか。
現在のトラッキングタイプで必要な部位にmocopiセンサーが紐づいているかを確認する。
| bool Mocopi.Mobile.Sdk.MocopiManager.IsAllPartsSetted | ( | EnumTargetBodyType | bodyType | ) |
指定したトラッキングタイプに対応する全接続部位とセンサーとの紐づけが完了しているか。
指定したトラッキングタイプに必要な部位にmocopiセンサーが紐づいているかを確認する。
| bodyType | トラッキングタイプ |
| bool Mocopi.Mobile.Sdk.MocopiManager.IsAllSensorsReady | ( | ) |
使用する接続部位すべてのmocopiセンサーが接続状態か。
現在のトラッキングタイプに対応した部位のmocopiセンサーが全て接続状態か確認する。
使用する接続部位すべてのmocopiセンサーが接続状態であればtrue。そうでなければfalse。
| bool Mocopi.Mobile.Sdk.MocopiManager.IsLatestFirmwareVersion | ( | EnumParts[] | parts | ) |
指定した接続部位のmocopiセンサーのファームウェアバージョンが最新か確認する。
CheckFirmwareVersion を先に実行してから実行すること。
CheckFirmwareVersion を事前に実行していない状態で実行した場合はtrueを返す。
| parts | ペアリング済み部位のリスト |
| bool Mocopi.Mobile.Sdk.MocopiManager.IsSensorConnected | ( | EnumParts | part | ) |
指定部位のmocopiセンサーが接続されているか。
存在しない部位を指定した場合falseを返す。
| part | 接続部位 |
| bool Mocopi.Mobile.Sdk.MocopiManager.IsSensorConnectedStably | ( | string | sensorName | ) |
キャリブレーションの結果を取得する。
一度センサー接続完了後、MocopiLibrary_SetCallback_OnSensorConnectedStably の結果が返ってきたのちに使用可能なAPI。
| EnumFirmwareVersionResultForStableCalibration Mocopi.Mobile.Sdk.MocopiManager.IsSupportedVersionOfStableCalibration | ( | string | sensorName | ) |
ファームウェアが高性能キャリブレーションに対応しているバージョンかチェック
| sensorName | センサー名 |
| void Mocopi.Mobile.Sdk.MocopiManager.ReadMotionFrame | ( | int | frame | ) |
BVHファイルの1フレームを読み込む。
指定されたフレームを読み込む。
成功時にはOnRecordingStreamingReadFrame 、失敗時には OnRecordingStreamingReadFrameFailed コールバックが発火。
読み込むフレーム
| void Mocopi.Mobile.Sdk.MocopiManager.RemoveAllCallback | ( | ) |
すべてのコールバックを削除する。
| void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnAllSensorReady | ( | UnityAction< EnumCallbackStatus > | callback | ) |
OnAllSensorReady のコールバックを削除する。
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnCalibrationUpdated | ( | UnityAction< EnumCalibrationCallbackStatus, EnumCalibrationStatus?, string[]> | callback | ) |
OnCalibrationUpdatedのコールバックを削除する。
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnCheckMotionFormatCompleted | ( | UnityAction< EnumMotionFormat > | callback | ) |
OnCheckMotionFormatCompleted のコールバックを削除する。
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnDeleteMotionFileCompleted | ( | UnityAction< bool > | callback | ) |
OnDeleteMotionFileCompletedのコールバックを削除する。
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnFixedHipSwitched | ( | UnityAction< bool > | callback | ) |
OnFixedHipSwitchedのコールバックを削除する。
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnGetRecordedMotionFileInformations | ( | UnityAction<(string fileName, long fileSize)[]> | callback | ) |
OnGetRecordedMotionFileInformationsのコールバックを登録する。
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnMotionConvertProgressUpdated | ( | UnityAction< int > | callback | ) |
OnMotionConvertProgressUpdatedのコールバックを削除する。
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnRecordingMotionExternalStorageUriSelected | ( | UnityAction< bool > | callback | ) |
OnRecordingMotionExternalStorageUriSelectedのコールバックを削除する。
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnRecordingMotionUpdated | ( | UnityAction< string, EnumRecordingMotionAllStatus > | callback | ) |
OnRecordingMotionUpdatedのコールバックを削除する。
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnRenameMotionFileCompleted | ( | UnityAction< bool > | callback | ) |
OnRenameMotionFileCompletedのコールバックを削除する。
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnSensorBatteryLevelUpdated | ( | UnityAction< string, int, EnumCallbackStatus > | callback | ) |
OnSensorBatteryLevelUpdate のコールバックを削除する。
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnSensorConnected | ( | UnityAction< EnumParts, string, EnumCallbackStatus, EnumSensorConnectionErrorStatus?> | callback | ) |
OnSensorConnectedのコールバックを削除する。
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnSensorDisconnected | ( | UnityAction< string > | callback | ) |
OnSensorDisconnectedのコールバックを削除する。
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnSensorFound | ( | UnityAction< string > | callback | ) |
OnSensorFoundのコールバックを削除する。
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnSkeletonDefinitionUpdated | ( | UnityAction< SkeletonDefinitionData > | callback | ) |
OnSkeletonDefinitionUpdatedのコールバックを削除する。
| callback | コールバック |
| void Mocopi.Mobile.Sdk.MocopiManager.RemoveCallbackOnSkeletonUpdated | ( | UnityAction< SkeletonData > | callback | ) |
OnSkeletonUpdatedのコールバックを削除する。
| callback | コールバック |
| bool Mocopi.Mobile.Sdk.MocopiManager.RemovePart | ( | EnumParts | part | ) |
接続部位とセンサー名の紐づけを削除する。
存在しない部位を指定した場合falseを返す。
| part | 接続部位 |
| bool Mocopi.Mobile.Sdk.MocopiManager.RenameMotionFile | ( | string | oldFileName, |
| string | newFilename ) |
BVHファイルの名前を変更する。
ファイルが存在しない場合はエラーとなる。
| oldFileName | 変更前のBVHファイル名 |
| newFileName | 新しいBVHファイル名 |
| bool Mocopi.Mobile.Sdk.MocopiManager.ResetPose | ( | ) |
アバターのポーズを初期姿勢にリセットする。
トラッキング中以外は使用不可。
ResetPose実施中は静止している必要がある。
| bool Mocopi.Mobile.Sdk.MocopiManager.SaveMotionFiles | ( | string | fileName = "" | ) |
モーションデータをBVHファイルに保存する。
StartMotionRecording を実行後、モーションデータがSDK内に保持される。
このAPIを実行することで、そのデータをBVHファイルで出力する。
| fileName | 保存ファイル名 ( 拡張子不要 ) |
| bool Mocopi.Mobile.Sdk.MocopiManager.SelectMotionExternalStorageUri | ( | ) |
BVHファイルの保存先ディレクトリを選択する。
Androidのみ機能する。本API実行後、ディレクトリ選択画面が表示される。
iOSは本API実行不要。Documentsへの保存が固定となる。
| bool Mocopi.Mobile.Sdk.MocopiManager.SetFixedHip | ( | bool | fixedHip | ) |
アバターの腰を固定するかを設定する
設定の更新はコールバック OnFixedHipSwitched にて通知される。
腰固定設定に変化がない場合、既に腰固定の設定がされている場合はfalseを返す。
| fixedHip | trueで腰固定ON。falseで腰固定OFF。 |
| bool Mocopi.Mobile.Sdk.MocopiManager.SetHeight | ( | MocopiHeightStruct | heightStruct | ) |
キャリブレーションに使用する身長を設定する。
unitがmeterならmeterに、feet-inchであればfeetとinchに値が入っていればよい。
規定の数値内で収まっているのかの確認も行う。
| heightStruct | 身長設定の構造体 |
| bool Mocopi.Mobile.Sdk.MocopiManager.SetPart | ( | EnumParts | part, |
| string | sensorName ) |
指定した接続部位と指定したmocopiセンサーを紐づける。
指定した接続部位を元にそれぞれの紐づけを行う。
パーツが見つからなかった場合はfalseを返す。
| part | 紐づける接続部位 |
| sensorName | 紐づけるmocopiセンサー名 |
| bool Mocopi.Mobile.Sdk.MocopiManager.SetRootPosition | ( | Vector3 | position | ) |
アバターのポジションをリセットする。
トラッキング中以外は使用不可。
| position | アバターのポジション |
| void Mocopi.Mobile.Sdk.MocopiManager.SetTargetBody | ( | EnumTargetBodyType | targetBodyType | ) |
指定したトラッキングタイプを設定して、mocopiセンサーの紐づけを更新する。
トラッキングタイプの設定時に、ペアリング済みのmocopiセンサーがある場合は部位によって装着部位の紐づけを更新する。
例:通常6点モードから下半身6点モードへ設定する場合、RightWristのmocopiセンサーはRightUpperLegに紐づける。
| targetBodyType | 設定するトラッキングタイプ |
| async Task< bool > Mocopi.Mobile.Sdk.MocopiManager.StartCalibration | ( | ) |
キャリブレーションを開始する。
キャリブレーションの進捗はそれぞれコールバック OnCalibrationUpdated にて通知される。
キャリブレーション開始に失敗した場合も設定した試行回数分は開始処理を行い、設定試行回数分失敗した場合はキャリブレーション開始を失敗判定となる。
| void Mocopi.Mobile.Sdk.MocopiManager.StartDiscovery | ( | bool | excludeSettedPart = false | ) |
Bluetoothでmocopiセンサーの検索を開始する。
mocopiセンサーの検索中であればtrue、そうでなければfalseを返す。
mocopiセンサー発見時はコールバック OnSensorFoundにて通知される。
通知ステータス:Discovery
set使用タイミング: センサー接続前まで。
| excludeSettedPart | trueでペアリング済みのmocopiセンサーを検索対象から除く。 falseでペアリング状況に関係なく検索される。 |
| bool Mocopi.Mobile.Sdk.MocopiManager.StartMotionRecording | ( | ) |
モーション記録を開始する。
トラッキング中以外は使用不可。
| void Mocopi.Mobile.Sdk.MocopiManager.StartMotionStreamingRead | ( | string | fileName, |
| int | motionFormat ) |
BVH読み込みできる状態を開始する。
| fileName | ファイル名 |
| motionFormat | BVHファイルフォーマット |
| bool Mocopi.Mobile.Sdk.MocopiManager.StartSensor | ( | ) |
ペアリングを行ったmocopiセンサーすべてを接続する。
現在設定されているトラッキングタイプの部位すべてに対して接続処理が開始される。
接続処理完了時はmocopiセンサーごとにコールバックOnSensorConnectにて通知され、
すべての接続処理が完了するとコールバックOnAllSensorReadyにて通知される。
| void Mocopi.Mobile.Sdk.MocopiManager.StartSingleSensor | ( | EnumParts | part | ) |
| bool Mocopi.Mobile.Sdk.MocopiManager.StartTracking | ( | ) |
トラッキングを開始する。
既にトラッキングが開始されている場合、キャリブレーション済みでない場合、トラッキング開始の処理を失敗扱いとする。
キャリブレーション自体の成否については、OnCalibrationStateFinishedで判断する。
| void Mocopi.Mobile.Sdk.MocopiManager.StopDiscovery | ( | ) |
mocopiセンサーの検索を停止する。
StartDiscoveryを実行してmocopiセンサー検索中となっていない場合は何もしない。
| bool Mocopi.Mobile.Sdk.MocopiManager.StopMotionRecording | ( | ) |
モーション記録を停止する。
トラッキング中以外は使用不可。
| void Mocopi.Mobile.Sdk.MocopiManager.StopMotionStreamingRead | ( | ) |
BVH読み込みできる状態を停止する。
| void Mocopi.Mobile.Sdk.MocopiManager.StopSensor | ( | ) |
トラッキング停止と全センサー切断を行う。
切断はコールバック OnSensorDisconnected にて通知される。
| void Mocopi.Mobile.Sdk.MocopiManager.StopTracking | ( | ) |
トラッキングを停止する。
トラッキング中だった場合トラッキング停止処理を行う。
トラッキング開始していない場合にはなにもしない。
同時にモーション録画処理も終了させる。
| bool Mocopi.Mobile.Sdk.MocopiManager.SwitchButtonNotify | ( | string | sensorName, |
| bool | isActiveSingle, | ||
| bool | isActiveDouble, | ||
| bool | isActiveTriple ) |
mocopiセンサーのボタンが押された際の通知を設定する。 mocopiセンサー名 1回押したか 2回押したか 3回押したか 正常に設定できた場合、true。設定できなかった場合、false。 mocopiセンサーのボタンが押された際に コールバック OnSensorButtonPressed を発火させるmocopiセンサーと回数を登録する。
| MocopiEventHandlerSettings Mocopi.Mobile.Sdk.MocopiManager.EventHandleSettings |
ユーザー設定用のコールバック群
| EnumFirmwareStatus Mocopi.Mobile.Sdk.MocopiManager.status |
指定したmocopiセンサーのファームウェアバージョンを確認する。
指定したmocopiセンサーのファームウェアバージョンとそのバージョンが最新バージョンより新しいのか古いのか、もしくは最新バージョンと同等なのかを返す。
| sensorName | mocopiセンサー名 |
|
staticget |
シングルトン用の自分自身のインスタンス
|
getset |
高度な機能の接続部位への変換を行うかどうか。
|
get |
キャリブレーションに成功したか。
|
get |
センサー探索中かどうか。
|
get |
腰固定するかどうか。
|
get |
モーション記録中かどうか。
|
get |
トラッキング中かどうか。
|
get |
センサーの最新ファームウェアバージョン
|
get |
ログ出力用クラス
|
getset |
mocopiで使用するアバター
|
get |
mocopiセンサーのファームウェアのバージョンが古い状態のセンサーリスト
|
staticgetset |
SDKの動作モード
|
getset |
メインスレッド実行用のコンテキスト
|
get |
トラッキングタイプ