148 lines
3.5 KiB
C++
148 lines
3.5 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
|
|
*
|
|
* Thumper command.
|
|
*/
|
|
|
|
|
|
#pragma once
|
|
|
|
#include "HAL/Platform.h"
|
|
#include "Templates/UniquePtr.h"
|
|
#include "UObject/Object.h"
|
|
#include "UObject/ObjectMacros.h"
|
|
|
|
#include "SGThumperCommand.generated.h"
|
|
|
|
class FSGThumperCommandImpl;
|
|
|
|
/**
|
|
*
|
|
*/
|
|
UCLASS(BlueprintType)
|
|
class SENSEGLOVECORE_API USGThumperCommand : public UObject
|
|
{
|
|
GENERATED_BODY()
|
|
|
|
public:
|
|
static USGThumperCommand* NewThumperCommand(UObject* Outer, const FSGThumperCommandImpl& ThumperCommandImpl);
|
|
|
|
public:
|
|
/**
|
|
* Empty constructor for inheritance.
|
|
*/
|
|
static USGThumperCommand* NewThumperCommand(UObject* Outer);
|
|
|
|
/**
|
|
* Create a new Thumper Command.
|
|
*/
|
|
static USGThumperCommand* NewThumperCommand(UObject* Outer, int32 Magnitude);
|
|
|
|
public:
|
|
/**
|
|
* A command that turns off all force feedback on the Sense Glove.
|
|
*/
|
|
static USGThumperCommand* Off(UObject* Outer);
|
|
|
|
private:
|
|
struct FImpl;
|
|
|
|
struct FImplDeleter
|
|
{
|
|
void operator()(const FImpl* P) const;
|
|
};
|
|
|
|
TUniquePtr<FImpl, FImplDeleter> Pimpl;
|
|
FImplDeleter PimplDeleter;
|
|
|
|
public:
|
|
/**
|
|
* Empty constructor for inheritance.
|
|
*/
|
|
USGThumperCommand();
|
|
|
|
/**
|
|
* Create a new Thumper Command.
|
|
*/
|
|
explicit USGThumperCommand(int32 Magnitude);
|
|
|
|
public:
|
|
/**
|
|
* The cast from underlying type constructor.
|
|
*/
|
|
explicit USGThumperCommand(const FSGThumperCommandImpl& ThumperCommandImpl);
|
|
|
|
public:
|
|
/**
|
|
* The destructor.
|
|
*/
|
|
virtual ~USGThumperCommand() override;
|
|
|
|
protected:
|
|
/**
|
|
* Allows to set the underlying object after construction.
|
|
*/
|
|
void SetThumperCommandImpl(const FSGThumperCommandImpl& ThumperCommandImpl);
|
|
|
|
public:
|
|
/**
|
|
* The cast to underlying type method.
|
|
*/
|
|
const FSGThumperCommandImpl& ToThumperCommandImpl() const;
|
|
|
|
public:
|
|
/**
|
|
* Thumper intensity, a level between 0 and 100.
|
|
*/
|
|
int32 GetMagnitude() const;
|
|
|
|
/**
|
|
*
|
|
*/
|
|
void SetMagnitude(int32 Magnitude);
|
|
|
|
public:
|
|
/**
|
|
* Duplicate the Thumper command.
|
|
*/
|
|
USGThumperCommand* Copy(UObject* Outer) const;
|
|
|
|
/**
|
|
* Merge two ThumperCommands into one.
|
|
*/
|
|
USGThumperCommand* Merge(UObject* Outer, const USGThumperCommand* ThumperCommand) const;
|
|
|
|
/**
|
|
*
|
|
*/
|
|
bool Equals(const USGThumperCommand* ThumperCommand) const;
|
|
};
|