Mobile Legacy Setup (Android | iOS – up to 1.0.7)

Estimated reading: 5 minutes 1084 views

Interhaptics Mobile SDK (legacy) is a legacy integration tool for haptics on IOS and Android. It has been replaced from version 1.1.0 (03.2023) of the Interhaptics SDK by a new mobile pipeline which is aligned with the Core SDK and the documentation for this can be found in the new Interhaptics Mobile SDK page.

Android: To set up correctly the project, verify that Project Settings -> Player -> Other Settings -> Scripting Backend is set to IL2CPP and set the Target Architecture as ARM64 if it is not checked. Uncheck ARMv7 if it is active (strongly recommended). For Android, set the Minimum API Level 23 (Android 6.0 Marshmallow).

iOS: An iPhone 8 or newer is needed to have haptic capabilities. Unity for MacOS is strongly recommended to make the XCode builds.

It utilizes three main scripts: MobileHapticsStiffness, MobileHapticsTexture, and MobileHapticsVibration, which handle different haptic perceptions.
To set up correctly the project, verify that Project Settings -> Player -> Other Settings -> Scripting Backend is set to IL2CPP.

Before adding these scripts to a GameObject, create an empty GameObject for the HapticManager, which can be set to be persistent if desired.

All three scripts are inherited from the abstract class AMobileHapticsReader, and the implementation of each script is the same. To use them, follow these steps:

Add the script to a GameObject.
Add preloaded effects to the array on the Unity Inspector.
Call one of the public Play functions (PlayStiffness, PlayTexture, or PlayVibration) contained in the corresponding haptic perception handler (MobileHapticsStiffness, MobileHapticsTexture, or MobileHapticsVibration) and pass the index of the effect as a parameter.

MobileHapticsVibration

To use the MobileHapticsVibration script, add it to a GameObject and assign an effect that contains a vibration perception to its array of preloaded effects. The MobileHapticsVibration script contains one public method:

public void PlayVibration(int index): This method plays the vibration perception of the effect, the index of the effect is passed as a parameter.

To call the vibration when the button is clicked, call the function PlayVibration(0) if only one effect is set on the MobileHapticsVibration handler

MobileHapticsTexture

To use the MobileHapticsTexture script, add it to a GameObject and assign an effect that contains a texture perception to its array of preloaded effects. The MobileHapticsTexture script contains two public methods:

public void PlayTexture(int index, float distance): This method plays the texture perception of an effect based on its length, the index of the effect and the distance are passed as parameters.
public void PlayTexture01(int index, float distance01): This method plays the texture perception of an effect based on its normalized distance (between 0 and 1), the index of the effect and the normalized distance are passed as parameters.

To call the texture when the slider value changes, call the function PlayTexture01(0, sliderValue) in the case that the slider value is clamped between 0 and 1, that allows you to play the whole texture from its beginning (0) to its end (1). An example script, TextureSlider, is located in the package and it requires a Slider script. It takes two parameters:

The index of the effect to play.
The MobileHapticsTexture handler.

MobileHapticsStiffness

Please note that this feature is only available on IOS devices.

MobileHapticsStiffness contains one public method:

public void PlayStiffness(int index, float distance): This method plays the stiffness perception of an effect based on its length, the index of the effect and the distance are passed as parameters.

Note that the stiffness perception length is always clamped between 0 and 1. To call the stiffness when the user interacts with the slider, call the function PlayStiffness(0, sliderValue) on the update method, using the slider value clamped between 0 and 1.

An example script, StiffnessSlider, is located in the package and it requires a Slider script. It takes two parameters:

The index of the effect to play.
The MobileHapticsStiffness handler.

Notes

If you want to add effects at runtime, you have to create a class that inherits from AMobileHapticsReader and calls the protected function AddMaterial(TextAsset effect).
The loaded effects list is different from the preloaded effects array (that you can see on the Inspector). If you modified the effects loading process, the index can be different compared to the index of the preloaded effects array, otherwise, it remains the same.
You can use the public function GetIndexFromTextAsset(TextAsset effect, out int index) to retrieve the index of effect from your perception handler’s loaded effects List.
You can add each perception handler on the same GameObject.
You can’t add multiple handlers of the same perception on the same GameObject.
The sample scene located in the MobileHaptics package includes three points of interaction – a button that plays a vibration on click, a textured slider that plays a texture on drag, and a stiffness slider that plays stiffness on interaction.
Stiffness is only supported on IOS.

Mobile Legacy Setup (Android | iOS – up to 1.0.7)

MobileHapticsVibration

MobileHapticsTexture

MobileHapticsStiffness

Notes

Haptic Sources and Targets

Haptic Rendering and Provider Loop

Loading .haps Files

Interhaptics Engine and Providers Initialization

.haps Files

Key Concepts

Device Providers

Interhaptics Engine Libraries

Integration Process

Components

Overview

ClearEvent