Configure Dynamic AR Content

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 for one to be able to use the feature properly a setup folder is required and can be found at UBIK Folder Structure. The setup folder contains:

1. A root folder, named UBIK.
2. The UBIK root folder contains a child folder, named ARConfig.
3. The ARConfig contains two child folders named IDMarker and Markerless.
   
   1. IDMarker folder contains the resources and configuration files needed for scanning an id marker.
      
   2. Markerless folder contains the resources and configuration files needed for scanning a picture.
4. IDMarker and Markerless folder contain a res and a conf folder. In the res folder all the resources needed for metaio and ubik
   

to show 3d objects, video and ubik objects are located. In the conf folder all the configuration files are stored.

• Example. In the following picture one can see a sketch of the folder structure.
  

In order for a 3d object to be displayed properly, the 3d object, the texture and the picture must all exist in the same place.

Action Mapping XML Setup

After the folder is configured and understood the next step is 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 it is named xsd_schema_validation.

to actually configure the action mapping xml and the tracking data xml.
The action mapping xml contains different actions such as GeometryAction, MovieAction and UBIKObjectAction.

• In the xml below an example can be seen.
  

<TrackingActionMapping>
<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 the actions tags must have as an attribute a tracking id. The Tracking id must exist
in the tracking xml, the one that metaio needs in order to recognize id markers or pictures scanned.

GeometryAction Tag

The GeometryAction xml tag for a GeometryAction must contain a tracking id attribute. 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:

1. Resource path. It is the resource path of the 3d object or video to be displayed.
2. Scale. If it exists, it is the scale of the current object.
3. OffsetMillimeters. If it exists, it is the translation vector of the current object. It has a X, Y and Z value, but not all them are mandatory.
4. RotationDegrees. If it exists, it is the rotation of the current object.

• Resource path example. pump/pump.obj.
  
• OffsetMillimeters example.

  <OffsetMillimeter>
    <X>10</X>
  </OffsetMillimeter>

MovieAction Tag

The MovieAction xml tag must also contain a trackingid attribute. Inside the MovieAction tag there are two possible resources, 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. It's purpose, if it exists, 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

First step that one has to do is to configure the tracking data xml in order for Metaio to recognize scanned pictures and ids.
In case one needs to scan pictures, the location of the pictures must be provided also. In our case 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.

• Example. Below you can see an example where you need to configure the location of the image.
  

  <SensorCOS>
    <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, one can use either the ID Marker activity or the Markerless activity.

ID Marker Activity

Having in mind the setup tracking ids, one can now scan id markers. For an id that has a 3d object mapped in the action xml one should see
a 3d object displayed onto the screen as in the next picture. If the id has a video object mapped in the action xml, one should see a video object onto the screen, depending on the existence of the play button. If the play button exist one should see first the 3d object, and after it's clicked, a 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 difference that instead of ids one must scan pictures.

Examples

With the existent configuration from the zip file one should see when scanning the first id or the first picture the following picture

When scanning the second id or the second picture one should see the following:

When scanning the sixth id using the Markerless activity one should see a play button and, if pressed a movie.
play button:

Movie:

When scanning the sixth id using the IdMarker Activity one should see a play button also and, if pressed a movie too.
Play button:

Movie: