Merge pull request #12 from jbienzms/Dev

Updating 1.0.0 with docs, recording fixes and packaging

Author: jbienzms

External/Packaging/Package-Alignment.bat

@@ -0,0 +1,40 @@
+REM @ECHO OFF
+ECHO.
+
+pushd .
+cd ..
+cd ..
+
+REM Set Paths
+SET UnityExe="%ProgramFiles%\Unity\Hub\Editor\2018.3.0b11\Editor\Unity.exe"
+SET ProjectDir=%cd%\SpatialAlignment-Unity
+SET AssetDir=%ProjectDir%\Assets
+SET PackageDir=%cd%\External\UnityPackages
+
+REM Set Package Info
+SET PackageName=SpatialAlignment
+SET PackageVersion=1.0.0
+SET PackageFileName=%PackageName%-%PackageVersion%.unitypackage
+
+ECHO Packaging %PackageName% %PackageVersion%
+
+ECHO Defining Asset List
+SET Assets=%Assets% Assets\SpatialAlignment
+SET Assets=%Assets% Assets\SpatialAlignment-Examples
+
+ECHO Generating %PackageFileName% ...
+%UnityExe% -batchmode -projectPath %ProjectDir%\ -exportPackage %Assets% %PackageDir%\%PackageFileName% -quit
+
+IF ERRORLEVEL 1 GOTO PACKAGINGERROR
+
+:SUCCESS
+ECHO "Package Success!"
+GOTO END
+
+:PACKAGINGERROR
+ECHO "Packaging Error"
+PAUSE
+GOTO END
+
+:END
+popd

External/ReadMeImages/Align-FramesAndStrategies.png

@@ -0,0 +1,81 @@
+# Spatial Alignment for Unity
+
+This reference architecture includes many helpful components for aligning and keeping virtual objects aligned with the physical world.
+
+
+### Release 1.0
+
+Release 1.0 contains the following capabilities:
+
+
+#### Spatial Frames
+
+*Spatial Frames* represent "islands" in the real world. They have a position and a rotation and are designed to hold objects. They also have unique IDs and are available from the moment the application loads (even before they're found in the real world). This simplifies application logic because objects can be loaded up front and automatically aligned when the frame is found. 
+ 
+![](External/ReadMeImages/Align-FramesAndStrategies.png)
+
+
+##### Alignment Strategies
+
+Each *Spatial Frame* has an *Alignment Strategy*. The strategy is what moves the frame and keeps it aligned in the physical world. Alignment Strategies are "plugins", and developers can easily create their own strategies. Developers are also free to mix and match various strategies in the same application.
+ 
+![](External/ReadMeImages/Align-MixStrategies.png)
+
+Alignment Strategies provide information about their state (e.g. whether they've been found) and their accuracy (maximum drift in meters). Applications can use this information to make intelligent decisions about which frames are best to contain which objects. In fact, one of the included alignment strategies is a *Multi-Parent* strategy that allows objects to automatically "hop" parent frames based on their state and accuracy.   
+
+![](External/ReadMeImages/Align-ParentHopping.png)
+
+
+#### Refinement
+
+Two of the biggest challenges that accompany spatial alignment are:
+
+1.  Initial placement (and rotation) of objects to match up with the physical world
+2.  Accounting for drift that accumulates over distance (a challenge that is present in all large-scale tracking systems)
+
+This reference architecture includes components to help address both. To help with accurate alignment, an extensible system of *Refinement Controllers* is provided. Version 1.0 includes one refinement controller called **RayRefinement**. **RayRefinement** aligns a virtual model to a physical place by selecting corresponding origin points and directions.
+
+![](External/ReadMeImages/Align-RayRefine.gif)
+
+To help compensate for drift, *Multi-Parent* alignment offers the ability to apply different positional and rotational offsets at each parent.
+
+![](External/ReadMeImages/Align-Refine.png)
+
+The offset ability can be used together with a *Refinement Controller* to bring large-scale models back into alignment when viewed from different locations. 
+
+The video below demonstrates using **RayRefinement** to align a [Matterport 3D](https://matterport.com/) scan of a building with the actual building and keep that scan in alignment from different locations.
+
+[![](External/ReadMeImages/Align-MPScanVideo.jpg)](https://youtu.be/IINWbBeIRL0)
+
+
+#### Persistence
+
+Applications that leverage spatial alignment generate a notable amount of configuration data:
+
+- All of the Frames and their IDs
+- All of the configuration settings for each Alignment Strategy
+- Relationships between Frames (e.g. Multi-Parent alignment)
+- Position, Rotation and Scale offsets
+- State requirements (e.g. Resolved, Tracking)
+- Accuracy requirements
+- etc.
+
+To help applications save all of this data, every component in the architecture is serializable. In fact, the included class **JsonStore** can be used to serialize an entire alignment "graph" into json, which can then be loaded back the next time the application runs.
+
+![](External/ReadMeImages/Align-Persistence.png)
+
+
+#### Examples
+
+Release 1.0 includes the following example scenes:
+
+- **SA-MultiParent** - Demonstrates "hopping" between multiple parent spheres in the scene.
+- **SA-Persistence** - Demonstrates saving an entire "graph" of frames and their strategies into memory then loading them back into the scene.
+- **SA-Refinement** - Demonstrates using **RayRefinement** to place a multi-colored cube in a room.
+- **SA-RefinementBuilding** - Demonstrates using **RayRefinement** to align a Matterport 3D scan to room. (This example is shown in the video above).
+
+
+### Contributing
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). 
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.