Files
Plugin/Source/SenseGloveCoreImpl/Public/SGCoreImpl/SGHapticChannelInfoImpl.h
T

133 lines
3.5 KiB
C++

/**
* @file
*
* @author Mamadou Babaei <mamadou@senseglove.com>
*
* @section LICENSE
*
* (The MIT License)
*
* Copyright (c) 2020 - 2024 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/Array.h"
#include "Containers/UnrealString.h"
#include "HAL/Platform.h"
#include "SGBuildHacks/SGPlatform.h"
#include "SGTypes/SGCoreTypes.h"
namespace SGCore
{
class HapticChannelInfo;
}
class SENSEGLOVECOREIMPL_API FSGHapticChannelInfoImpl final
{
public:
typedef SGCore::HapticChannelInfo FHapticChannelInfoType;
public:
static FString GenerateAddress(int32 DeviceIndex, int32 ChannelIndex);
static FSGHapticChannelInfoImpl Parse(const FString& IpcString);
public:
static int32 GetStreamingType();
static int32 GetFireAndForgetType();
private:
struct FImpl;
struct FImplDeleter
{
void operator()(const FImpl* P) const;
};
TUniquePtr<FImpl, FImplDeleter> Pimpl;
FImplDeleter PimplDeleter;
public:
FSGHapticChannelInfoImpl();
FSGHapticChannelInfoImpl(const TArray<int32>& StreamIndex, const TArray<int32>& FireAndForgetIndex);
public:
/**
* The cast from underlying type constructor.
*/
explicit FSGHapticChannelInfoImpl(const FHapticChannelInfoType& HapticChannelInfo);
public:
/**
* The copy constructor.
*/
FSGHapticChannelInfoImpl(const FSGHapticChannelInfoImpl& Rhs);
/**
* The move constructor.
*/
FSGHapticChannelInfoImpl(FSGHapticChannelInfoImpl&& Rhs) SG_NOEXCEPT;
public:
/**
* The destructor.
*/
virtual ~FSGHapticChannelInfoImpl();
public:
/**
* The copy assignment operator.
*/
FSGHapticChannelInfoImpl& operator=(const FSGHapticChannelInfoImpl& Rhs);
/**
* The move assignment operator.
*/
FSGHapticChannelInfoImpl& operator=(FSGHapticChannelInfoImpl&& Rhs) SG_NOEXCEPT;
public:
/**
* The cast to underlying type method.
*/
const FHapticChannelInfoType& ToHapticChannelInfo() const;
public:
int32 GetStreamChannelCount() const;
int32 GetFireAndForgetChannelCount() const;
int32 GetTotalChannelCount() const;
FString GetAddress_Unguarded(ESGHapticChannelType Type, int32 TypeIndex) const;
void GetIpcParams_Unguarded(ESGHapticChannelType Type, int32 TypeIndex,
int32& OutIndex, FString& OutAddressString) const;
void RegenerateAddresses(int32 ForDeviceIndex);
TArray<FString> GetAllAddresses() const;
};