Plugin/Source/SenseGloveCoreImpl/Public/SGCoreImpl/SGHandProfileImpl.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 "Containers/UnrealString.h"
#include "Runtime/Launch/Resources/Version.h"
#include "Templates/UniquePtr.h"

#include "SGCoreImpl/SGPlatform.h"

class FSGHandInterpolatorImpl;

namespace SGCore
{
    class HandProfile;
}

class FSGNovaGloveHandProfileImpl;
class FSGSenseGloveHandProfileImpl;

class SENSEGLOVECOREIMPL_API FSGHandProfileImpl final
{
public:
    typedef SGCore::HandProfile FHandProfileType;

public:
    static FSGHandProfileImpl Default(bool bRightHanded);

    static FSGHandProfileImpl Deserialize(const FString& SerializedString);

public:
    static const FString& GetProfileDirectory();

    static const FString& GetLeftHandFileName();

    static const FString& GetRightHandFileName();

    static const FString& GetProfileFileName(bool bRightHanded);

    static bool GetLatestProfile(bool bRightHanded, FSGHandProfileImpl& OutLatestProfile);

    static bool StoreProfile(const FSGHandProfileImpl& ProfileToStore);

    static bool ResetCalibration(bool bRightHanded, bool bOnDisk = true);

    static void ResetCalibration(bool bOnDisk = true);

private:
    struct FImpl;

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

    TUniquePtr<FImpl, FImplDeleter> Pimpl;
    FImplDeleter PimplDeleter;

public:
    FSGHandProfileImpl();

    FSGHandProfileImpl(bool bRightHanded,
                const FSGSenseGloveHandProfileImpl& SenseGloveHandProfile,
                const FSGNovaGloveHandProfileImpl& NovaGloveHandProfile);

public:
    /**
     * The cast from underlying type constructor.
     */
    explicit FSGHandProfileImpl(const FHandProfileType& SenseGloveHandProfile);

public:
    /**
     * The copy constructor.
     */
    FSGHandProfileImpl(const FSGHandProfileImpl& Rhs);

    /**
     * The move constructor.
     */
    FSGHandProfileImpl(FSGHandProfileImpl&& Rhs) SG_NOEXCEPT;

public:
    /**
     * The destructor.
     */
    virtual ~FSGHandProfileImpl();

public:
    /**
     * The copy assignment operator.
     */
    FSGHandProfileImpl& operator=(const FSGHandProfileImpl& Rhs);

    /**
     * The move assignment operator.
     */
    FSGHandProfileImpl& operator=(FSGHandProfileImpl&& Rhs) SG_NOEXCEPT;

public:
    /**
     * The cast to underlying type method.
     */
    const FHandProfileType& ToHandProfile() const;

public:
    bool IsRight() const;

    FSGSenseGloveHandProfileImpl GetSenseGloveHandProfile() const;

    FSGNovaGloveHandProfileImpl GetNovaGloveHandProfile() const;

public:
    bool Equals(const FSGHandProfileImpl& HandProfileImpl) const;

    void Reset();

public:
    FString Serialize() const;
};