diff --git a/Images/UnityEditor.png b/Images/UnityEditor.png new file mode 100644 index 0000000000000000000000000000000000000000..ab660bb3436d79c029c9ecc9b78f1a4b51bd73da Binary files /dev/null and b/Images/UnityEditor.png differ diff --git a/Images/ValidationScene.png b/Images/ValidationScene.png new file mode 100644 index 0000000000000000000000000000000000000000..6ff82c927dc2d2921b821e0e21e9d981d4438f6c Binary files /dev/null and b/Images/ValidationScene.png differ diff --git a/README.md b/README.md index 9b934674617a0559b98c391cfb720214c0d3e2c2..613f1deae8a0ef86d51fe25dcf40ab50fe066669 100644 --- a/README.md +++ b/README.md @@ -28,16 +28,27 @@ 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: + +.\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. + + + # 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. -In this editor, the user has access to... -TODO + + + ## World Graph Window