Open4

MRTK3のドキュメントを読む

イワケンイワケン

Mixed Reality Toolkit 3


MRTK3 is the third generation of the Microsoft Mixed Reality Toolkit for Unity. It is a Microsoft driven open source project to accelerate cross-platform mixed reality development in Unity. This new version is built on top of Unity's XR Management system and XR Interaction Toolkit. Here are some of its functions:

MRTK3は、Microsoft Mixed Reality Toolkit for Unityの第3世代です。マイクロソフトが推進するオープンソースプロジェクトで、Unityでのクロスプラットフォームな複合現実感開発を加速させるためのものです。この新バージョンは、UnityのXR Management systemとXR Interaction Toolkitの上に構築されています。ここでは、その機能の一部を紹介します。

  • Provides the cross-platform input system and building blocks for spatial interactions and UI.

  • Enables rapid prototyping via in-editor simulation that allows you to see changes immediately.

  • Operates as an extensible framework that allows developers the ability to swap out core components.

  • Supports a wide range of platforms:

  • クロスプラットフォームの入力システムと、空間インタラクションおよびUIのためのビルディングブロックを提供します。

  • エディタ内でのシミュレーションにより、変更を即座に確認できるラピッドプロトタイピングを可能にします。

  • 拡張可能なフレームワークとして動作し、開発者はコアコンポーネントを交換することができます。

  • さまざまなプラットフォームをサポートします。

Paltform

  • OpenXR XR Devices
    • Microsoft HoloLens 2
    • Meta Quest
    • Windows Mixed Reality
    • SteamVR
    • Oculus Rift on OpenXR
  • Windows
    • Traditional flat-screen desktop

Welcome to the MRTK3 Public Preview!

We hear your excitement, and we want to give you early access to our newest features and invite you to take part in shaping our future iterations through your feedback. MRTK3 is now in public preview, which represents our current snapshot in development. Some features are still missing, broken, or otherwise not at parity with MRTK 2.x. We appreciate your patience while we shape the future of MRTK and look forward to your feedback and suggestions. We’re excited to give you a glimpse of what is to come!

MRTK3 は現在、パブリック・プレビュー版として開発中です。MRTK3 は現在、開発中のスナップショットであるパブリックプレビュー版です。MRTKの未来を形作る間、あなたの忍耐に感謝し、あなたのフィードバックと提案を楽しみにしています。MRTKの未来を垣間見ることができ、とても嬉しく思っています。

Key improvements 主な改善点

Architecture

  • Built on Unity XR Interaction Toolkit and the Unity Input System
    • XR Interaction Toolkit & Unity Input Systemに対応
  • OpenXR focused
    • OpenXRを強制
  • Open-ended and flexible interaction paradigms

Performance

  • Rewrote and redesigned most features and systems, from UX to input, to subsystems
    • MRTK2から書き直した
  • Zero per-frame memory allocation
    • メモリ割り当てがフレームあたりゼロ
  • Tuned for maximum performance on HL2 and other resource-constrained mobile platforms
    • Holo2やモバイルに最適化したパフォーマンス

User Interface

  • New interaction models (gaze-pinch indirect manipulation)
  • Updated Mixed Reality Design Language
  • Unity Canvas + 3D UX: production-grade dynamic auto-layout
  • Unified 2D & 3D input for gamepad, mouse, and accessibility support
  • Data binding for branding, theming, dynamic data, and complex lists

Accessibility

  • Low vision aids
  • Input assistance

Long Term Support

  • OpenXR, Unity 2020.3 LTS, Unity’s XR Interaction Toolkit as minimum requirements

What should this public preview be used for? このパブリックプレビューは、どのようなことに使われるべきでないのでしょうか?

  • Try out our newest features and build prototypes
    • 最新機能の試用とプロトタイプの作成
  • Familiarize yourself with XRI and the Unity infrastructure on top of which MRTK3 is built
    • MRTK3が構築されているXRIとUnityのインフラに精通する。
  • Evaluate the new packaging strategy and the a la carte dependency model
    • 新しいパッケージング戦略とアラカルト依存モデルの評価
  • Explore OpenXR compatibility and features
    • 新しいパッケージング戦略とアラカルト依存モデルの評価
  • Learn about our new UX systems and visual design language
    • 新しいUXシステムとビジュアルデザイン言語について学ぶ

What should this public preview not be used for? このパブリックプレビューは、どのようなことに使われるべきでないのでしょうか?

  • Migrating any existing projects from 2.x to MRTK3. The current API instability may make a migration effort frustrating.
    • 2.x から MRTK3 への既存プロジェクトの移行。現在のAPIの不安定さは、移行作業を挫折させるかもしれません。
  • Writing production-ready code that expects a stable API
    • 製品開発コード
  • Evaluate performance for your applications (Full release may have significant performance differences compared to the codebase today)
    • アプリケーションのパフォーマンス評価

Software Requirements

Versioning

In previous versions of MRTK (HoloToolkit and MRTK v2), all packages were released as a complete set, marked with the same version number (ex: 2.8.0). Starting with MRTK3, each package will be individually versioned, following the Semantic Versioning 2.0.0 specification.

MRTKの以前のバージョン(HoloToolkitとMRTK v2)では、すべてのパッケージは同じバージョン番号(例:2.8.0)でマークされた完全なセットとしてリリースされました。MRTK3からは、Semantic Versioning 2.0.0仕様に基づき、各パッケージは個別にバージョン管理されるようになります。

Individual versioning will enable faster servicing while providing improved developer understanding of the magnitude of changes and reducing the number of packages needing to be updated to acquire the desired fix(es).
個々のバージョン管理は、開発者が変更の大きさを理解し、必要な修正を得るためにアップデートするパッケージの数を減らしながら、より迅速なサービスを提供することができます。

For example, if a non-breaking new feature is added to the UX core package, which contains the logic for user interface behavior the minor version number will increase (from 3.0.x to 3.1.0). Since the change is non-breaking, the UX components package, which depends upon UX core, is not required to be updated.
たとえば、ユーザーインターフェースの動作のロジックを含む UX core パッケージに壊れない程度の新機能が追加された場合、マイナーバージョン番号は増加します (3.0.x から 3.1.0 へ)。この変更はブレークしないので、UX coreに依存するUX componentsパッケージは更新する必要はありません。

As a result of this change, there is not a unified MRTK3 product version.
この変更により、MRTK3の製品バージョンが統一されることはありません。

To help identify specific packages and their versions, MRTK3 provides an about dialog that lists the relevant packages included in the project. To access this dialog, select Mixed Reality > MRTK3 > About MRTK from the Unity Editor menu.
MRTK3では、特定のパッケージとそのバージョンを識別するために、プロジェクトに含まれる関連パッケージの一覧を表示する「about」ダイアログを用意しています。このダイアログにアクセスするには、Unity Editorメニューから、Mixed Reality > MRTK3 > About MRTKを選択します。

Branch Status

MRTK3 is currently in public preview and it is not recommended for use in production projects. We appreciate your testing, issues and feedback while the team works towards general availability (GA).
MRTK3は現在パブリックプレビューであり、プロダクションプロジェクトでの使用は推奨されません。一般提供(GA)に向けてチームが取り組んでいる間、テスト、問題、フィードバックをお願いします。

Early preview packages

Some parts of MRTK3 are at earlier stages of the development process than others. Early preview packages can be identified in the Mixed Reality Feature Tool and Unity Package Manager by the Early Preview designation in their names.

As of June 2022, the following components are considered to be in early preview.

MRTK3には、開発プロセスの初期段階にある部分があります。Mixed Reality Feature ToolとUnity Package Managerでは、パッケージ名にEarly Previewの表記があるため、早期プレビューのパッケージを識別することができます。

2022年6月現在、以下のコンポーネントがアーリープレビューとされています。

The MRTK team is fully committed to releasing this functionality. It is important to note that the packages may not contain the complete feature set that is planned to be released or they may undergo major, breaking architectural changes before release.

We very much encourage you to provide any and all feedback to help shape the final form of these early preview features.

MRTK チームは、この機能をリリースすることに全力を尽くしています。パッケージはリリースされる予定の機能一式を含んでいない可能性があり、またリリース前にアーキテクチャの大きな変更、破壊が行われる可能性があることに留意することが重要です。

私たちは、これらの初期プレビュー機能の最終形を形成するために、あらゆるフィードバックを提供することを強くお勧めします。

イワケンイワケン

https://docs.microsoft.com/ja-jp/windows/mixed-reality/mrtk-unity/mrtk3-overview/setup

Initial Setup for MRTK3

Welcome to the MRTK3 public preview! As MRTK3 is a collection of loosely coupled packages, consuming MRTK3 is different from that of MRTK 2.x. We don't ship MRTK as a Unity project, so you're expected to either use our example template project, which is pre-configured to consume all MRTK packages (easier to get started), or start fresh with a new project (gives you more control, recommended).

MRTK3 パブリックプレビューへようこそ!MRTK3 は疎結合のパッケージのコレクションなので、MRTK3 を消費することは MRTK 2.x のそれとは異なります。我々は MRTK を Unity プロジェクトとして出荷しないので、すべての MRTK パッケージを消費するように事前に設定された我々のサンプルテンプレートプロジェクトを使用するか(簡単に始められます)、新しいプロジェクトで新たに始めることが期待されています(よりコントロールできます、推奨)。

You're not expected to consume every MRTK package. See which features are useful to you and add only the dependencies that matter.
すべての MRTK パッケージを使用する必要はありません。** どの機能があなたにとって有用であるか確認し、重要な依存関係のみを追加してください。**

Install the tools

事前にこちらからツールをインストールする
https://docs.microsoft.com/en-us/windows/mixed-reality/develop/install-the-tools?tabs=unity

Path 1: Clone the repository and try out the sample Unity Project

The easiest way of acquiring and trying out MRTK3 is to do so via our pre-configured project with references to all of the current MRTK3 packages. Please clone our project at our GitHub repo and checkout the mrtk3 branch. After that you can simply launch Unity (2020.3.35f1 or newer / 2021.3.4f1 or newer) on the MRTKDevTemplate project under UnityProjects and start playing with the sample scenes in Editor, via remoting or deployed to devices.

MRTK3 を入手し試す最も簡単な方法は、現在の MRTK3 パッケージのすべてを参照する、私たちの設定済みプロジェクトを通じて行うことです。GitHub リポジトリで私たちのプロジェクトをクローンし、mrtk3 ブランチをチェックアウトしてください。その後、UnityProjects の MRTKDevTemplate プロジェクトで Unity (2020.3.35f1 以降 / 2021.3.4f1 以降) を起動し、エディタ、リモーティング、デバイスへのデプロイでサンプルシーンを使い始めるだけです。

Github レポジトリ

https://github.com/microsoft/MixedRealityToolkit-Unity/tree/mrtk3

サンプルシーン

https://docs.microsoft.com/ja-jp/windows/mixed-reality/mrtk-unity/mrtk3-overview/scenes

イワケンイワケン

Path 2: Adding MRTK3 to a new Unity project

1. Create a new Unity project

Create a new Unity project with Unity 2020.3.35f1 or newer / Unity 2021.3.4f1 or newer. Close the Unity project before proceeding to the next step.

2. Import required dependencies and MRTK3 packages with Mixed Reality Feature Tool

There are a handful of packages that MRTK3 uses which are not part of this preview. To obtain these, please use the Mixed Reality Feature Tool and select the latest versions of the following in the Discover Features step:

MRTK3が使用するパッケージの中には、このプレビューに含まれていないものがいくつかあります。これらを入手するには、Mixed Reality Feature Toolを使用し、Discover Featuresのステップで以下の最新バージョンを選択してください。

  • Platform Support → Mixed Reality OpenXR Plugin
  • [Optional] Spatial Audio → Microsoft Spatializer

For MRTK3 packages, refer to the package overview page for information on packages and then select the ones that fit your needs.

MRTK3のパッケージについては、パッケージの概要ページをご参照の上、お客様のニーズに合ったものをお選びください。

When finished selecting packages, click on Get features and follow the Mixed Reality Feature Tool to import the selected packages into your Unity project.
パッケージの選択が終わったら、Get featuresをクリックし、Mixed Reality Feature Toolに従って、選択したパッケージをUnityプロジェクトにインポートしてください。

3. Open the Unity project

Open the Unity project and wait for Unity to finish importing the newly added packages. There may be two pop ups in this process:

Unityプロジェクトを開き、Unityが新しく追加されたパッケージのインポートを完了するのを待ちます。この過程で、2つのポップアップが表示されることがあります。

  1. The first pop up asks whether you want to enable the new input backend. Make sure you press yes.

  2. The second pop up asks whether you want to update XR InteractionLayerMask. Make sure you press No Thanks.

  3. 最初のポップアップで、新しい入力バックエンドを有効にするかどうか尋ねられます。必ず 「Yes」 を押してください。

  4. 2つ目のポップアップで、XR InteractionLayerMaskを更新するかどうか尋ねられます。必ず No Thanks を押してください。

Unity may restart a few times in this process and please wait it to finish before proceeding.

この過程でUnityが数回再起動することがありますが、完了するまでお待ちください

4. Configure MRTK profile after import

一度インポートしたMRTK3は、スタンドアロンと追加した各ターゲットプラットフォーム用にプロファイルを設定する必要があります。

  1. Edit > Project Settings
  2. Project SettingsでMRTK3に移動し、[スタンドアロン]タブに切り替えます。プロファイルは最初は未指定であることに注意してください。
  3. Populate the field with the default MRTK profile that ships wih the core package. You can type in the keyword "MRTKprofile" in the search bar of the project window and make sure you search in All. Alternatively you can find the profile under Packages/com.microsoft.mrtk.core/Configuration/Default Profiles/MRTKProfile.asset.