diff --git a/README.md b/README.md index 613f1deae8a0ef86d51fe25dcf40ab50fe066669..ce7024608ff181e79baa230217b2e6ce58bb4f11 100644 --- a/README.md +++ b/README.md @@ -29,26 +29,28 @@ or clone the repo updating the submodules directly: Once it's done, you can open your project from the Unity Hub, the project was coded in Unity 2021.3.0 and # Test Scenario (Unity Scene) -This repo is used to demonstrate and to show the usage of the World Storage API in relation with UI functionalities given by the Unity editor. The project uses for this the inspector and graph windows techniques. The Unity project can be found here: +This repo is used to demonstrate and to show the usage of the World Storage API in relation to GUI functionalities given by the Unity editor. The project uses for this the inspector and graph window techniques. -.\Assets\ETSI.ARF\ARF World Storage API\Scenes\WorldStorageSample.unity +The Unity project can be found here: -The project uses the 'Museum' scenario wit a statue as described in the GS 005 documentation. + .\Assets\ETSI.ARF\ARF World Storage API\Scenes\WorldStorageSample.unity - +The project uses the 'Museum' scenario wit a statue as described in the GS 005 documentation. In the figure below, a statue would be augmented with some AR contents (e.g. a nose label). For this, some World Trackables, Anchors and Links are created (left picture in the figure) and are placed in the Unity scene onto the correct position (right picture). The statue serves as a digital twin and won't be visible in a final application. + + # Description of UI / editor functions This Unity Editor module allows the user to author the World Storage through various ways. To interact with a server hosting an implementation of the World Storage, the user first must create an Unity object "World Storage Server" via the contextual menu (Create -> ARF World Storage -> Create Server) and then fill the corresponding informations (name, URL, port...). - + ## World Storage Window Through the Unity inspector of the World Storage Server, the user can click on the `Open World Storage Window...` button. This opens the authoring tool for the corresponding World Storage. - - + +The main window (left picture in the figure) manage the server's data and list of World Elements. From this window, the user can access to specific windows to edit the parameters of lements (right picture, e.g. parameters of a trackable). ## World Graph Window