AR and Marker Configuration
- Last UpdatedJan 20, 2025
- 2 minute read
The sampleAsset.AR section describes how to configure the markers for AR. Any image can be used as a reference image to be tracked in the real world scene.
Code example
The following code snippet shows how to configure markers for AR functionality.
<define name="sampleAsset.AR" type="config" >
<item name="numberOfMarkers" value="4" />
<item name="filePath" value="./data/sampleAsset/" />
<item name="assetLocationMesh" value="Box_sampleAsset_center" />
<item name="assetLayer3D" value="layer_sampleAsset" />
<struct name="marker_0">
<item name="markerFileName" value="AR_Front" />
<item name="markerLocationMesh" value="mesh_apm_sampleMarkers_dummy_marker_marker_front" />
<item name="markerImageWidthMeters" value="0.2"/>
</struct>
<struct name="marker_1">
<item name="markerFileName" value="AR_Back" />
<item name="markerLocationMesh" value="mesh_apm_sampleMarkers_dummy_marker_marker_back" />
<item name="markerImageWidthMeters" value="0.2"/>
</struct>
<struct name="marker_2">
<item name="markerFileName" value="AR_Left" />
<item name="markerLocationMesh" value="mesh_apm_sampleMarkers_dummy_marker_marker_left" />
<item name="markerImageWidthMeters" value="0.2"/>
</struct>
<struct name="marker_3">
<item name="markerFileName" value="AR_Right" />
<item name="markerLocationMesh" value="mesh_apm_sampleMarkers_dummy_marker_marker_right" />
<item name="markerImageWidthMeters" value="0.2"/>
</struct>
</define>
Parameters
A description of parameters.
|
Parameter |
Description |
|
numberOfMarkers |
Number of image markers that will be tracked in AR. |
|
filePath |
The folder path, from where the reference image will be fetched. |
|
assetLocationMesh |
The mesh that is used as a placeholder to denote the center of the asset. The virtual object will be placed at an offset from the center position. |
|
assetLayer3D |
The name of the layer that has all the objects that will be displayed when the marker image is found in AR. The position, orientation and the visibility will be handled by the module based on the visibility of the marker. |
|
marker0::markerFileName |
The name of the reference image that will be used as the marker. This name is without file extension. |
|
marker0::markerLocationMesh |
This is also a placeholder like assetLocationMesh to denote the offset from the center of the machine where marker image is located. |
|
marker0::markerImageWidthMeters |
Defines the actual marker dimension in meters, so you can align model dimensions to marker dimensions. |