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

148 lines
3.9 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 "Containers/UnrealString.h"
#include "HAL/Platform.h"
#include "Runtime/Launch/Resources/Version.h"
#include "Templates/UniquePtr.h"
namespace SGCore
{
namespace Haptics
{
class TimedThumpCommand;
}
}
class FSGThumperCommandImpl;
class SENSEGLOVECOREIMPL_API FSGTimedThumpCommandImpl final
{
public:
typedef SGCore::Haptics::TimedThumpCommand FTimedThumpCommandType;
private:
struct FImpl;
struct FImplDeleter
{
void operator()(const FImpl* P) const;
};
TUniquePtr<FImpl, FImplDeleter> Pimpl;
FImplDeleter PimplDeleter;
public:
FSGTimedThumpCommandImpl();
public:
FSGTimedThumpCommandImpl(int32 Magnitude, float DurationSeconds, float StartTimeSeconds = 0.0f);
FSGTimedThumpCommandImpl(const FSGThumperCommandImpl& BaseCommand, float DurationSeconds,
float StartTimeSeconds = 0.0f);
public:
/**
* The cast from underlying type constructor.
*/
explicit FSGTimedThumpCommandImpl(const FTimedThumpCommandType& TimedThumpCommand);
public:
/**
* The copy constructor.
*/
FSGTimedThumpCommandImpl(const FSGTimedThumpCommandImpl& Rhs);
/**
* The move constructor
*/
FSGTimedThumpCommandImpl(FSGTimedThumpCommandImpl&& Rhs)
#if ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 )
noexcept
#endif /* ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 ) */
;
public:
/**
* The destructor.
*/
virtual ~FSGTimedThumpCommandImpl();
public:
/**
* The copy assignment operator.
*/
FSGTimedThumpCommandImpl& operator=(const FSGTimedThumpCommandImpl& Rhs);
/**
* The move assignment operator.
*/
FSGTimedThumpCommandImpl& operator=(FSGTimedThumpCommandImpl&& Rhs)
#if ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 )
noexcept
#endif /* ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 ) */
;
public:
/**
* The cast to underlying type method.
*/
const FTimedThumpCommandType& ToTimedThumpCommand() const;
public:
int32 GetMagnitude() const;
void SetMagnitude(int32 Magnitude);
float GetDuration() const;
void SetDuration(float Duration);
float GetElapsedTime() const;
void SetElapsedTime(float ElapsedTime);
bool HasTimeElapsed() const;
public:
virtual FSGTimedThumpCommandImpl Copy(bool bCopyElapsed = true) const;
virtual void Update(float DeltaSeconds);
virtual bool Equals(const FSGThumperCommandImpl& SGThumperCommandImpl) const;
public:
virtual FString ToString() const;
};