4. Install the Logger

Add the Metalitix Logger to your Android experience

1. Add the Metalitix Logger to your experience's build.gradle.

build.gradle

implementation 'com.metalitix.analytics:logger:0.17'

2. Run the Metalitix Logger in your experience by using the Metalitix SceneView component or create a component for your desired platform.

SceneView

Instantiate the MetalitixLogger by passing in your Android context and the apiKey from your project settings found in the Metalitix dashboard. Then, start the logger session by calling startSession() and passing in the ArSceneView and optionally your ArModelNode.

val apiKey = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx';
val logger = MetalitixSceneView.getLogger(context, apiKey)
logger.startSession(sceneView, myModelNode)

Custom

Instantiate the MetalitixLogger by passing in your Android context and the apiKey from your project settings found in the Metalitix dashboard. Then, start the logger session by calling startSession() and passing in interfaces that implement the OnCameraPoseUpdate and OnScenePoseUpdate interfaces. These interfaces are necessary for gathering camera and scene position information from your API framework.

class ArFragment : Fragment(R.layout.fragment_ar), OnCameraPoseUpdate, OnScenePoseUpdate {

    private lateinit var logger: MetalitixLogger
    private lateinit var modelNode: ArModelNode

    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        super.onViewCreated(view, savedInstanceState)

        // View bindings ...

        startSessionButton.setOnClickListener {
            val apiKey = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx';
            logger = Metalitix.getLogger(context, apiKey)
            logger.startSession(this, this)  // getCameraPose() then getScenePose()
        }
    }

    override fun getCameraPose(): CameraPose {
        val camera = sceneView.cameraNode
        val directionInRadians = camera.worldQuaternion
            .toEulerAngles()
            .toVector3D()
            .toRadiansVector()

        return CameraPose(
            position = camera.worldPosition.toVector3D(),
            direction = directionInRadians,
            fieldOfView = camera.verticalFovDegrees,
            aspectRatio = aspectRatio,
            zNearPlane = camera.nearClipPlane,
            zFarPlane = camera.farClipPlane,
            fps = sceneView.currentFrame?.fps?.toInt() ?: null,
            animation = getAnimations(),  // Optional
            eulerOrder = "ZYX"  // Optional
        )
    }

    override fun getScenePose(): ScenePose {
        val position = modelNode.worldPosition.toVector3D()
        val direction = modelNode.worldRotation.toVector3D()
        return ScenePose(position, direction)
    }
}

Metalitix will record camera movement relative to your scene object's transformations. So, it is not necessary to manually calibrate the scene in the Metalitix dashboard. If you do not pass a scene object, then recorded camera movement will be in world coordinates and manual calibration may be necessary.

3. Metalitix is now configured to gather analytics on your project! 🎉 To test, engage with your experience to create a session. Then, navigate to the Sessions tab within your project on the Metalitix dashboard. Within a few minutes, you will see your session appear at the top of the table. It will be marked as Active until the session ends. When a session no longer says Active, its data will appear on the Metrics tab. Heatmap data, on the other hand, is calculated in real-time for small projects and every 24 hours for large projects.