HoloToolkit资源包

## [Sharing]() The HoloToolkit.Sharing library allows applications to span multiple devices, and enables holographic collaboration. Originally developed for OnSight, a collaboration between SOTA (a Microsoft studio) and NASA to enhance their existing Mars rover planning tool with HoloLens, HoloToolkit.Sharing enables users to use multiple devices for a task by allowing the apps running on each device communicate and stay in sync seamlessly in real time. Users can also collaborate with other users (who are also using multiple devices) who may be in the same room or working remotely. ## Table of Contents - [Features](#features) - [Configuration](#configuration) - [Troubleshooting](#troubleshooting) - [Plugins](#plugins) - [Prefabs](#prefabs) - [Scripts](#scripts) - [Test Prefabs](#test-prefabs) - [Test Scripts](#test-scripts) - [Tests](#tests) ### Features --- #### Lobby & Session system * Discover available sessions or create your own * Permanent or ‘until empty’ session lifetime * See user status: current session, mute state * Easy to discover and hop between sessions #### Anchor Sharing * Users in a session can be in the same or different physical rooms * Users can share the location of Holographic 'anchors' they place in their room with other users in the same room * Users joining late can download all anchors in the session * Allows multiple users to see shared holograms #### Synchronization System Synchronize data across all participants in session * Everyone in session guaranteed to see the same thing * Automatic conflict resolution for simultanious conflicting remote changes * Real-time: See remote changes as they happen * Shared data sets automatically merged when new users join a session * Responsive: no delay in your own changes * Ownership: your data leaves session when you do #### Group Voice Chat Support for VOIP is built-in * Server-based mixing lowers processing and bandwidth requirements for clients #### Visual Pairing Connect devices just by looking at them * One device displays a QR code with connection info and security code * Other device sees QR code, connects, and validates with security code * Can also detect location in 3D space using built-in fiducial marker support #### Profiler Profiling and debugging an experience that spans multiple devices is challenging. So HoloToolkit.Sharing provides an app that can connect to multiple devices at once and aggregates their timings and debug output in a single place #### Sync Model HoloToolkit.Sharing has the ability to synchronize data across any application connected to a given session. Conflict resolution is automatically handled by the framework, at whichever level the conflict occurs. ##### Primitive Types The following primitives are natively supported by the sync system. The C# class that corresponds to each primitive is written in parentheses. - Boolean (SyncBool) - Double (SyncDouble) - Float (SyncFloat) - Integer (SyncInteger) - Long (SyncLong) - Object, which is a container class that can have child primitives (SyncObject - String (SyncString) On top of the native primitives above, the following types are supported in the C# layer: - Quaternion (SyncQuaternion) - Transform (SyncTransform) - Unordered array (SyncArray) - Vector3 (SyncVector3) Other types can be built for your own application as needed by inheriting from SyncObject in a similar way to what SyncVector3 and SyncTransform do. ##### Defining the Sync Model By default, the SyncRoot object (which inherits from SyncObject) only contains an array of InstantiatedPrefabs, which may not be enough for your application. For any type inheriting from SyncObject, you can easily add new children primitives by using the SyncData attribute, such as in the following example: public class MySyncObject : SyncObject { [SyncData] public SyncSpawnArray<MyOtherSyncObject> OtherSyncObject; [SyncData] public SyncFloat FloatValue; } Any SyncPrimitive tagged with the [SyncData] attribute will automatically be added to the data model and synced in the current HoloToolkit.Sharing session. ### Configuration --- Ensure you have the following capabilities set in Player Settings -> Windows Store -> Publishing Settings -> Capabilities: 1. SpatialPerception 2. InternetClientServer 3. PrivateNetworkClientServer 4. Microphone capabilities Install or run the server instance. ### Troubleshooting --- - Double check the Server Address on your sharing stage component in your scene matches the address shown in the sharing service console. - Make sure all devices are connected to the same Wireless Local Area Network. - Ensure all firewall settings are correct. Windows firewall gives you options to enable/disable by network type (private, public, home), make sure you're enabling the firewall for your connection's type. #### Invalid Schema Version ``` SharingService [..\..\Source\Common\Private\SessionListHandshakeLogic.cpp (67)]: *************************************************************** List Server Handshake Failed: Invalid schema version. Expected: 17, got 15 Please sync to latest XTools *************************************************************** ``` - Ensure you're using the latest binaries of the sharing service found at `HoloToolkit-Unity\External\HoloToolkit\Sharing\Server`. ### [Plugins](Plugins) --- Contains compiled architecture specific binaries for SharingClient.dll which are required by the Unity application for accessing sharing APIs. Binaries are compiled from the native [HoloToolkit\Sharing](https://github.com/Microsoft/HoloToolkit/tree/master/Sharing). ### [Prefabs](Prefabs) --- Prefabs related to the sharing and networking features. #### Sharing.prefab 1. Enables sharing and networking in your Unity application. 2. Allows you to communicate between a Windows and non-Windows device. **SharingStage.cs** allows you to be a Primary Client (typical case). **Server Address** is the IP address of the machine running the HoloToolkit -> Launch Sharing Service. **Server Port** displays the port being used for communicating. **AutoJoinSession.cs** creates a shared session with Session Name 'Default' which is customizable. Joins a player to that session if once already exists. ### [Scripts](Scripts) --- Scripts related to the sharing and networking features. #### [Editor](Scripts/Editor) --- Scripts for in editor use only. ##### SharingMenu.cs Enables users to start the Sharing Service, Sharing Manager, and Profiler from the Unity Editor via the HoloToolkit Menu. ##### SharingStageEditor.cs Draws the default Sharing Stage Inspector and adds the SyncRoot Hierarchy view so users can quickly verify Sync Object updates. #### [SDK](Scripts/SDK) --- Contains scripts compiled from the native [HoloToolkit\Sharing](https://github.com/Microsoft/HoloToolkit/tree/master/Sharing) repository and using the SWIG tool to generate different language bindings. #### [Spawning](Scripts/Spawning) --- Scripts for spawning objects using the sharing service. ##### PrefabSpawnerManager.cs A SpawnManager that creates a GameObject based on a prefab when a new SyncSpawnedObject is created in the data model. This class can spawn prefabs in reaction to the addition/removal of any object that inherits from SyncSpawnedObject, thus allowing applications to dynamically spawn prefabs as needed. The PrefabSpawnManager registers to the SyncArray of InstantiatedPrefabs in the SyncRoot object. The various classes can be linked to a prefab from the editor by specifying which class corresponds to which prefab. Note that the class field is currently a string that has to be typed in manually ("SyncSpawnedObject", for example): this could eventually be improved through a custom editor script. ##### SpawnManager.cs A SpawnManager is in charge of spawning the appropriate objects based on changes to an array of data model objects. It also manages the lifespan of these spawned objects. This is an abstract class from