Mixed Reality 空間データパッケージャーのドキュメントMixed Reality Spatial Data Packager Documentation

注意

このツールとその操作は、そのとおりに提供されます。This tool and its operation are offered as-is. 予告なしに変更されることがあり、今後の Windows または Windows Mixed Reality のリリースと互換性がない可能性があります。It is subject to change without any notice and may not be compatible with future Windows or Windows Mixed Reality HMD releases.

ダウンロードDownload

MixedRealitySpatialDataPackager をこちらからダウンロードDownload MixedRealitySpatialDataPackager here

クィックQuickstart

Mixed Reality 空間データパッケージャーツールは、エクスポートとインポートの2つの手順を通じて、ターゲットアプリの空間データをある PC から別の PC にコピーします。The Mixed Reality Spatial Data Packager tool copies the spatial data of a target app from one PC to another through a two step export and import process. このツールは、管理者特権で実行する必要があり、インポート時に既存の空間データを削除します。The tool must be run with administrator privileges and deletes the existing spatial data on import. Export は、既存の空間データをそのまま残します。Export leaves the existing spatial data intact.

重要な要件と制限事項:Key requirements and limitations:

  1. ツールは、管理者特権で実行する必要がありますTool must be run with administrator privileges
  2. ツールを実行した後に Mixed Reality ポータルが不安定な場合は、PC の再起動が必要になることがありますYou may have to restart PC if Mixed Reality Portal is unstable after running the tool
  3. 空間データのバージョンの不一致または非互換性の検出時にツールが実行されないTool will not run when encountering spatial data version mismatches or incompatibilities
  4. インポート時に既存の空間データが消去されますTool will erase existing spatial data on import
  5. インポート処理が失敗した場合、以前のデータをエクスポートしてバックアップしていない限り、以前のデータを復元することはできません。If import process fails previous data cannot be restored unless it has been backed up by exporting previously
  6. 空間マップデータの "読み取り専用" モードでのインポート機能の品質Quality of import functionality contingent on “Read-Only” mode for spatial map data

マッピングのベストプラクティスMapping Best Practices

  1. コントロールパネルから既存のマップをクリアする (設定 > Mixed Reality-> Environment-環境データをクリア >)Clear existing maps from the Control Panel (Settings -> Mixed Reality -> Environment -> Clear environment data)
  2. 適切な追跡に十分な照明を確保し、ロックされたマップモードを実行している場合は、同じ照明を維持しますEnsure sufficient lighting for good tracking and if running locked map mode try to maintain the same lighting
  3. 可能な場合は、暗い領域、影付き領域の横に高い照明の領域を避けて、光源の範囲を小さくします。When possible keep the lighting dynamic range low by avoiding areas of high illumination next to dark, shadowed areas
  4. 空白の領域を最小化する (たとえば、異なるポスターの範囲をホワイトウォールに配置する)Minimize blank, textureless surfaces e.g. place a range of different posters on white walls
  5. オブジェクトの移動など、シーンに動的オブジェクトを使用せずに領域をマップするMap the space without dynamic objects in the scene such as moving people
  6. インポート時にマップをロックする (Insider Preview 経由で利用可能)Lock the map on import (available via Insider Preview)
  7. トラックの品質が低下したとき、または環境に変化があった場合に、マップのロックを解除して環境を再スキャンする (照明またはオブジェクトのレイアウトの変更)Unlock the map and rescan the enviornment when tracking quality degrades and/or there are changes in the environment (lighting or changes in object layout)

コンパニオンスクリプトを使用した Mixed Reality 空間データパッケージャーの実行Running Mixed Reality Spatial Data Packager with Companion Script

マップツールを実行する MRSpatialPackagerHelperScript が用意されています。We have provided MRSpatialPackagerHelperScript.ps1 that runs the map packager the tools.

スクリプトのパラメーターは次のように定義されています。The script parameters are defined below:

-AppName <String>
    On export: The spatial anchors from the app of interest
    On import: The target app that spatial anchors should be imported for
    Returns a list of apps containing the input string if a unique app is not found

-UserName <String>
    Target username, will return a list of users if a unique match is not found

-Mode <String>
    import or export

-MapxPath <String>
    On export: Directory to export your mapx files
    On import: Directory where import mapx are stored

-LockMap <Int32>
    0 to unlock map
    1 to lock map
    This functionality requires an updated driver from Insider Preview Builds with the Map Locking feature

-BinPath <String>
    Path to MixedRealitySpatialDataPackager.exe, default value is current directory

Powershell スクリプトの使用例と出力Powershell Script Example Usage and Output

.\MRSpatialPackagerHelperScript.ps1-AppName holoshell-UserName Administrator-Mode export-MapxPath D:\temp-LockMap 0.\MRSpatialPackagerHelperScript.ps1 -AppName holoshell -UserName Administrator -Mode export -MapxPath D:\temp\ -LockMap 0

Package Family Name for holoshell: HoloShell_cw5n1h2txyewy
User SID for Administrator: S-1-5-21-1279937937-3984375698-1043392598-499
Lock map value succesfully set to 0

Running: C:\bin\MixedRealitySpatialDataPackager.exe export D:\temp\ HoloShell_cw5n1h2txyewy S-1-5-21-1279937937-3984375698-1043392598-499

Attempting to disable Windows MR driver
Driver disabled
Validating spatial data version information...
Device spatial data version OK
External spatial data version OK
Importing spatial anchors for user account phguan
Stopping SPECTRUM
Stopped SPECTRUM
Stopping SHAREDREALITYSVC
Stopped SHAREDREALITYSVC
Space ID is {00000000-4321-0000-0000-000000000000}
SUCCESS: Unpacked Space from D:\temp\map\het.mapx to
C:\ProgramData\WindowsHolographicDevices\SpatialStore\HoloLensSensors\{00000000-4321-0000-0000-000000000000}\
Space ID is {78FA06B5-4416-4815-BB00-B3CB5C983B7D}
SUCCESS: Unpacked Space from D:\temp\map\sa.mapx to
C:\ProgramData\Microsoft\Spectrum\PersistedSpatialAnchors\
Attempting to enable Windows MR driver
Driver enabled
Starting SHAREDREALITYSVC
Started SHAREDREALITYSVC
Starting SPECTRUM
Started SPECTRUM
IMPORT SUCCESS

MixedRealityPackager を使用してエクスポートする方法How to Export using MixedRealityPackager.exe

MixedRealitySpatialDataPackager.exe export <folderpath to mapx files> <source package family name>    

デバイスからマップをエクスポートすると、het. mapx と sa. mapx という2つの mapx ファイルが生成されます。Exporting maps off device generates two mapx files, het.mapx and sa.mapx. エクスポートプロセスでは、指定されたアプリとユーザーが作成した境界 (存在する場合) を除き、すべての空間アンカーが削除されます。During the export process all spatial anchors are removed except for the specified app and the user-created boundary (if it exists). ソースパッケージファミリ名は、インストールされている既存のアプリと一致する必要があります。一致しないと、exe は失敗します。The source package family name must match an existing installed app or the exe will fail.

MixedRealityPackager を使用してインポートする方法How to Import using MixedRealityPackager.exe

MixedRealitySpatialDataPackager.exe import <folderpath to mapx files> <target package family name> <user SID>

インポートによって既存の空間データが削除され、指定したディレクトリのデータで置き換えられます。Import deletes the existing spatial data and replaces it with the data from the specified directory. アプリ名の入力では、空間アンカーをインポートする対象アプリのパッケージ名を指定し、ターゲットユーザー SID で、インポートされた空間アンカーへのアクセス権を持つユーザーを指定します。The app name input specifies the package name of the target app that like the spatial anchors should be imported for and the target user SID specifies the user that should have access to the imported spatial anchors. ターゲットパッケージファミリ名とユーザー Sid が PC 上の既存の値と一致している必要があります。指定しないと、exe は失敗します。The target package family name and user SIDs must match existing values on the PC or the exe will fail.


エラー メッセージError Messages

さらに、次のエラーメッセージにも HRESULT が付随します。In addition the error messages below failures will also be accompanied with an HRESULT

エラーが発生した場合は、無効な引数If there was an error invalid arguments

Invalid command line parameters

実行可能ファイルが管理者モードで実行されなかった場合If the executable was not run in administrator mode

1. Unable to determine elevation privileges 
2. Please run with administrator privileges 

ドライバーの有効化または無効化でエラーが発生した場合If there was an error enabling or disabling the driver

1. Could not find the specified driver with class GUID {d612553d-06b1-49ca-8938-e39ef80eb16f}
2. Could not find the device instance ID for specified driver with class GUID {d612553d-06b1-49ca-8938-e39ef80eb16f}
3. Could not find the specified driver with device instance ID <INSTANCE ID>
4. Failed to enable/disable driver

空間データベースバージョンの検証中にエラーが発生した場合If there was an error validating the spatial database version

1. Could not read database version
2. This tool is not compatible with the current driver version of Windows Mixed Reality and/or the spatial data provided to replace the existing spatial data is an invalid version.
3. No spatial data is present on the current device please connect your Mixed Reality device to initialize spatial data. If the problem persists please restart your PC.

ターゲットのインポート/エクスポートアプリに指定されたパッケージファミリ名の検証中にエラーが発生した場合If there was an error validating the package family name provided for target import/export app

The package family name does not correspond to an installed app

ユーザー SID の検証中にエラーが発生した場合If there was an error validating the user SID

Failed to find local user for passed in user SID
1. Folder path to space store files doesn't exist 
2. het.mapx or sa.mapx file doesn't exist in <PATH> for import
3. Unable to create directory at <PATH> for export
1. Unable to open service manager <SERVICE>
2. Timed out trying to start/stop <SERVICE>