Files
Plugin/Source/SenseGloveCoreKismet/Public/SGCoreKismet/SGFingerCommandKismetLibrary.h
T

83 lines
2.7 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
*
* A command for five fingers that can be sent to a Sense Glove device.
*/
#pragma once
#include "SGKismet/SGBlueprintFunctionLibrary.h"
#include "SGFingerCommandKismetLibrary.generated.h"
class USGFingerCommand;
/**
* A command that contains values (levels) for five fingers.
*/
UCLASS(meta=(ScriptName = "SesneGloveFingerCommandKismetLibrary"))
class SENSEGLOVECOREKISMET_API USGFingerCommandKismetLibrary : public USGBlueprintFunctionLibrary
{
GENERATED_BODY()
public:
/**
*
*/
UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Haptics | Finger Command")
static TArray<int32> GetLevels(const USGFingerCommand* FingerCommand);
/**
*
*/
UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Haptics | Finger Command")
static int32 GetLevel(const USGFingerCommand* FingerCommand, int32 Finger);
/**
*
*/
UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Haptics | Finger Command")
static void SetLevel(USGFingerCommand* FingerCommand, int32 Finger, int32 Value);
/**
* Check if this command contains the same values as another.
*/
UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Haptics | Finger Command")
static bool Equals(const USGFingerCommand* A, const USGFingerCommand* B);
/**
* Create a string representation of this finger command.
*/
UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Haptics | Finger Command")
static FString ToString(const USGFingerCommand* FingerCommand);
};