SGBasicDemo/Plugins/SenseGlove/Source/SenseGloveKismet/Public/SGKismet/SGTouchComponentKismetLibrary.h

/**
 * @file
 *
 * @author  Mamadou Babaei <mamadou@senseglove.com>
 *
 * @section LICENSE
 *
 * (The MIT License)
 *
 * Copyright (c) 2020 - 2025 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 "SGTouchComponentKismetLibrary.generated.h"

class AActor;
class USGTouchComponent;

UCLASS(meta=(ScriptName = "SenseGloveTouchComponentKismetLibrary"))
class SENSEGLOVEKISMET_API UTouchComponentKismetLibrary final : public USGBlueprintFunctionLibrary
{
    GENERATED_BODY()

public:
    UFUNCTION(BlueprintCallable, Category="SenseGlove | Components | Touch Component")
    static USGTouchComponent* GetTouchComponent(const AActor* Actor);

    UFUNCTION(BlueprintCallable, Category="SenseGlove | Components | Touch Component")
    static bool IsTouchable(const AActor* Actor);

    UFUNCTION(BlueprintPure, Category="SenseGlove | Components | Touch Component")
    static int32 GetForceFeedbackLevel(const USGTouchComponent* TouchComponent);

    UFUNCTION(BlueprintCallable, Category="SenseGlove | Components | Touch Component")
    static void SetForceFeedbackLevel(UPARAM(ref) USGTouchComponent* TouchComponent, float Level);

    UFUNCTION(BlueprintPure, Category="SenseGlove | Components | Touch Component")
    static float GetVibrotactileAmplitude(const USGTouchComponent* TouchComponent);

    UFUNCTION(BlueprintCallable, Category="SenseGlove | Components | Touch Component")
    static void SetVibrotactileAmplitude(UPARAM(ref) USGTouchComponent* TouchComponent, float Amplitude);

    UFUNCTION(BlueprintPure, Category="SenseGlove | Components | Touch Component")
    static float GetVibrotactileDuration(const USGTouchComponent* TouchComponent);

    UFUNCTION(BlueprintCallable, Category="SenseGlove | Components | Touch Component")
    static void SetVibrotactileDuration(UPARAM(ref) USGTouchComponent* TouchComponent, float Duration);

    UFUNCTION(BlueprintPure, Category="SenseGlove | Components | Touch Component")
    static float GetVibrotactileFrequency(const USGTouchComponent* TouchComponent);

    UFUNCTION(BlueprintCallable, Category="SenseGlove | Components | Touch Component")
    static void SetVibrotactileFrequency(UPARAM(ref) USGTouchComponent* TouchComponent, float Frequency);
};