Plugin/Source/SenseGloveSettings/Public/SGSettings/SGSettings.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
 *
 *
 */


#pragma once

#include "Math/Color.h"
#include "Math/Rotator.h"
#include "Math/Vector.h"
#include "Subsystems/EngineSubsystem.h"
#include "Templates/UniquePtr.h"
#include "UObject/ObjectMacros.h"

#include "SGTypes/SGCoreTypes.h"

#include "SGSettings.generated.h"

UCLASS(config = SenseGloveSettings)
class SENSEGLOVESETTINGS_API USGSettings : public UEngineSubsystem
{
    GENERATED_BODY()

public:
    static USGSettings* GetInstance();

private:
    struct FImpl;

    struct FImplDeleter
    {
        void operator()(const FImpl* P) const;
    };

    TUniquePtr<FImpl, FImplDeleter> Pimpl;
    FImplDeleter PimplDeleter;

private:
    /**
     * If set to Custom, any desired location and rotation can be specified.
     */
    UPROPERTY(Config, EditDefaultsOnly, Category = "Wrist Tracking")
    ESGPositionalTrackingHardware HardwareOffset;

    /**
     * Valid only if HardwareOffset is set to Custom.
     */
    UPROPERTY(Config, EditDefaultsOnly, Category = "Wrist Tracking",
        meta=(EditCondition="HardwareOffset == ESGPositionalTrackingHardware::Custom", EditConditionHides))
    FVector HardwareLocationOffsetLeftHand;

    /**
     * Valid only if HardwareOffset is set to Custom.
     */
    UPROPERTY(Config, EditDefaultsOnly, Category = "Wrist Tracking",
        meta=(EditCondition="HardwareOffset == ESGPositionalTrackingHardware::Custom", EditConditionHides))
    FVector HardwareLocationOffsetRightHand;

    /**
     * Valid only if HardwareOffset is set to Custom.
     */
    UPROPERTY(Config, EditDefaultsOnly, Category = "Wrist Tracking",
        meta=(EditCondition="HardwareOffset == ESGPositionalTrackingHardware::Custom", EditConditionHides))
    FRotator HardwareRotationOffsetLeftHand;

    /**
     * Valid only if HardwareOffset is set to Custom.
     */
    UPROPERTY(Config, EditDefaultsOnly, Category = "Wrist Tracking",
        meta=(editcondition="hardwareoffset == esgpositionaltrackinghardware::custom", editconditionhides))
    FRotator HardwareRotationOffsetRightHand;

    /**
     * If enabled, draws debug Wrist trackers where possible.
     */
    UPROPERTY(Config, EditDefaultsOnly, Category = "Wrist Tracking Debug")
    uint8 bDrawDebugWristTrackerGizmo : 1;

    /**
     * Valid only if bDrawDebugWristTrackerGizmo is enabled.
     */
    UPROPERTY(Config, EditDefaultsOnly, Category = "Wrist Tracking Debug",
        meta=(editcondition="bDrawDebugWristTrackerGizmo", editconditionhides))
    float DebugWristTrackerGizmoLength;

    /**
     * Valid only if bDrawDebugWristTrackerGizmo is enabled.
     */
    UPROPERTY(Config, EditDefaultsOnly, Category = "Wrist Tracking Debug",
        meta=(editcondition="bDrawDebugWristTrackerGizmo", editconditionhides))
    FLinearColor DebugWristTrackerGizmoXAxisColor;

    /**
     * Valid only if bDrawDebugWristTrackerGizmo is enabled.
     */
    UPROPERTY(Config, EditDefaultsOnly, Category = "Wrist Tracking Debug",
        meta=(editcondition="bDrawDebugWristTrackerGizmo", editconditionhides))
    FLinearColor DebugWristTrackerGizmoYAxisColor;

    /**
     * Valid only if bDrawDebugWristTrackerGizmo is enabled.
     */
    UPROPERTY(Config, EditDefaultsOnly, Category = "Wrist Tracking Debug",
        meta=(editcondition="bDrawDebugWristTrackerGizmo", editconditionhides))
    FLinearColor DebugWristTrackerGizmoZAxisColor;

    /**
     * Valid only if bDrawDebugWristTrackerGizmo is enabled.
     */
    UPROPERTY(Config, EditDefaultsOnly, Category = "Wrist Tracking Debug",
        meta=(editcondition="bDrawDebugWristTrackerGizmo", editconditionhides))
    uint8 bDebugWristTrackerGizmoPersistentLines : 1;

    /**
     * Valid only if bDrawDebugWristTrackerGizmo is enabled.
     */
    UPROPERTY(Config, EditDefaultsOnly, Category = "Wrist Tracking Debug",
        meta=(editcondition="bDrawDebugWristTrackerGizmo", editconditionhides))
    float DebugWristTrackerGizmoLifeTimeModifier;

    /**
     * Valid only if bDrawDebugWristTrackerGizmo is enabled.
     */
    UPROPERTY(Config, EditDefaultsOnly, Category = "Wrist Tracking Debug",
        meta=(editcondition="bDrawDebugWristTrackerGizmo", editconditionhides))
    uint8 DebugWristTrackerGizmoDepthPriority;

    /**
     * Valid only if bDrawDebugWristTrackerGizmo is enabled.
     */
    UPROPERTY(Config, EditDefaultsOnly, Category = "Wrist Tracking Debug",
        meta=(editcondition="bDrawDebugWristTrackerGizmo", editconditionhides))
    float DebugWristTrackerGizmoThickness;

public:
    USGSettings();

public:
    FORCEINLINE ESGPositionalTrackingHardware GetHardwareOffset() const
    {
        return HardwareOffset;
    }

    FORCEINLINE void SetHardwareOffset(const ESGPositionalTrackingHardware InHardwareOffset)
    {
        HardwareOffset = InHardwareOffset;
    }

    const FVector& GetHardwareLocationOffsetLeftHand() const;
    void SetHardwareLocationOffsetLeftHand(const FVector& InHardwareLocationOffsetLeftHand);

    const FVector& GetHardwareLocationOffsetRightHand() const;
    void SetHardwareLocationOffsetRightHand(const FVector& InHardwareLocationOffsetRightHand);

    const FRotator& GetHardwareRotationOffsetLeftHand() const;
    void SetHardwareRotationOffsetLeftHand(const FRotator& InHardwareRotationOffsetLeftHand);

    const FRotator& GetHardwareRotationOffsetRightHand() const;
    void SetHardwareRotationOffsetRightHand(const FRotator& InHardwareRotationOffsetRightHand);

    FORCEINLINE bool GetDrawDebugWristTrackerGizmo() const
    {
        return !!bDrawDebugWristTrackerGizmo;
    }

    void SetDrawDebugWristTrackerGizmo(const bool bInDrawDebugWristTrackerGizmo)
    {
        bDrawDebugWristTrackerGizmo = bInDrawDebugWristTrackerGizmo;
    }

    float GetDebugWristTrackerGizmoLength() const;
    void SetDebugWristTrackerGizmoLength(float InDebugWristTrackerGizmoLength);

    const FLinearColor& GetDebugWristTrackerGizmoXAxisColor() const;
    void SetDebugWristTrackerGizmoXAxisColor(const FLinearColor& InDebugWristTrackerGizmoXAxisColor);

    const FLinearColor& GetDebugWristTrackerGizmoYAxisColor() const;
    void SetDebugWristTrackerGizmoYAxisColor(const FLinearColor& InDebugWristTrackerGizmoYAxisColor);

    const FLinearColor& GetDebugWristTrackerGizmoZAxisColor() const;
    void SetDebugWristTrackerGizmoZAxisColor(const FLinearColor& InDebugWristTrackerGizmoZAxisColor);

    bool GetDebugWristTrackerGizmoPersistentLines() const;
    void SetDebugWristTrackerGizmoPersistentLines(bool bInDebugWristTrackerGizmoPersistentLines);

    float GetDebugWristTrackerGizmoLifeTimeModifier() const;
    void SetDebugWristTrackerGizmoLifeTimeModifier(float InDebugWristTrackerGizmoLifeTimeModifier);

    uint8 GetDebugWristTrackerGizmoDepthPriority() const;
    void SetDebugWristTrackerGizmoDepthPriority(uint8 InDebugWristTrackerGizmoDepthPriority);

    float GetDebugWristTrackerGizmoThickness() const;
    void SetDebugWristTrackerGizmoThickness(float InDebugWristTrackerGizmoThickness);

public:
    virtual bool ShouldCreateSubsystem(UObject* Outer) const override;

    virtual void Initialize(FSubsystemCollectionBase& Collection) override;
    virtual void Deinitialize() override;

public:
#if WITH_EDITOR
    virtual bool CanEditChange(const FProperty* InProperty) const override;
    virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif  /* WITH_EDITOR */
};