Documentation

How to build

• You can use clion to build

• Cmake on windows

cmake .  // this will generate project folder

• Cmake on Unix

cmake .
make

Haptic Player

• To simplify device management and feedback calls, this SDK connects to the bHaptics Player, which will manage the devices and send the Haptic signals to each device.
• This SDK uses a simple web socket to connect to the Player, and so this connection needs to be initialised when the game begins.
• You can check if the connection is initialised by navigating to the settings page on the Player and checking the "Number of Clients" value. If this increments when the game begins and decrements when it closes then the connection is working.
• A JSON structure of 'PlayerRequest' consisting of a RegisterRequest to register a Haptic File for later playback, or SubmitRequest to make an actual feedback call. You can find these structures in the model.h file.

Haptic Library

• Refer to the HapticLibrary files for the functions for Haptic Feedback.
• You can use the built DLL and LIB files to integrate the haptic feedback into the Engine, or re-implement the HapticLibrary files in your engine to access the functionality.

Example Integration

• This project is a part of our UE4 Plugin.
• You can refer to the HapticsManager/Private/HapticManagerComponent.cpp file and its associated header file for how to integrate the library into an engine.

JSON Examples

• Submit Path Point Example

• Register File Example

• Submit File Example