84 lines
3.1 KiB
C++
84 lines
3.1 KiB
C++
/**
|
|
* @file
|
|
*
|
|
* @author Mamadou Babaei <mamadou@senseglove.com>
|
|
*
|
|
* @section LICENSE
|
|
*
|
|
* (The MIT License)
|
|
*
|
|
* Copyright (c) 2020 - 2022 SenseGlove
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in all
|
|
* copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
* SOFTWARE.
|
|
*
|
|
* @section DESCRIPTION
|
|
*
|
|
*
|
|
*/
|
|
|
|
|
|
#pragma once
|
|
|
|
#include "Containers/Array.h"
|
|
#include "HAL/Platform.h"
|
|
|
|
#include "SGKismet/SGBlueprintFunctionLibrary.h"
|
|
|
|
#include "SGConnectKismetLibrary.generated.h"
|
|
|
|
UCLASS(meta=(ScriptName = "SesneGloveConnectKismetLibrary"))
|
|
class SENSEGLOVECONNECTKISMET_API USGConnectKismetLibrary final : public USGBlueprintFunctionLibrary
|
|
{
|
|
GENERATED_BODY()
|
|
|
|
public:
|
|
public:
|
|
/**
|
|
* Begin Scanning for Sense Glove Devices and set up communications with them.
|
|
*
|
|
* @return
|
|
* -3 : An Unexpected error occured. Please try again.
|
|
* -2 : Device Scanning is already running within a different program.
|
|
* -1 : Device Scanning already being initialized (function called twice in short succession).
|
|
* 0 : Device Scanning is already running in within this program.
|
|
* 1 : Successfully started up DeviceScanning from the current program.
|
|
*/
|
|
UFUNCTION(BlueprintCallable, Category="SenseGlove | Connect")
|
|
static int32 Init();
|
|
|
|
/**
|
|
* Dispose of unmanaged resources and finalize Sense Glove devices.
|
|
*
|
|
* @return
|
|
* -3 : An Unexpected error occured. Please try again.
|
|
* -2 : Not allowed to dispose of Device Scanning because this is not the program which started it.
|
|
* -1 : Device Scanning is currently being disposed off. This takes a second or two. (function called twice in short succession).
|
|
* 0 : There is no deviceScanner running from any program, so disposing is skipped.
|
|
* 1 : Successfully disposed of DeviceScanner resources.
|
|
* @remark If the Dispose function returns 1, the resources were neatly disposed of. Only a value of -3 is cause for concern.
|
|
*/
|
|
UFUNCTION(BlueprintCallable, Category="SenseGlove | Connect")
|
|
static int32 Dispose();
|
|
|
|
/**
|
|
* Check which version of SGConnect you are using.
|
|
*/
|
|
UFUNCTION(BlueprintCallable, Category="SenseGlove | Connect")
|
|
static FString GetLibraryVersion();
|
|
}; |