Changes

HowTo:Configure Dynamic AR Content

3,502 bytes added, 09:28, 20 May 2015
/* Example */
== '''Introduction''' ==The Dynamic AR Content feature allows the user to see different actions content according to the configurationsa marker configuration. <br>The actions configured configurable content are 3d 3D objects, movies and ubik {{UBIK}} objects. Currently the this feature is enabled for ID Marker Markers and Markerless scanning, meaning image tracking.<br>Therefore, every time the user has scanned an id ID marker or a picture , the corresponding object (3d 3D object, movie or ubik {{UBIK}} object) should will be processed and, <br>according to the configuration, a 3d object, a movie or a dialog should be shown onto displayed on the screen.
= Prerequisites =
In order to be able to use the feature properly, a certain folder structure is required and can be found at the following link {{FileLink|Dynamic_AR_Content_Folder_Structure.rar|Dynamic_AR_Content_Folder_Structure.rar}}. Since version 2.4.4, the schema changed slightly (downwards compatible). The updated example package can be found here: {{FileLink|Dynamic_AR_Content_Folder_Structure_244.zip|Dynamic_AR_Content_Folder_Structure_244.zip}}
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
== '''Setup''' ==In order for one to be able to use the feature properly a setup folder is required and can be found at [https://augmensys.system-hoster.com/Freigegebene%20Dokumente/01_Augmensys%20%C3%96sterreich/04_Development/Wiki/Dynamic_AR_Content_Folder_Structure.7z UBIK Folder Structure]. The setup folder contains:# A root folder, named ''UBIK''.# The ''UBIK'' root folder contains senseful configuration always consists of a child folder, named ''ARConfig''.# The ''ARConfig'' contains two child folders named ''IDMarker'' and ''Markerless''. <br>## ''IDMarker'' folder contains the resources and tracking configuration files needed for scanning an id marker. <br>## ''Markerless'' folder contains (in one of the resources and configuration files needed for scanning a pictureTrackingData.# ''IDMarker'' xml) and ''Markerless'' folder contain a corresponding ''res'action configuration' and a ''conf'' folder. In (in the ''res'' folder all the resources needed for metaio and ubik <br>to show 3d objects, video and ubik objects are locatedparallel ActionMapping. In the ''conf'' folder all the configuration files are storedxml).* ''Example''. In So when the following picture one can see a sketch of the folder structure.<br>:[[File:folder_structure.png]] <br>In order for a 3d object to be displayed properlypattern, configured in tracking, is recognized by the 3d objectcamera, the texture and the picture must all exist in the same placeconfigured action is triggered.
== Action Mapping XML Setup ==The following shows an exemplary sketch of the folder structure:
<source lang="xml">/UBIK/ARConfig/ IDMarker conf TrackingData_Marker.xml Action_Mapping.xml res .obj .png .jpg .mtl .3g2 .md2 Markerless conf TrackingData_Game.xml Action_Mapping.xml res .obj .png .jpg .mtl .3g2 .md2</source> = Tracking Setup =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 picture must also be provided. In the example it is '''../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 example below show the configuration of the location of the image:<source lang="xml"> <SensorCOS> <SensorCOSID>1</SensorCosID> <Parameters> <referenceImage widthMM="420" heightMM="297">../res/img_pic.png</referenceImage> </Parameters> </SensorCOS></source> {{Attention|The ID must be an integer number and it is not allowed to leave gaps, otherwise tracking wont work!}} = Action Setup = After the folder is configured and understood , the next step is to validate the schema against an online validator. A solution can be found at <br>[http://www.utilities-online.info/xsdvalidation/ Online XML Schema Validator]. The schema used to validate against can be found inside the example package provided in the prerequisites section (xml_schema_xsd).Since version 2.4.4, GeometryAction derives from UBIKObjectAction. When a geometry is clicked, it will try to find the respective UBIK Folder object and show a dialog for it is named ''xsd_schema_validation''.
The action mapping Xml contains different actions such as
* GeometryAction (3D Object)
* MovieAction
* UBIKObjectAction
to actually configure the action mapping xml and the tracking data xml. <br>The action mapping xml contains different actions such as GeometryAction, MovieAction and UBIKObjectAction.* In the xml below following Xml shows an example can be seen.<br>configuration:
<source lang="xml">
<TrackingActionMapping>
<GeometryAction TrackingID="1"> <!-- Since 2.4.4, you can use a UBIK-UID for linking an POI dialog to the geometry. --> <!-- Alternatively, you can configure (by customizing) an object with Marker Classification and its Marker ID set to the Tracking ID of this action. --> <UBIK-UID>a5aa5a70-591f-11e3-949a-0800200c9a66</UBIK-UID> <GeometryResource> <ResourcePath>pump.obj</ResourcePath> <Scale>100</Scale> </GeometryResource> </GeometryAction>
<UBIKObjectAction GeometryAction TrackingID="2"/><GeometryAction TrackingID="5"> <GeometryResource> <ResourcePath>pump.obj</ResourcePath> <Scale>100</Scale> <RotationDegrees>
<Z>90</Z>
</RotationDegrees> </GeometryResource> </GeometryAction>  <UBIKObjectAction TrackingID="3"> <!-- Alternatively, you can configure (by customizing) an object with Marker Classification and its Marker ID set to the Tracking ID of this action. --> <UBIK-UID>a5aa5a70-591f-11e3-949a-0800200c9a66</UBIK-UID> </UBIKObjectAction>
<UBIKObjectAction TrackingID="6">
<UBIK-UID>a5aa5a70-591f-11e3-949a-0800200c9a66</UBIK-UID>
</UBIKObjectAction>
</TrackingActionMapping>
</source>
<br>
All the actions Action tags must have as an specify a TrackingID attribute a tracking id. The Tracking id , where ID value must exist <br>in the corresponding tracking xml, the one that metaio needs in order to recognize id markers or pictures scannedXml within a ''<SensorCOSID>'' tag.
{{Attention|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.}}
=== Displaying 3D objects === 3D objects can be displayed using the ''<GeometryAction >'' tag. The sub-tag ''<GeometryResource>'' defines the content and the parameters for displaying the 3D object. ==== UBIK-UID Tag ==== Available since version 2.4.4:Just like the UBIKObjectAction, this action allows the usage of a optional UBIK-UID tag, specifying the ID of a UBIK object.If it is specified, the respective object is linked to this geometry; else, it is tried to find an object with a marker classification and the geometry action's tracking ID for it's marker id value.When the user clicks on the geometry, a dialog is opened for the linked object (if found).
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:
# '''Resource path'''. It is : the resource path of the 3d 3D object or video to be displayed.# '''Scale'''. If it exists: if specified, it is the scale of the current 3D objectwill be scaled to this size.# '''OffsetMillimeters'''. If it exists: if specified, it is this value will be added to the translation vector position of the current detected marker when displaying the 3D object. It has a The offset can be defined along the X, Y and Z value, but not all them are mandatoryaxis. # '''RotationDegrees'''. If it existsif specified, it is the rotation of the current 3D objectwill be rotated by this value against the detected marker. * ''Resource path example''. <source lang="xml">pump/pump.obj. <br/source
* ''OffsetMillimeters example''.
<source lang="xml">
</OffsetMillimeter>
</source>
<br>
=== 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 In the same values as following rotation example the GeometryResource taguser must see the 3D object rotated around X axis and around Z axis 90 degrees. It's purpose, if it exists, is to start a video, if Note that the geometry angle is touchedin radians.* ''RotationDegrees example''.<source lang=== UBIKObjectAction Tag ==="xml"> <Rotation> <X>0.5707</X> <Z>0.5705</Z> </Rotation></source>
The UBIKObjectAction tag should enable handling of the ubik objects when scanning either a picture or an id marker. <br>The tag must contain the tracking id attribute and, optional, the ubik-uid tag.=== Displaying movies ===
Inside the ''MovieAction'' tag there can be two possible resources defined, a '''MovieResource''' and a '''PlayButton''' resource. == Tracking Data XML == MovieResource Tag==== Movies can be displayed using the ''<MovieResource>'' tag, which basically contains the same values as the ''GeometryResource'', except the rotation vector.  ==== PlayButton Tag====By using the ''<PlayButton>'' tag, the movie will not start immediately but there will be a geometry shown in between which basically contains the same values as the ''GeometryResource'' tag. Its purpose is to start the video only when this intermediate geometry is touched.
First step that one has to do is to configure the tracking data xml in order for Metaio to recognize scanned pictures and ids. <br>
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). <br>
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. <br>
<source lang="xml">
<MovieAction> <SensorCOSMovieResource> ... <SensorCOSID/MovieResource>1 </SensorCosIDPlayButton> <ParametersScale>150</Scale> <referenceImage widthMM="420" heightMM="297"ResourcePath>plane/plane..obj</res/img_picResourcePath> <RotationDegrees> <Z>3.png14</referenceImageZ> </ParametersRotationDegrees> </SensorCOSPlayButton></MovieAction>
</source>
== = Displaying an UBIK object dialog === The ''<UBIKObjectAction>'Usage'allows to bring up a popup to navigate to an {{UBIK}} object when scanning either a picture or an ID marker. The tag must contain the tracking ID attribute and, optional, the '' <UBIK-UID>'' tag.When configuring a tag without the ''UBIK-UID'' sub-tag, the object is searched based on the value of its ''MarkerID'' property, which is compared to the value of the ''TrackingID'' attribute. If the ''UBIK-UID' tag exists the object is searched based on the value inside the ''UBIK-UID' tag. =Example =In order to use the previously configured xmlsxml's, one you can use either the ID Marker activity or the Markerless activityon the {{UBIK}} Android Client
=== ID Marker Activity ===
The ID markers used can be found at the following link {{FileLink|ID_Marker_Example_1_6.pdf|ID Marker Example Ids 1-6}}.<br>Having in mind the setup tracking idsIDs, one you can now scan id ID markers. * For an id ID that has a 3d 3D object mapped in the action xml one should see <br>a 3d , the object should be displayed onto on the screen as shown in the next picture. * If the id ID has a video object mapped in the action xml, one you should see a video object onto on the screen, depending on the existence of the play button. Clicking the play button starts the video.* If the play button exist one you should see first see the 3d objectplay button, and after it's clicked, a the mapped video. If the play button doesn't exist, the a movie preview image will be shown <br>immediately. Clicking the image starts the video.
=== Markerless Activity ===
The scenario is very similar with the id marker activity with the difference that instead of ids one must scan pictures.
The markerless photos used in this example can be found at the following link {{FileLink|Markerless_Examples._Pics_1-7.pdf|Markerless example pictures}}.<br>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 Results === 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|border]] <br>
With the existent configuration from the zip file one should see when When scanning the first id second ID or the first second picture , you should see the following picture::[[File:scanning_id1scanning_id2.png|border]] <br>
When scanning the second id or sixth ID, using the second picture one Markerless activity, you should see the followinga play button and, if pressed, a movie.* Play button::[[File:scanning_id3_play_button.png|border]] <br>* Movie::[[File:scanning_id2scanning_id3_movie.png|border]] <br>
When scanning the sixth id ID using the Markerless activity one IdMarker Activity you should see a play button also and, if pressed , a movietoo. <br>play * Play button::[[File:scanning_id3_play_buttonscanning_id6_play_button.png|border]] <br>* Movie::[[File:scanning_id3_moviescanning_id6_movie.png|border]] <br>
When scanning the sixth id using the IdMarker Activity one should see a play button also and, if pressed a movie too. <br>:[[FileCategory:scanning_id6_play_button.pngClient|Configure Dynamic AR Content]] <br>Movie::[[File:scanning_id6_movie.png]] <br>[[Category:How-To|Configure Dynamic AR Content]][[Category:UBIK ClientPOI|Configure Dynamic AR Content]]
10,686
edits