Plugin/Source/SenseGloveCoreImpl/Public/SGCoreImpl/SGTimedBuzzCommandImpl.h

/**
 * @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/SharedPointer.h"
#include "Templates/UniquePtr.h"

#include "SGCoreImpl/SGBuzzCommandImpl.h"
#include "SGTypes/SGCoreTypes.h"

namespace SGCore
{
    namespace Haptics
    {
        class TimedBuzzCommand;
    }
}

class SENSEGLOVECOREIMPL_API FSGTimedBuzzCommandImpl final : public FSGBuzzCommandImpl
{
public:
    typedef SGCore::Haptics::TimedBuzzCommand FTimedBuzzCommandType;

private:
    struct FImpl;

    struct FImplDeleter
    {
        void operator()(const FImpl* P) const;
    };

    TUniquePtr<FImpl, FImplDeleter> Pimpl;
    FImplDeleter PimplDeleter;

public:
    FSGTimedBuzzCommandImpl();

public:
    FSGTimedBuzzCommandImpl(ESGFinger Finger, int32 Magnitude, float DurationSeconds, float StartTimeSeconds = 0.0f);

    FSGTimedBuzzCommandImpl(const FSGBuzzCommandImpl& BaseCommand, float DurationSeconds,
                            float StartTimeSeconds = 0.0f);

public:
    /**
     * The cast from underlying type constructor.
     */
    explicit FSGTimedBuzzCommandImpl(const FTimedBuzzCommandType& TimedBuzzCommand);

    /**
     * The cast from underlying pointer type constructor.
     */
    explicit FSGTimedBuzzCommandImpl(TSharedRef<FTimedBuzzCommandType> TimedBuzzCommand);

public:
    /**
     * The copy constructor.
     */
    FSGTimedBuzzCommandImpl(const FSGTimedBuzzCommandImpl& Rhs);

    /**
     * The move constructor
     */
    FSGTimedBuzzCommandImpl(FSGTimedBuzzCommandImpl&& 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 ~FSGTimedBuzzCommandImpl();

public:
    /**
     * The copy assignment operator.
     */
    FSGTimedBuzzCommandImpl& operator=(const FSGTimedBuzzCommandImpl& Rhs);

    /**
     * The move assignment operator.
     */
    FSGTimedBuzzCommandImpl& operator=(FSGTimedBuzzCommandImpl&& 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 FTimedBuzzCommandType& ToTimedBuzzCommand() const;

    /**
     * The cast to underlying pointer type method.
     */
    TSharedRef<FTimedBuzzCommandType> ToTimedBuzzCommandRef() const;

protected:
    /**
     * The non-const cast to underlying type method.
     */
    FTimedBuzzCommandType& ToTimedBuzzCommand();

    /**
     * The non-const cast to underlying type method.
     */
    TSharedRef<FTimedBuzzCommandType> ToTimedBuzzCommandRef();

public:
    virtual FSGBuzzCommandImpl Copy() const override;

    virtual FSGBuzzCommandImpl Merge(const FSGBuzzCommandImpl& BuzzCommand) const override;

public:
    virtual FSGBuzzCommandImpl GetBaseCommand() const;
    void SetBaseCommand(const FSGBuzzCommandImpl& BaseCommand);

    int32 GetMagnitude() const;
    void SetMagnitude(int32 Magnitude);

    float GetDuration() const;
    void SetDuration(float Duration);

    float GetElapsedTime() const;
    void SetElapsedTime(float ElapsedTime);

    virtual bool HasTimeElapsed() const;

    virtual float NormalizedTime(bool bClamp01 = true) const;

public:
    virtual void ResetTiming();
    virtual void UpdateTiming(float DeltaSeconds);

public:
    virtual FString ToString() const override;
};