CoreSdkWrapper.h

#ifndef H_CORESDKWRAPPER
#define H_CORESDKWRAPPER
 
// Set up a Doxygen group.
#ifdef __cplusplus
extern "C"
{
#endif
 
#include "CoreSdkWrapperTypes.h"
 
#include <stdint.h>
 
#ifdef _WIN32
    // CORESDKWRAPPER_EXPORTS defines if the functions are exported to or
    // imported from a DLL.
    #ifdef CORESDKWRAPPER_EXPORTS
        #define CORESDK_API __declspec(dllexport)
    #else
        #define CORESDK_API __declspec(dllimport)
    #endif
#elif defined(__linux__)
    #define CORESDK_API
#else
    #error Unrecognised platform.
#endif
 
/******************************************************************************
 * Wrapper startup and shutdown.
 *****************************************************************************/
 
CORESDK_API WrapperReturnCode_t CoreSdk_Initialise(ClientType a_TypeOfClient);
CORESDK_API WrapperReturnCode_t CoreSdk_ShutDown(void);
 
/******************************************************************************
 * Utility functions.
 *****************************************************************************/
 
CORESDK_API WrapperReturnCode_t CoreSdk_WasDllBuiltInDebugConfiguration(bool& a_WasBuiltInDebugConfiguration);
 
/******************************************************************************
 * Connection handling.
 *****************************************************************************/
 
CORESDK_API WrapperReturnCode_t CoreSdk_StartLookingForHosts(void);
CORESDK_API WrapperReturnCode_t CoreSdk_StopLookingForHosts(void);
CORESDK_API WrapperReturnCode_t CoreSdk_GetNumberOfAvailableHostsFound(uint32_t& a_NumberOfAvailableHostsFound);
CORESDK_API WrapperReturnCode_t CoreSdk_GetAvailableHostsFound(ManusHost* a_AvailableHostsFound, const uint32_t a_NumberOfHostsThatFitInArray);
CORESDK_API WrapperReturnCode_t CoreSdk_GetIsConnectedToCore(bool& a_ConnectedToCore);
 
CORESDK_API WrapperReturnCode_t CoreSdk_ConnectLocally(void);
CORESDK_API WrapperReturnCode_t CoreSdk_ConnectToHost(ManusHost a_Host);
 
CORESDK_API WrapperReturnCode_t CoreSdk_WasConnectionLostDueToTimeout(bool& a_WasConnectionLost);
CORESDK_API WrapperReturnCode_t CoreSdk_GetVersionsAndCheckCompatibility(ManusVersion& a_WrapperVersion, ManusVersion& a_SdkVersion, ManusVersion& a_CoreVersion, bool& a_AreVersionsCompatible);
 
// Callbacks
CORESDK_API WrapperReturnCode_t CoreSdk_RegisterCallbackForOnConnect(ConnectedToCoreCallback_t a_ConnectedCallback);
CORESDK_API WrapperReturnCode_t CoreSdk_RegisterCallbackForOnDisconnect(DisconnectedFromCoreCallback_t a_DisconnectedCallback);
 
/******************************************************************************
 * Basic glove interaction.
 *****************************************************************************/
 
CORESDK_API WrapperReturnCode_t CoreSdk_VibrateWristOfGlove(uint32_t a_GloveId, float a_UnitStrength, uint16_t a_DurationInMilliseconds);
CORESDK_API WrapperReturnCode_t CoreSdk_VibrateFingers(uint32_t a_DongleId, HandType a_HandType, const float* a_Powers);
 
CORESDK_API WrapperReturnCode_t CoreSdk_GetGloveIdOfUser_UsingUserIndex(uint32_t a_UserIndex, HandType a_HandType, uint32_t& a_GloveId);
CORESDK_API WrapperReturnCode_t CoreSdk_GetNumberOfAvailableGloves(uint32_t& a_NumberOfAvailableGloves);
CORESDK_API WrapperReturnCode_t CoreSdk_GetIdsOfAvailableGloves(uint32_t* a_IdsOfAvailableGloves, uint32_t a_NumberOfIdsThatFitInArray);
CORESDK_API WrapperReturnCode_t CoreSdk_GetHandTypeOfGlove(uint32_t a_GloveId, HandType& a_HandType);
CORESDK_API WrapperReturnCode_t CoreSdk_GetIdOfFirstAvailableGloveOfType(HandType a_HandType, uint32_t& a_GloveId);
 
CORESDK_API WrapperReturnCode_t CoreSdk_GetDataForGlove_UsingGloveId(uint32_t a_GloveId, GloveData& a_GloveData);
CORESDK_API WrapperReturnCode_t CoreSdk_GetDataForGlove_UsingHandType(HandType a_HandType, GloveData& a_GloveData);
 
/******************************************************************************
 * Haptics module.
 *****************************************************************************/
 
CORESDK_API WrapperReturnCode_t CoreSdk_GetNumberOfHapticsDongles(uint32_t& a_NumberOfHapticsDongles);
CORESDK_API WrapperReturnCode_t CoreSdk_GetHapticsDongleIds(uint32_t* a_HapticsDongleIds, uint32_t a_NumberOfIdsThatFitInArray);
 
/******************************************************************************
 * Polygon.
 *****************************************************************************/
 
CORESDK_API WrapperReturnCode_t CoreSdk_GetNumberOfAvailablePolygonUsers(uint32_t& a_NumberOfAvailableUsers);
CORESDK_API WrapperReturnCode_t CoreSdk_GetIdsOfAvailablePolygonUsers(int32_t* a_IdsOfAvailablePolygonUsers, uint32_t a_NumberOfIdsThatFitInArray);
 
CORESDK_API WrapperReturnCode_t CoreSdk_AddOrUpdatePolygonSkeleton(const PolygonSkeletonData& a_PolygonSkeletonData);
CORESDK_API WrapperReturnCode_t CoreSdk_RemovePolygonSkeleton(const RemoveSkeletonArgs& a_RemoveSkeletonArgs);
CORESDK_API WrapperReturnCode_t CoreSdk_SetPolygonSkeletonTarget(const PolygonTargetArgs& a_SetSkeletonTargetArgs);
CORESDK_API WrapperReturnCode_t CoreSdk_SetPolygonSkeletonRetargetingSettings(const RetargetingSettingsArgs& a_RetargetingSettingsArgs);
CORESDK_API WrapperReturnCode_t CoreSdk_IsPolygonSkeletonIdValid(uint32_t a_PolygonSkeletonId, bool& a_IsValid);
CORESDK_API WrapperReturnCode_t CoreSdk_GetNumberOfAvailablePolygonSkeletons(uint32_t& a_NumberOfAvailablePolygonSkeletons);
CORESDK_API WrapperReturnCode_t CoreSdk_GetIdsOfAvailablePolygonSkeletons(uint32_t* a_IdsOfAvailablePolygonSkeletons, uint32_t a_NumberOfIdsThatFitInArray);
CORESDK_API WrapperReturnCode_t CoreSdk_GetIdOfFirstAvailablePolygonSkeleton(uint32_t& a_PolygonSkeletonId);
CORESDK_API WrapperReturnCode_t CoreSdk_GetDataForPolygonSkeleton(uint32_t a_PolygonSkeletonId, PolygonSkeletonData& a_PolygonSkeletonData);
 
/******************************************************************************
 * Users.
 *****************************************************************************/
CORESDK_API WrapperReturnCode_t CoreSdk_GetNumberOfUsers(uint32_t& a_NumberOfUsers);
 
/******************************************************************************
 * Tracking.
 *****************************************************************************/
 
CORESDK_API WrapperReturnCode_t CoreSdk_GetNumberOfAvailableTrackers(uint32_t& a_NumberOfAvailableTrackers);
CORESDK_API WrapperReturnCode_t CoreSdk_GetIdsOfAvailableTrackers(TrackerId* a_IdsOfAvailableTrackers, uint32_t a_NumberOfIdsThatFitInArray);
 
CORESDK_API WrapperReturnCode_t CoreSdk_GetNumberOfAvailableTrackersForUserIndex(uint32_t& a_NumberOfAvailableTrackers, uint32_t a_UserIndex);
 
CORESDK_API WrapperReturnCode_t CoreSdk_GetIdsOfAvailableTrackersForUserIndex(TrackerId* a_IdsOfAvailableTrackers, uint32_t a_UserIndex, uint32_t a_NumberOfIdsThatFitInArray);
 
CORESDK_API WrapperReturnCode_t CoreSdk_GetDataForTracker_UsingTrackerId(TrackerId a_TrackerId, TrackerData& a_TrackerData);
CORESDK_API WrapperReturnCode_t CoreSdk_GetDataForTracker_UsingIndexAndType(uint32_t a_UserIndex, uint32_t a_TrackerType, TrackerData& a_TrackerData);
CORESDK_API WrapperReturnCode_t CoreSdk_SendDataForTrackers(const TrackerData* a_TrackerData, uint32_t a_NumberOfTrackers);
 
#ifdef __cplusplus
} // extern "C"
#endif
 
// Close the Doxygen group.
#endif // #ifndef H_CORESDKWRAPPER