Plugin/Source/SenseGloveCore/Private/SGCore/SGDevice.cpp

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


#include "SGCore/SGDevice.h"

#include "Engine/Engine.h"
#include "Engine/GameViewportClient.h"
#include "Engine/World.h"
#include "Kismet/GameplayStatics.h"
#include "Runtime/Launch/Resources/Version.h"
#include "SGCoreImpl/SGBetaDeviceImpl.h"

#include "SGCoreImpl/SGDeviceImpl.h"
#include "SGCoreImpl/SGExportedFunctions.h"
#include "SGInterop/SGIC_ESGConnectionType.h"
#include "SGInterop/SGIC_ESGDeviceType.h"
#include "SGInterop/SGIC_FSGBetaDeviceImpl.h"
#include "SGInterop/SGIC_FSGDeviceImpl.h"
#include "SGInterop/SGIC_FSGHapticGloveImpl.h"
#include "SGInterop/SGIC_FSGNovaGloveImpl.h"
#include "SGInterop/SGIC_FSGSenseGloveImpl.h"
#include "SGInterop/SGIC_FString.h"
#include "SGInterop/SGIC_TSharedPtr_FSGBetaDeviceImpl.h"
#include "SGInterop/SGIC_TSharedPtr_FSGDeviceImpl.h"
#include "SGInterop/SGIC_TSharedPtr_FSGHapticGloveImpl.h"
#include "SGInterop/SGIC_TSharedPtr_FSGNovaGloveImpl.h"
#include "SGInterop/SGIC_TSharedPtr_FSGSenseGloveImpl.h"

struct USGDevice::FImpl
{
    /************************
     * Member variables
     ************************/

    TSharedPtr<FSGDeviceImpl> SGDeviceImpl;

    /************************
     * Owner object
     ************************/

    USGDevice* Owner;

    /************************
     * Constructor / Destructor
     ************************/

    explicit FImpl(USGDevice* InOwner);
    ~FImpl();

    /************************
     * Default copy constructor & copy assignment operator
     ************************/

    FImpl(const FImpl& Rhs) = default;
    FImpl& operator=(const FImpl& Rhs) = default;

    /************************
     * Methods
     ************************/

    void SyncUProperties();

    void SyncImplObject();
};

void USGDevice::ParseFirmware(const FString& RawFirmware, int32& OutMainVersion, int32& OutSubVersion)
{
    FSGIC_FString RawFirmwareContainer{RawFirmware};
    SGCoreImpl_FSGDeviceImpl_ParseFirmware(&RawFirmwareContainer, &OutMainVersion, &OutSubVersion);
}

FString USGDevice::ToString(const ESGDeviceType DeviceType)
{
    FSGIC_ESGDeviceType DeviceTypeContainer{DeviceType};
    FSGIC_FString OutString;
    SGCoreImpl_FSGDeviceImpl_ToString(&DeviceTypeContainer, &OutString);
    return MoveTemp(OutString.String);
}

USGDevice::USGDevice()
    :
#if ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 )
    Pimpl(TUniquePtr<FImpl, FImplDeleter>(new FImpl{this}, PimplDeleter))
#else
    Pimpl(TUniquePtr<FImpl, FImplDeleter>(new FImpl{this}))
#endif  /* ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 ) */
{
    FSGIC_TSharedPtr_FSGDeviceImpl OutSharedPtrContainer;
    SGCoreImpl_FSGDeviceImpl_ctor_MakeShared(&OutSharedPtrContainer);

    Pimpl->SGDeviceImpl = MoveTemp(OutSharedPtrContainer.Ptr);
    Pimpl->SyncUProperties();
}

USGDevice::USGDevice(const FSGDeviceImpl& SGDeviceImpl)
    :
#if ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 )
    Pimpl(TUniquePtr<FImpl, FImplDeleter>(new FImpl{this}, PimplDeleter))
#else
    Pimpl(TUniquePtr<FImpl, FImplDeleter>(new FImpl{this}))
#endif  /* ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 ) */
{
    FSGIC_TSharedPtr_FSGDeviceImpl OutSharedPtrContainer;
    FSGIC_FSGDeviceImpl RhsContainer{SGDeviceImpl};
    SGCoreImpl_FSGDeviceImpl_ctor_copy_MakeShared(&OutSharedPtrContainer, &RhsContainer);

    Pimpl->SGDeviceImpl = MoveTemp(OutSharedPtrContainer.Ptr);
    Pimpl->SyncUProperties();
}

USGDevice::USGDevice(const FSGBetaDeviceImpl& BetaDeviceImpl)
    :
#if ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 )
    Pimpl(TUniquePtr<FImpl, FImplDeleter>(new FImpl{this}, PimplDeleter))
#else
    Pimpl(TUniquePtr<FImpl, FImplDeleter>(new FImpl{this}))
#endif  /* ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 ) */
{
    FSGIC_TSharedPtr_FSGBetaDeviceImpl OutSharedPtrContainer;
    FSGIC_FSGBetaDeviceImpl RhsContainer{BetaDeviceImpl};
    SGCoreImpl_FSGBetaDeviceImpl_ctor_copy_MakeShared(&OutSharedPtrContainer, &RhsContainer);

    Pimpl->SGDeviceImpl = MoveTemp(OutSharedPtrContainer.Ptr);
}

USGDevice::USGDevice(const FSGHapticGloveImpl& HapticGloveImpl)
    :
#if ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 )
    Pimpl(TUniquePtr<FImpl, FImplDeleter>(new FImpl{this}, PimplDeleter))
#else
    Pimpl(TUniquePtr<FImpl, FImplDeleter>(new FImpl{this}))
#endif  /* ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 ) */
{
    FSGIC_TSharedPtr_FSGHapticGloveImpl OutSharedPtrContainer;
    FSGIC_FSGHapticGloveImpl RhsContainer{HapticGloveImpl};
    SGCoreImpl_FSGHapticGloveImpl_ctor_copy_MakeShared(&OutSharedPtrContainer, &RhsContainer);

    Pimpl->SGDeviceImpl = MoveTemp(OutSharedPtrContainer.Ptr);
    Pimpl->SyncUProperties();
}

USGDevice::USGDevice(const FSGNovaGloveImpl& NovaGloveImpl)
    :
#if ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 )
    Pimpl(TUniquePtr<FImpl, FImplDeleter>(new FImpl{this}, PimplDeleter))
#else
    Pimpl(TUniquePtr<FImpl, FImplDeleter>(new FImpl{this}))
#endif  /* ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 ) */
{
    FSGIC_TSharedPtr_FSGNovaGloveImpl OutSharedPtrContainer;
    FSGIC_FSGNovaGloveImpl RhsContainer{NovaGloveImpl};
    SGCoreImpl_FSGNovaGloveImpl_ctor_copy_MakeShared(&OutSharedPtrContainer, &RhsContainer);

    Pimpl->SGDeviceImpl = MoveTemp(OutSharedPtrContainer.Ptr);
    Pimpl->SyncUProperties();
}

USGDevice::USGDevice(const FSGSenseGloveImpl& SenseGloveImpl)
    :
#if ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 )
    Pimpl(TUniquePtr<FImpl, FImplDeleter>(new FImpl{this}, PimplDeleter))
#else
    Pimpl(TUniquePtr<FImpl, FImplDeleter>(new FImpl{this}))
#endif  /* ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 ) */
{
    FSGIC_TSharedPtr_FSGSenseGloveImpl OutSharedPtrContainer;
    FSGIC_FSGSenseGloveImpl RhsContainer{SenseGloveImpl};
    SGCoreImpl_FSGSenseGloveImpl_ctor_copy_MakeShared(&OutSharedPtrContainer, &RhsContainer);

    Pimpl->SGDeviceImpl = MoveTemp(OutSharedPtrContainer.Ptr);
    Pimpl->SyncUProperties();
}

USGDevice::USGDevice(TSharedRef<FSGDeviceImpl> SGDeviceImpl)
    :
#if ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 )
    Pimpl(TUniquePtr<FImpl, FImplDeleter>(new FImpl{this}, PimplDeleter))
#else
    Pimpl(TUniquePtr<FImpl, FImplDeleter>(new FImpl{this}))
#endif  /* ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 ) */
{
    Pimpl->SGDeviceImpl = MoveTemp(SGDeviceImpl);
    Pimpl->SyncUProperties();
}

USGDevice::USGDevice(TSharedRef<FSGBetaDeviceImpl> BetaDeviceImpl)
    :
#if ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 )
    Pimpl(TUniquePtr<FImpl, FImplDeleter>(new FImpl{this}, PimplDeleter))
#else
    Pimpl(TUniquePtr<FImpl, FImplDeleter>(new FImpl{this}))
#endif  /* ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 ) */
{
    Pimpl->SGDeviceImpl = MoveTemp(BetaDeviceImpl);
    Pimpl->SyncUProperties();
}

USGDevice::USGDevice(TSharedRef<FSGHapticGloveImpl> HapticGloveImpl)
    :
#if ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 )
    Pimpl(TUniquePtr<FImpl, FImplDeleter>(new FImpl{this}, PimplDeleter))
#else
    Pimpl(TUniquePtr<FImpl, FImplDeleter>(new FImpl{this}))
#endif  /* ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 ) */
{
    Pimpl->SGDeviceImpl = MoveTemp(HapticGloveImpl);
    Pimpl->SyncUProperties();
}

USGDevice::USGDevice(TSharedRef<FSGNovaGloveImpl> NovaGloveImpl)
    :
#if ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 )
    Pimpl(TUniquePtr<FImpl, FImplDeleter>(new FImpl{this}, PimplDeleter))
#else
    Pimpl(TUniquePtr<FImpl, FImplDeleter>(new FImpl{this}))
#endif  /* ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 ) */
{
    Pimpl->SGDeviceImpl = MoveTemp(NovaGloveImpl);
    Pimpl->SyncUProperties();
}

USGDevice::USGDevice(TSharedRef<FSGSenseGloveImpl> SenseGloveImpl)
    :
#if ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 )
    Pimpl(TUniquePtr<FImpl, FImplDeleter>(new FImpl{this}, PimplDeleter))
#else
    Pimpl(TUniquePtr<FImpl, FImplDeleter>(new FImpl{this}))
#endif  /* ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 ) */
{
    Pimpl->SGDeviceImpl = MoveTemp(SenseGloveImpl);
    Pimpl->SyncUProperties();
}

USGDevice::~USGDevice() = default;

void USGDevice::SetSGDeviceImpl(const FSGDeviceImpl& SGDeviceImpl)
{
    FSGIC_TSharedPtr_FSGDeviceImpl OutSharedPtrContainer;
    FSGIC_FSGDeviceImpl RhsContainer{SGDeviceImpl};
    SGCoreImpl_FSGDeviceImpl_ctor_copy_MakeShared(&OutSharedPtrContainer, &RhsContainer);
    Pimpl->SGDeviceImpl = MoveTemp(OutSharedPtrContainer.Ptr);
}

void USGDevice::SetSGDeviceImpl(const FSGBetaDeviceImpl& BetaDeviceImpl)
{
    FSGIC_TSharedPtr_FSGBetaDeviceImpl OutSharedPtrContainer;
    FSGIC_FSGBetaDeviceImpl RhsContainer{BetaDeviceImpl};
    SGCoreImpl_FSGBetaDeviceImpl_ctor_copy_MakeShared(&OutSharedPtrContainer, &RhsContainer);
    Pimpl->SGDeviceImpl = MoveTemp(OutSharedPtrContainer.Ptr);
}

void USGDevice::SetSGDeviceImpl(const FSGHapticGloveImpl& HapticGloveImpl)
{
    FSGIC_TSharedPtr_FSGHapticGloveImpl OutSharedPtrContainer;
    FSGIC_FSGHapticGloveImpl RhsContainer{HapticGloveImpl};
    SGCoreImpl_FSGHapticGloveImpl_ctor_copy_MakeShared(&OutSharedPtrContainer, &RhsContainer);
    Pimpl->SGDeviceImpl = MoveTemp(OutSharedPtrContainer.Ptr);
}

void USGDevice::SetSGDeviceImpl(const FSGNovaGloveImpl& NovaGloveImpl)
{
    FSGIC_TSharedPtr_FSGNovaGloveImpl OutSharedPtrContainer;
    FSGIC_FSGNovaGloveImpl RhsContainer{NovaGloveImpl};
    SGCoreImpl_FSGNovaGloveImpl_ctor_copy_MakeShared(&OutSharedPtrContainer, &RhsContainer);
    Pimpl->SGDeviceImpl = MoveTemp(OutSharedPtrContainer.Ptr);
}

void USGDevice::SetSGDeviceImpl(const FSGSenseGloveImpl& SenseGloveImpl)
{
    FSGIC_TSharedPtr_FSGSenseGloveImpl OutSharedPtrContainer;
    FSGIC_FSGSenseGloveImpl RhsContainer{SenseGloveImpl};
    SGCoreImpl_FSGSenseGloveImpl_ctor_copy_MakeShared(&OutSharedPtrContainer, &RhsContainer);
    Pimpl->SGDeviceImpl = MoveTemp(OutSharedPtrContainer.Ptr);
}

void USGDevice::SetSGDeviceImpl(TSharedRef<FSGDeviceImpl> SGDeviceImpl)
{
    Pimpl->SGDeviceImpl = MoveTemp(SGDeviceImpl);
}

void USGDevice::SetSGDeviceImpl(TSharedRef<FSGBetaDeviceImpl> BetaDeviceImpl)
{
    Pimpl->SGDeviceImpl = MoveTemp(BetaDeviceImpl);
}

void USGDevice::SetSGDeviceImpl(TSharedRef<FSGHapticGloveImpl> HapticGloveImpl)
{
    Pimpl->SGDeviceImpl = MoveTemp(HapticGloveImpl);
}

void USGDevice::SetSGDeviceImpl(TSharedRef<FSGNovaGloveImpl> NovaGloveImpl)
{
    Pimpl->SGDeviceImpl = MoveTemp(NovaGloveImpl);
}

void USGDevice::SetSGDeviceImpl(TSharedRef<FSGSenseGloveImpl> SenseGloveImpl)
{
    Pimpl->SGDeviceImpl = MoveTemp(SenseGloveImpl);
}

TSharedRef<FSGDeviceImpl> USGDevice::ToSGDeviceImpl() const
{
    SyncImplObject();
    return Pimpl->SGDeviceImpl.ToSharedRef();
}

void USGDevice::SyncImplObject() const
{
    Pimpl->SyncImplObject();
}

void USGDevice::SyncUProperties()
{
    Pimpl->SyncUProperties();
}

ESGDeviceType USGDevice::GetDeviceType() const
{
    SyncImplObject();

    FSGIC_TSharedPtr_FSGDeviceImpl InstanceContainer{ToSGDeviceImpl()};
    FSGIC_ESGDeviceType OutTypeContainer;
    SGCoreImpl_FSGDeviceImpl_GetDeviceType(&InstanceContainer, &OutTypeContainer);
    return OutTypeContainer.Type;
}

int32 USGDevice::GetSubFirmwareVersion() const
{
    SyncImplObject();

    FSGIC_TSharedPtr_FSGDeviceImpl InstanceContainer{ToSGDeviceImpl()};
    return SGCoreImpl_FSGDeviceImpl_GetSubFirmwareVersion(&InstanceContainer);
}

FString USGDevice::GetFirmwareString() const
{
    SyncImplObject();

    FSGIC_TSharedPtr_FSGDeviceImpl InstanceContainer{ToSGDeviceImpl()};
    FSGIC_FString OutStringContainer;
    SGCoreImpl_FSGDeviceImpl_GetFirmwareString(&InstanceContainer, &OutStringContainer);
    return MoveTemp(OutStringContainer.String);
}

FString USGDevice::GetAddress() const
{
    SyncImplObject();

    FSGIC_TSharedPtr_FSGDeviceImpl InstanceContainer{ToSGDeviceImpl()};
    FSGIC_FString AddressContainer;
    SGCoreImpl_FSGDeviceImpl_GetAddress(&InstanceContainer, &AddressContainer);
    return AddressContainer.String;
}

bool USGDevice::IsConnected() const
{
    SyncImplObject();

    FSGIC_TSharedPtr_FSGDeviceImpl InstanceContainer{ToSGDeviceImpl()};
    return SGCoreImpl_FSGDeviceImpl_IsConnected(&InstanceContainer);
}

ESGConnectionType USGDevice::GetConnectionType() const
{
    SyncImplObject();

    FSGIC_TSharedPtr_FSGDeviceImpl InstanceContainer{ToSGDeviceImpl()};
    FSGIC_ESGConnectionType OutTypeContainer;
    SGCoreImpl_FSGDeviceImpl_GetConnectionType(&InstanceContainer, &OutTypeContainer);
    return OutTypeContainer.Type;
}

int32 USGDevice::PacketsPerSecondReceived() const
{
    SyncImplObject();

    FSGIC_TSharedPtr_FSGDeviceImpl InstanceContainer{ToSGDeviceImpl()};
    return SGCoreImpl_FSGDeviceImpl_PacketsPerSecondReceived(&InstanceContainer);
}

int32 USGDevice::PacketsPerSecondSent() const
{
    SyncImplObject();

    FSGIC_TSharedPtr_FSGDeviceImpl InstanceContainer{ToSGDeviceImpl()};
    return SGCoreImpl_FSGDeviceImpl_PacketsPerSecondSent(&InstanceContainer);
}

int32 USGDevice::GetDeviceIndex() const
{
    SyncImplObject();

    FSGIC_TSharedPtr_FSGDeviceImpl InstanceContainer{ToSGDeviceImpl()};
    return SGCoreImpl_FSGDeviceImpl_GetDeviceIndex(&InstanceContainer);
}

void USGDevice::SetDeviceIndex(const int32 NewIndex)
{
    SyncImplObject();

    FSGIC_TSharedPtr_FSGDeviceImpl InstanceContainer{ToSGDeviceImpl()};
    SGCoreImpl_FSGDeviceImpl_SetDeviceIndex(&InstanceContainer, NewIndex);

    SyncUProperties();
}

bool USGDevice::IsWireless() const
{
    SyncImplObject();

    FSGIC_TSharedPtr_FSGDeviceImpl InstanceContainer{ToSGDeviceImpl()};
    return SGCoreImpl_FSGDeviceImpl_IsWireless(&InstanceContainer);
}

bool USGDevice::HasBattery() const
{
    SyncImplObject();

    FSGIC_TSharedPtr_FSGDeviceImpl InstanceContainer{ToSGDeviceImpl()};
    return SGCoreImpl_FSGDeviceImpl_HasBattery(&InstanceContainer);
}

bool USGDevice::IsCharging()
{
    SyncImplObject();

    FSGIC_TSharedPtr_FSGDeviceImpl InstanceContainer{ToSGDeviceImpl()};
    const bool bResult = SGCoreImpl_FSGDeviceImpl_IsCharging(&InstanceContainer);

    SyncUProperties();

    return bResult;
}

bool USGDevice::GetBatteryLevel(float& OutLevel)
{
    SyncImplObject();

    FSGIC_TSharedPtr_FSGDeviceImpl InstanceContainer{ToSGDeviceImpl()};
    const bool bResult = SGCoreImpl_FSGDeviceImpl_GetBatteryLevel(&InstanceContainer, &OutLevel);

    SyncUProperties();

    return bResult;
}

FString USGDevice::ToString() const
{
    SyncImplObject();

    FSGIC_TSharedPtr_FSGDeviceImpl InstanceContainer{ToSGDeviceImpl()};
    FSGIC_FString OutStringContainer;
    SGCoreImpl_FSGDeviceImpl_ToString(&InstanceContainer, &OutStringContainer);
    return MoveTemp(OutStringContainer.String);
}

USGDevice::FImpl::FImpl(USGDevice* InOwner)
    : Owner(InOwner)
{
}

USGDevice::FImpl::~FImpl() = default;

void USGDevice::FImplDeleter::operator()(const FImpl* P) const
{
    delete P;
}

void USGDevice::FImpl::SyncUProperties()
{
}

void USGDevice::FImpl::SyncImplObject()
{
}