Plugin/Source/SenseGloveKismet/Public/SGKismet/SGWristTrackerComponentKismetLibrary.h

/**
 * @file
 *
 * @author  Mamadou Babaei <mamadou@senseglove.com>
 *
 * @section LICENSE
 *
 * (The MIT License)
 *
 * Copyright (c) 2020 - 2023 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 data class containing the minimum required data for a hand's forward
 * kinematics.
 * Used in both kinematics and calibration.
 */


#pragma once

#include "SGKismet/SGBlueprintFunctionLibrary.h"
#include "SGTypes/SGCoreTypes.h"

#include "SGWristTrackerComponentKismetLibrary.generated.h"

class USkeletalMeshComponent;

class USGWristTrackerComponent;
class USGHandPose;

UCLASS(meta=(ScriptName = "SesneGloveWristTrackerComponentKismetLibrary"))
class SENSEGLOVEKISMET_API UWristTrackerComponentKismetLibrary final : public USGBlueprintFunctionLibrary
{
    GENERATED_BODY()

public:
    UFUNCTION(BlueprintPure, Category="SenseGlove | Components | Wrist Tracker Component")
    static bool OverridesPluginWristTrackingSettings(const USGWristTrackerComponent* WristTrackerComponent);

    UFUNCTION(BlueprintCallable, Category="SenseGlove | Components | Wrist Tracker Component")
    static void OverridePluginWristTrackingSettings(UPARAM(ref) USGWristTrackerComponent* WristTrackerComponent,
                                                    bool bInOverridePluginWristTrackingSettings);

    UFUNCTION(BlueprintPure, Category="SenseGlove | Components | Wrist Tracker Component")
    static ESGPositionalTrackingHardware GetHardwareOffset(const USGWristTrackerComponent* WristTrackerComponent);

    UFUNCTION(BlueprintCallable, Category="SenseGlove | Components | Wrist Tracker Component")
    static void SetHardwareOffset(UPARAM(ref) USGWristTrackerComponent* WristTrackerComponent,
                                  ESGPositionalTrackingHardware InHardwareOffset);

    UFUNCTION(BlueprintPure, Category="SenseGlove | Components | Wrist Tracker Component")
    static const FVector& GetHardwareLocationOffset(const USGWristTrackerComponent* WristTrackerComponent);

    UFUNCTION(BlueprintCallable, Category="SenseGlove | Components | Wrist Tracker Component")
    static void SetHardwareLocationOffset(UPARAM(ref) USGWristTrackerComponent* WristTrackerComponent,
                                          const FVector& InHardwareLocationOffset);

    UFUNCTION(BlueprintPure, Category="SenseGlove | Components | Wrist Tracker Component")
    static const FRotator& GetHardwareRotationOffset(const USGWristTrackerComponent* WristTrackerComponent);

    UFUNCTION(BlueprintCallable, Category="SenseGlove | Components | Wrist Tracker Component")
    static void SetHardwareRotationOffset(UPARAM(ref) USGWristTrackerComponent* WristTrackerComponent,
                                          const FRotator& InHardwareRotationOffset);

    UFUNCTION(BlueprintPure, Category="SenseGlove | Components | Wrist Tracker Component")
    static bool OverridesPluginWristTrackingDebugSettings(const USGWristTrackerComponent* WristTrackerComponent);

    UFUNCTION(BlueprintCallable, Category="SenseGlove | Components | Wrist Tracker Component")
    static void OverridePluginWristTrackingDebugSettings(UPARAM(ref) USGWristTrackerComponent* WristTrackerComponent,
                                                         bool bInOverridePluginWristTrackingDebugSettings);

    UFUNCTION(BlueprintPure, Category="SenseGlove | Components | Wrist Tracker Component")
    static bool GetDrawDebugWristTrackerGizmo(const USGWristTrackerComponent* WristTrackerComponent);

    UFUNCTION(BlueprintCallable, Category="SenseGlove | Components | Wrist Tracker Component")
    static void SetDrawDebugWristTrackerGizmo(UPARAM(ref) USGWristTrackerComponent* WristTrackerComponent,
                                              bool bInDrawDebugWristTrackerGizmo);

    UFUNCTION(BlueprintPure, Category="SenseGlove | Components | Wrist Tracker Component")
    static float GetDebugWristTrackerGizmoLength(const USGWristTrackerComponent* WristTrackerComponent);

    UFUNCTION(BlueprintCallable, Category="SenseGlove | Components | Wrist Tracker Component")
    static void SetDebugWristTrackerGizmoLength(UPARAM(ref) USGWristTrackerComponent* WristTrackerComponent,
                                                float InDebugWristTrackerGizmoLength);

    UFUNCTION(BlueprintPure, Category="SenseGlove | Components | Wrist Tracker Component")
    static const FLinearColor& GetDebugWristTrackerGizmoXAxisColor(
        const USGWristTrackerComponent* WristTrackerComponent);

    UFUNCTION(BlueprintCallable, Category="SenseGlove | Components | Wrist Tracker Component")
    static void SetDebugWristTrackerGizmoXAxisColor(UPARAM(ref) USGWristTrackerComponent* WristTrackerComponent,
                                                    const FLinearColor& InDebugWristTrackerGizmoXAxisColor);

    UFUNCTION(BlueprintPure, Category="SenseGlove | Components | Wrist Tracker Component")
    static const FLinearColor& GetDebugWristTrackerGizmoYAxisColor(
        const USGWristTrackerComponent* WristTrackerComponent);

    UFUNCTION(BlueprintCallable, Category="SenseGlove | Components | Wrist Tracker Component")
    static void SetDebugWristTrackerGizmoYAxisColor(UPARAM(ref) USGWristTrackerComponent* WristTrackerComponent,
                                                    const FLinearColor& InDebugWristTrackerGizmoYAxisColor);

    UFUNCTION(BlueprintPure, Category="SenseGlove | Components | Wrist Tracker Component")
    static const FLinearColor& GetDebugWristTrackerGizmoZAxisColor(
        const USGWristTrackerComponent* WristTrackerComponent);

    UFUNCTION(BlueprintCallable, Category="SenseGlove | Components | Wrist Tracker Component")
    static void SetDebugWristTrackerGizmoZAxisColor(UPARAM(ref) USGWristTrackerComponent* WristTrackerComponent,
                                                    const FLinearColor& InDebugWristTrackerGizmoZAxisColor);

    UFUNCTION(BlueprintPure, Category="SenseGlove | Components | Wrist Tracker Component")
    static bool GetDebugWristTrackerGizmoPersistentLines(const USGWristTrackerComponent* WristTrackerComponent);

    UFUNCTION(BlueprintCallable, Category="SenseGlove | Components | Wrist Tracker Component")
    static void SetDebugWristTrackerGizmoPersistentLines(UPARAM(ref) USGWristTrackerComponent* WristTrackerComponent,
                                                         bool bInDebugWristTrackerGizmoPersistentLines);

    UFUNCTION(BlueprintPure, Category="SenseGlove | Components | Wrist Tracker Component")
    static float GetDebugWristTrackerGizmoLifeTimeModifier(const USGWristTrackerComponent* WristTrackerComponent);

    UFUNCTION(BlueprintCallable, Category="SenseGlove | Components | Wrist Tracker Component")
    static void SetDebugWristTrackerGizmoLifeTimeModifier(UPARAM(ref) USGWristTrackerComponent* WristTrackerComponent,
                                                          float InDebugWristTrackerGizmoLifeTimeModifier);

    UFUNCTION(BlueprintPure, Category="SenseGlove | Components | Wrist Tracker Component")
    static uint8 GetDebugWristTrackerGizmoDepthPriority(const USGWristTrackerComponent* WristTrackerComponent);

    UFUNCTION(BlueprintCallable, Category="SenseGlove | Components | Wrist Tracker Component")
    static void SetDebugWristTrackerGizmoDepthPriority(UPARAM(ref) USGWristTrackerComponent* WristTrackerComponent,
                                                       uint8 InDebugWristTrackerGizmoDepthPriority);

    UFUNCTION(BlueprintPure, Category="SenseGlove | Components | Wrist Tracker Component")
    static float GetDebugWristTrackerGizmoThickness(const USGWristTrackerComponent* WristTrackerComponent);

    UFUNCTION(BlueprintCallable, Category="SenseGlove | Components | Wrist Tracker Component")
    static void SetDebugWristTrackerGizmoThickness(UPARAM(ref) USGWristTrackerComponent* WristTrackerComponent,
                                                   float InDebugWristTrackerGizmoThickness);

    UFUNCTION(BlueprintPure, Category="SenseGlove | Components | Wrist Tracker Component")
    static bool IsLeft(const USGWristTrackerComponent* WristTrackerComponent);

    UFUNCTION(BlueprintPure, Category="SenseGlove | Components | Wrist Tracker Component")
    static bool IsRight(const USGWristTrackerComponent* WristTrackerComponent);

    UFUNCTION(BlueprintCallable, Category="SenseGlove | Components | Wrist Tracker Component")
    static void SetRight(UPARAM(ref) USGWristTrackerComponent* WristTrackerComponent, bool bInRight);
};