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

133 lines
3.2 KiB
C++

/**
* @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
*
*
*/
#pragma once
#include "HAL/Platform.h"
#include "Runtime/Launch/Resources/Version.h"
#include "Templates/UniquePtr.h"
#include "SGCoreImpl/SGPlatform.h"
namespace SGCore
{
namespace Haptics
{
class ThumperCommand;
}
}
class SENSEGLOVECOREIMPL_API FSGThumperCommandImpl final
{
public:
typedef SGCore::Haptics::ThumperCommand FThumperCommandType;
public:
static const FSGThumperCommandImpl& Off();
private:
struct FImpl;
struct FImplDeleter
{
void operator()(const FImpl* P) const;
};
TUniquePtr<FImpl, FImplDeleter> Pimpl;
FImplDeleter PimplDeleter;
public:
FSGThumperCommandImpl();
explicit FSGThumperCommandImpl(int32 Magnitude);
public:
/**
* The cast from underlying type constructor.
*/
explicit FSGThumperCommandImpl(const FThumperCommandType& ThumperCommand);
public:
/**
* The copy constructor.
*/
FSGThumperCommandImpl(const FSGThumperCommandImpl& Rhs);
/**
* The move constructor
*/
FSGThumperCommandImpl(FSGThumperCommandImpl&& Rhs)
#if SG_CPP17
noexcept
#endif /* SG_CPP17 */
;
public:
/**
* The destructor.
*/
virtual ~FSGThumperCommandImpl();
public:
/**
* The copy assignment operator.
*/
FSGThumperCommandImpl& operator=(const FSGThumperCommandImpl& Rhs);
/**
* The move assignment operator.
*/
FSGThumperCommandImpl& operator=(FSGThumperCommandImpl&& Rhs)
#if SG_CPP17
noexcept
#endif /* SG_CPP17 */
;
public:
/**
* The cast to underlying type method.
*/
const FThumperCommandType& ToThumperCommand() const;
public:
int32 GetMagnitude() const;
void SetMagnitude(int32 Magnitude);
FSGThumperCommandImpl Copy() const;
FSGThumperCommandImpl Merge(const FSGThumperCommandImpl& ThumperCommandImpl) const;
virtual bool Equals(const FSGThumperCommandImpl& ThumperCommandImpl) const;
};