Backend - sitcomlab/IPED-Toolkit GitHub Wiki
1. Create a Location
Locations are used to relate the IPED data to a fixed spatial reference point. Every data entered into the system will be related to a spatial location on the map. This is needed to create relationships among the data.
-
You can add a new location by right-clicking onto the map and afterwards selecting the context menu entry "Add new location". A popup window will appear in which you can enter your data as needed.
-
Beside adding the locations name, description and tags you can select an already existing video footage for the location from a dropdown menu. However, you can create a new video footage using the button "Add new video footage" (an introduction on how to create a new video will is given in section 1.3).
-
You are also able to add overlays to the location, which will then be visualized on top of the footage in the frontend. It is possible to add more than one overlay. As with the video footages you can add new ones or make use of previously created ones.
-
Use the button "Save" at the bottom of the window to save your changes to the system's underlying database.
2. Create a Relationship between 2 Locations
Relationships are used to allow navigating between the different locations. When using the remote for navigating from one location to another, only locations which are referenced by the current lcoation can be selected.
-
To add a new relationship, right-click on one of the two markers corresponding to the locations you want to interrelate to open the context menu.
As shown in the graphic above you can add relations in both directions, either starting or ending at the location selected. -
To create a bidirectional relationship between two locations you have to add both a relationship pointing from location A to B and a relationship pointing from B to A.
3. Create a Video
Locations and relationships are fine to add semantics to your data, but to use the IPED-Toolkit for immersive applications you need to add videos which can be displayed in the frontend according to the current location. If there are no video footages yet you can or like to use, you have to create them on your own.
-
First of all, open the "add new location"-window as described in section 1 and select the "Add" button from the group "Video footage".
-
As shown in the graphic you can enter a name, a date, a description and tags for the video.
-
The video itself is specified using the URL attribute, where you have to enter the path to the video files.
-
Due to browser compatibility purposes the videos have to be in either the MP4 or OGV format. It is very important to miss out the file extension when entering a videos URL, the system automatically looks for files of both formats using the filename given in the URL attribute.
For instance the URL "127.0.0.1/media/dummy" will cause the system to look for the files dummy.mp4 and dummy.ogv. -
Click on "Save" to save the video to the system's underlying database.
4. Create an Overlay
Overlaying videos with dynamic content is one of the key features of the IPED-Toolkit. It allows you to inject contents like images, videos or html-webpages.
-
To create a new overlay first open the "add new location"-window as described in section 1 and select the "Add" button from the group "Overlays".
-
The "Add Overlay"-window opens up, in which you can define the new overlay according to your needs. Similar to the "add new location"-window it allows you to enter a name, a description, tags and an URL where the content to be displayed is located.
-
In contrast to the "add new location"-window the window allows you to specify the size of the overlay. Moreover a preview is shown at the bottom in which you can move and transform the overlay in 3D space. The shortcuts Q, W, E and R can be used to change between the different transformation modes.
-
When applied all adjustments needed click on "Save" to save the overlay to the system's underlying database.