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

157 lines
3.8 KiB
C++

/**
* @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 "HAL/Platform.h"
#include "Runtime/Launch/Resources/Version.h"
#include "Templates/SharedPointer.h"
#include "Templates/UniquePtr.h"
#include "SGCoreImpl/SGFingerCommandImpl.h"
#include "SGCoreImpl/SGPlatform.h"
#include "SGTypes/SGCoreTypes.h"
namespace SGCore
{
namespace Haptics
{
class BuzzCommand;
}
}
class SENSEGLOVECOREIMPL_API FSGBuzzCommandImpl : public FSGFingerCommandImpl
{
public:
typedef SGCore::Haptics::BuzzCommand FBuzzCommandType;
public:
static const FSGBuzzCommandImpl& Off();
private:
struct FImpl;
struct FImplDeleter
{
void operator()(const FImpl* P) const;
};
TUniquePtr<FImpl, FImplDeleter> Pimpl;
FImplDeleter PimplDeleter;
public:
FSGBuzzCommandImpl();
public:
explicit FSGBuzzCommandImpl(const TArray<int32>& BuzzLevels);
FSGBuzzCommandImpl(int32 Thumb, int32 Index, int32 Middle, int32 Ring, int32 Pinky);
FSGBuzzCommandImpl(ESGFinger Finger, int32 BuzzLevel);
public:
/**
* The cast from underlying type constructor.
*/
explicit FSGBuzzCommandImpl(const FBuzzCommandType& BuzzCommand);
/**
* The cast from underlying pointer type constructor.
*/
explicit FSGBuzzCommandImpl(TSharedRef<FBuzzCommandType> BuzzCommand);
public:
/**
* The copy constructor.
*/
FSGBuzzCommandImpl(const FSGBuzzCommandImpl& Rhs);
/**
* The move constructor
*/
FSGBuzzCommandImpl(FSGBuzzCommandImpl&& Rhs)
#if SG_CPP17
noexcept
#endif /* SG_CPP17 */
;
public:
/**
* The destructor.
*/
virtual ~FSGBuzzCommandImpl() override;
public:
/**
* The copy assignment operator.
*/
FSGBuzzCommandImpl& operator=(const FSGBuzzCommandImpl& Rhs);
/**
* The move assignment operator.
*/
FSGBuzzCommandImpl& operator=(FSGBuzzCommandImpl&& Rhs)
#if SG_CPP17
noexcept
#endif /* SG_CPP17 */
;
public:
/**
* The cast to underlying type method.
*/
const FBuzzCommandType& ToBuzzCommand() const;
/**
* The cast to underlying pointer type method.
*/
TSharedRef<FBuzzCommandType> ToBuzzCommandRef() const;
protected:
/**
* The non-const cast to underlying type method.
*/
FBuzzCommandType& ToBuzzCommand();
/**
* The non-const cast to underlying pointer type method.
*/
TSharedRef<FBuzzCommandType> ToBuzzCommandRef();
public:
virtual FSGBuzzCommandImpl Copy() const;
virtual FSGBuzzCommandImpl Merge(const FSGBuzzCommandImpl& Command) const;
};