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 "SGSettings/SGDebugGizmoSettings.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 TrackingHardware;

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

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

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

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

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

    /**
     * Valid only if bDrawDebugWristTrackerGizmo is enabled.
     */
    UPROPERTY(Config, EditDefaultsOnly, Category = "Wrist Tracking Debug",
        meta=(EditCondition="bDrawWristTrackerDebugGizmo", EditConditionHides))
    FSGDebugGizmoSettings WristTrackerDebugGizmoSettings;

public:
    USGSettings();

public:
    FORCEINLINE ESGPositionalTrackingHardware GetTrackingHardware() const
    {
        return TrackingHardware;
    }

    FORCEINLINE void SetTrackingHardware(const ESGPositionalTrackingHardware InTrackingHardware)
    {
        TrackingHardware = InTrackingHardware;
    }

    const FVector& GetTrackingHardwareLocationOffsetLeftHand() const;
    void SetTrackingHardwareLocationOffsetLeftHand(const FVector& InTrackingHardwareLocationOffsetLeftHand);

    const FVector& GetTrackingHardwareLocationOffsetRightHand() const;
    void SetTrackingHardwareLocationOffsetRightHand(const FVector& InTrackingHardwareLocationOffsetRightHand);

    const FRotator& GetTrackingHardwareRotationOffsetLeftHand() const;
    void SetTrackingHardwareRotationOffsetLeftHand(const FRotator& InTrackingHardwareRotationOffsetLeftHand);

    const FRotator& GetTrackingHardwareRotationOffsetRightHand() const;
    void SetTrackingHardwareRotationOffsetRightHand(const FRotator& InTrackingHardwareRotationOffsetRightHand);

    FORCEINLINE bool GetDrawWristTrackerDebugGizmo() const
    {
        return !!bDrawWristTrackerDebugGizmo;
    }

    void SetDrawWristTrackerDebugGizmo(const bool bInDrawWristTrackerDebugGizmo)
    {
        bDrawWristTrackerDebugGizmo = bInDrawWristTrackerDebugGizmo;
    }

    const FSGDebugGizmoSettings& GetWristTrackerDebugGizmoSettings() const;
    void SetWristTrackerDebugGizmoSettings(const FSGDebugGizmoSettings& InWristTrackerDebugGizmoSettings);

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 */
};