Plugin/Source/SenseGloveCoreKismet/Public/SGCoreKismet/SGHapticGloveCommandBufferKismetLibrary.h

/**
 * @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 "SGKismet/SGBlueprintFunctionLibrary.h"

#include "SGHapticGloveCommandBufferKismetLibrary.generated.h"

class USGBuzzCommand;
class USGForceFeedbackCommand;
class USGHapticGlove;
class USGHapticGloveCommandBuffer;
class USGThumperCommand;
class USGTimedBuzzCommand;
class USGTimedThumpCommand;

UCLASS(meta=(ScriptName = "SesneGloveHapticGloveCommandBufferKismetLibrary"))
class SENSEGLOVECOREKISMET_API USGHapticGloveCommandBufferKismetLibrary final : public USGBlueprintFunctionLibrary
{
    GENERATED_BODY()

public:
    UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Haptics | Haptic Glove Command Buffer",
        meta=(WorldContext="WorldContextObject"))
    static USGHapticGloveCommandBuffer* MakeHapticGloveCommandBuffer(UObject* WorldContextObject);

    UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Haptics | Haptic Glove Command Buffer")
    static int32 GetMaxForceFeedbackCommands();

    UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Haptics | Haptic Glove Command Buffer")
    static int32 GetMaxBuzzCommands();

    UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Haptics | Haptic Glove Command Buffer")
    static int32 GetMaxThumpCommands();

    UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Haptics | Haptic Glove Command Buffer",
        meta=(WorldContext="WorldContextObject"))
    static TArray<USGForceFeedbackCommand*> GetForceFeedbackCommandsQueue(
        UObject* WorldContextObject,
        const USGHapticGloveCommandBuffer* HapticGloveCommandBuffer);

    UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Haptics | Haptic Glove Command Buffer",
        meta=(WorldContext="WorldContextObject"))
    static TArray<USGTimedBuzzCommand*> GetBuzzCommandsQueue(
        UObject* WorldContextObject,
        const USGHapticGloveCommandBuffer* HapticGloveCommandBuffer);

    UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Haptics | Haptic Glove Command Buffer",
        meta=(WorldContext="WorldContextObject"))
    static TArray<USGTimedThumpCommand*> GetThumperCommandsQueue(
        UObject* WorldContextObject,
        const USGHapticGloveCommandBuffer* HapticGloveCommandBuffer);

    UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Haptics | Haptic Glove Command Buffer")
    static void ClearForceFeedbackCommandsQueue(UPARAM(ref) USGHapticGloveCommandBuffer* HapticGloveCommandBuffer);

    UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Haptics | Haptic Glove Command Buffer")
    static void ClearVibrations(UPARAM(ref) USGHapticGloveCommandBuffer* HapticGloveCommandBuffer);

    UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Haptics | Haptic Glove Command Buffer")
    static void Clear(UPARAM(ref) USGHapticGloveCommandBuffer* HapticGloveCommandBuffer);

    UFUNCTION(BlueprintCallable, DisplayName="Add Command",
        Category="SenseGlove | Core | Haptics | Haptic Glove Command Buffer")
    static void AddCommand_ForceFeedbackCommand(UPARAM(ref) USGHapticGloveCommandBuffer* HapticGloveCommandBuffer,
                                                const USGForceFeedbackCommand* ForceFeedbackCommand);

    UFUNCTION(BlueprintCallable, DisplayName="Add Command",
        Category="SenseGlove | Core | Haptics | Haptic Glove Command Buffer")
    static void AddCommand_BuzzCommand(UPARAM(ref) USGHapticGloveCommandBuffer* HapticGloveCommandBuffer,
                                       const USGTimedBuzzCommand* BuzzCommand);

    UFUNCTION(BlueprintCallable, DisplayName="Add Command",
        Category="SenseGlove | Core | Haptics | Haptic Glove Command Buffer")
    static void AddCommand_ThumpCommand(UPARAM(ref) USGHapticGloveCommandBuffer* HapticGloveCommandBuffer,
                                        const USGTimedThumpCommand* ThumpCommand);

    UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Haptics | Haptic Glove Command Buffer")
    static void UpdateTimedCommands(UPARAM(ref) USGHapticGloveCommandBuffer* HapticGloveCommandBuffer,
                                    float DeltaSeconds);

    UFUNCTION(BlueprintPure, DisplayName="Get Total Force Feedback Levels",
        Category="SenseGlove | Core | Haptics | Haptic Glove Command Buffer", meta=(WorldContext="WorldContextObject"))
    static USGForceFeedbackCommand* GetTotalForceFeedbackLevels_LastForceFeedbackCommand(
        UObject* WorldContextObject,
        const USGHapticGloveCommandBuffer* HapticGloveCommandBuffer,
        const USGForceFeedbackCommand* LastForceFeedbackCommand);

    UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Haptics | Haptic Glove Command Buffer",
        meta=(WorldContext="WorldContextObject"))
    static USGForceFeedbackCommand* GetTotalForceFeedbackLevels(
        UObject* WorldContextObject,
        const USGHapticGloveCommandBuffer* HapticGloveCommandBuffer);

    UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Haptics | Haptic Glove Command Buffer",
        meta=(WorldContext="WorldContextObject"))
    static USGBuzzCommand* GetTotalBuzzLevels(UObject* WorldContextObject,
                                              const USGHapticGloveCommandBuffer* HapticGloveCommandBuffer);

    UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Haptics | Haptic Glove Command Buffer",
        meta=(WorldContext="WorldContextObject"))
    static USGThumperCommand* GetTotalThumperLevels(UObject* WorldContextObject,
                                                    const USGHapticGloveCommandBuffer* HapticGloveCommandBuffer);

    UFUNCTION(BlueprintCallable, DisplayName="Flush Haptics",
        Category="SenseGlove | Core | Haptics | Haptic Glove Command Buffer", meta=(WorldContext="WorldContextObject"))
    static void FlushHaptics_LBL_OutFFC_OutBC_OutTC_bCFFQ(
        UObject* WorldContextObject,
        UPARAM(ref) USGHapticGloveCommandBuffer* HapticGloveCommandBuffer,
        const USGForceFeedbackCommand* LastBrakeLevel,
        USGForceFeedbackCommand*& OutForceFeedbackCommand,
        USGBuzzCommand*& OutBuzzCommand,
        USGThumperCommand*& OutThumperCommand,
        bool bClearForceFeedbackQueue = true);

    UFUNCTION(BlueprintCallable, DisplayName="Flush Haptics",
        Category="SenseGlove | Core | Haptics | Haptic Glove Command Buffer", meta=(WorldContext="WorldContextObject"))
    static void FlushHaptics_DS_LBL_OutFFC_OutBuzzCommand_OutTC(
        UObject* WorldContextObject,
        UPARAM(ref) USGHapticGloveCommandBuffer* HapticGloveCommandBuffer,
        float DeltaSeconds,
        const USGForceFeedbackCommand* LastBrakeLevel,
        USGForceFeedbackCommand*& OutForceFeedbackCommand,
        USGBuzzCommand*& OutBuzzCommand,
        USGThumperCommand*& OutThumperCommand);
};