Difference between revisions of "HowTo:Configure Dynamic AR Content"
| Line 97: | Line 97: | ||
== Tracking Data XML == | == Tracking Data XML == | ||
| − | + | The first step is to configure the tracking data xml in order for {{UBIK}} to recognize scanned pictures and id's. | |
| − | In case | + | In case the marker is a picture (image), the location of the pictures must also be provided. In the example it's ../res/pic_name.(png, jpeg). |
The id located in the tracking data xml should be the same as the order of the id in the list of ids. | The id located in the tracking data xml should be the same as the order of the id in the list of ids. | ||
| − | * | + | |
| + | * This example below the configuration of the location of the image: | ||
<source lang="xml"> | <source lang="xml"> | ||
<SensorCOS> | <SensorCOS> | ||
| Line 111: | Line 112: | ||
== '''Usage''' == | == '''Usage''' == | ||
| − | In order to use the previously configured xmls, | + | In order to use the previously configured xmls, you can use either the ID Marker activity or the Markerless activity on the {{UBIK}} Android Client. |
| + | |||
=== ID Marker Activity === | === ID Marker Activity === | ||
| − | Having in mind the setup tracking ids, | + | Having in mind the setup tracking ids, you can now scan id markers. |
| − | + | * For an id that has a 3D object mapped in the action xml, the object should be displayed on the screen as shown in the next picture. | |
| − | If the id has a video object mapped in the action xml, | + | * If the id has a video object mapped in the action xml, you should see a video object on the screen, depending on the existence of the play button. |
| − | If the play button exist | + | * If the play button exist you should see first see the play button, and after it's clicked the mapped video. If the play button doesn't exist, the movie will be shown immediately. |
| − | immediately. | + | |
=== Markerless Activity === | === Markerless Activity === | ||
| − | The scenario is very similar with the id marker activity with the difference that instead of ids | + | |
| + | The scenario is very similar with the id marker activity with the only difference that instead of ids you have to scan your tracking images. | ||
=== Examples === | === Examples === | ||
| − | With the existent configuration from the zip file | + | With the existent configuration from the zip file, you should see the following picture when scanning the first id or the first picture: |
:[[File:scanning_id1.png]] <br> | :[[File:scanning_id1.png]] <br> | ||
| − | When scanning the second id or the second picture | + | When scanning the second id or the second picture, you should see the following: |
:[[File:scanning_id2.png]] <br> | :[[File:scanning_id2.png]] <br> | ||
| − | When scanning the sixth id using the Markerless activity | + | When scanning the sixth id, using the Markerless activity, you should see a play button and, if pressed, a movie. |
| − | + | * Play button: | |
:[[File:scanning_id3_play_button.png]] <br> | :[[File:scanning_id3_play_button.png]] <br> | ||
| − | Movie: | + | * Movie: |
:[[File:scanning_id3_movie.png]] <br> | :[[File:scanning_id3_movie.png]] <br> | ||
| − | When scanning the sixth id using the IdMarker Activity | + | When scanning the sixth id using the IdMarker Activity you should see a play button also and, if pressed, a movie too. |
| − | Play button: | + | * Play button: |
:[[File:scanning_id6_play_button.png]] <br> | :[[File:scanning_id6_play_button.png]] <br> | ||
| − | Movie: | + | * Movie: |
:[[File:scanning_id6_movie.png]] <br> | :[[File:scanning_id6_movie.png]] <br> | ||
| + | |||
[[Category:How-To]] | [[Category:How-To]] | ||
[[Category:UBIK Client]] | [[Category:UBIK Client]] | ||
Revision as of 09:01, 10 February 2014
Contents
Introduction
The Dynamic AR Content feature allows the user to see different content according to a marker configuration. The configurable content are 3D objects, movies and UBIK® objects. Currently this feature is enabled for ID Markers and Markerless scanning, meaning image tracking. Therefore, every time the user has scanned an ID marker or a picture, the corresponding object (3D object, movie or UBIK® object) will be processed and, according to the configuration, displayed on the screen.
Setup
In order to be able to use the feature properly, a setup folder is required and can be found at the following link Folder Structure. The setup folder contains:
- A root folder, named UBIK
- The UBIK root folder contains a child folder, named ARConfig
- The ARConfig contains two child folders named IDMarker and Markerless
- IDMarker folder contains the resources and configuration files needed for scanning an id marker
- Markerless folder contains the resources and configuration files needed for scanning a picture
- IDMarker and Markerless folder contain a res and a conf folder
- The res folder contains all the resources to be shown, like 3D objects, videos and links to UBIK® objects
- The conf folder contains all the configuration files
The following picture shows an exemplary sketch of the folder structure:
Action Mapping XML Setup
After the folder is configured, the next step is to validate the schema against an online validator. A solution can be found at Online XML Schema Validator. The schema used to validate against can be found inside the UBIK Folder and is named xsd_schema_validation.
The action mapping xml contains different actions such as GeometryAction, MovieAction and UBIKObjectAction.
- The following xml shows an example configuration:
<GeometryAction TrackingID="1">
<GeometryResource>
<ResourcePath>pump.obj</ResourcePath>
<Scale>100</Scale>
</GeometryResource>
</GeometryAction>
<UBIKObjectAction TrackingID="2"/>
<GeometryAction TrackingID="5">
<GeometryResource>
<ResourcePath>pump.obj</ResourcePath>
<Scale>100</Scale>
<RotationDegrees>
<Z>90</Z>
</RotationDegrees>
</GeometryResource>
</GeometryAction>
<UBIKObjectAction TrackingID="6">
<UBIK-UID>a5aa5a70-591f-11e3-949a-0800200c9a66</UBIK-UID>
</UBIKObjectAction>
</TrackingActionMapping>
All Action tags must specify a Tracking id, as an attribute. The Tracking id must exist in the tracking xml.
 | If a texture is used for a geometry, the material (*.mtl file) and the texture (picture) must all exist in the same place in order for to have the 3D object displayed properly, Only the geometry has to be specified as a resource in the Action Mapping, though. |
GeometryAction Tag
Inside the GeometryAction tag there can be a GeometryResource tag that defines the type of resource required for the GeometryAction.
GeometryResource Tag
The GeometryResource contains:
- Resource path: the resource path of the 3D object or video to be displayed.
- Scale: if specified, the 3D object will be scaled to this size.
- OffsetMillimeters: if specified, this value will be added to the position of the detected marker when displaying the 3D object. The offset can be defined along the X, Y and Z axis.
- RotationDegrees. if specified, the 3D object will be rotated by this value against the detected marker.
- Resource path example. pump/pump.obj.
- OffsetMillimeters example.
<X>10</X>
</OffsetMillimeter>
MovieAction Tag
Inside the MovieAction tag there can be two possible resources defined, a MovieResource and a PlayButton resource.
MovieResource
The MovieResource Tag contains the same values as the GeometryResource except the rotation vector.
PlayButton Tag
The PlayButton Tag, if it is defined, contains the same values as the GeometryResource tag. Its purpose is to start a video, if the geometry is touched.
UBIKObjectAction Tag
The UBIKObjectAction tag should enable handling of the UBIK® objects when scanning either a picture or an id marker. The tag must contain the tracking id attribute and, optional, the ubik-uid tag.
Tracking Data XML
The first step is to configure the tracking data xml in order for UBIK® to recognize scanned pictures and id's. In case the marker is a picture (image), the location of the pictures must also be provided. In the example it's ../res/pic_name.(png, jpeg). The id located in the tracking data xml should be the same as the order of the id in the list of ids.
- This example below the configuration of the location of the image:
<SensorCOSID>1</SensorCosID>
<Parameters>
<referenceImage widthMM="420" heightMM="297">../res/img_pic.png</referenceImage>
</Parameters>
</SensorCOS>
Usage
In order to use the previously configured xmls, you can use either the ID Marker activity or the Markerless activity on the UBIK® Android Client.
ID Marker Activity
Having in mind the setup tracking ids, you can now scan id markers.
- For an id that has a 3D object mapped in the action xml, the object should be displayed on the screen as shown in the next picture.
- If the id has a video object mapped in the action xml, you should see a video object on the screen, depending on the existence of the play button.
- If the play button exist you should see first see the play button, and after it's clicked the mapped video. If the play button doesn't exist, the movie will be shown immediately.
Markerless Activity
The scenario is very similar with the id marker activity with the only difference that instead of ids you have to scan your tracking images.
Examples
With the existent configuration from the zip file, you should see the following picture when scanning the first id or the first picture:
When scanning the second id or the second picture, you should see the following:
When scanning the sixth id, using the Markerless activity, you should see a play button and, if pressed, a movie.
- Play button:
- Movie:
When scanning the sixth id using the IdMarker Activity you should see a play button also and, if pressed, a movie too.
- Play button:
- Movie:
