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

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

#include "SGCoreImpl/SGPlatform.h"

namespace SGCore
{
    namespace Haptics
    {
        class HapticGloveCommandBuffer;
    }
}

class FSGBuzzCommandImpl;
class FSGFingerCommandImpl;
class FSGForceFeedbackCommandImpl;
class FSGThumperCommandImpl;
class FSGTimedBuzzCommandImpl;
class FSGTimedThumpCommandImpl;

class SENSEGLOVECOREIMPL_API FSGHapticGloveCommandBufferImpl final
{
public:
    typedef SGCore::Haptics::HapticGloveCommandBuffer FHapticGloveCommandBufferType;

public:
    static int32 GetMaxForceFeedbackCommands();

    static int32 GetMaxBuzzCommands();

    static int32 GetMaxThumpCommands();

private:
    struct FImpl;

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

    TUniquePtr<FImpl, FImplDeleter> Pimpl;
    FImplDeleter PimplDeleter;

public:
    FSGHapticGloveCommandBufferImpl();

public:
    /**
     * The cast from underlying type constructor.
     */
    explicit FSGHapticGloveCommandBufferImpl(const FHapticGloveCommandBufferType& HapticGloveCommandBuffer);

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

    /**
     * The move constructor.
     */
    FSGHapticGloveCommandBufferImpl(FSGHapticGloveCommandBufferImpl&& Rhs) SG_NOEXCEPT;

public:
    /**
     * The destructor.
     */
    virtual ~FSGHapticGloveCommandBufferImpl();

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

    /**
     * The move assignment operator.
     */
    FSGHapticGloveCommandBufferImpl& operator=(FSGHapticGloveCommandBufferImpl&& Rhs) SG_NOEXCEPT;

public:
    /**
     * The cast to underlying type method.
     */
    const FHapticGloveCommandBufferType& ToHapticGloveCommandBuffer() const;

public:
    TArray<FSGForceFeedbackCommandImpl> GetForceFeedbackCommandsQueue() const;

    TArray<FSGTimedBuzzCommandImpl> GetBuzzCommandsQueue() const;

    TArray<FSGTimedThumpCommandImpl> GetThumperCommandsQueue() const;

public:
    void ClearForceFeedbackCommandsQueue();

    void ClearVibrations();

    void Clear();

    void AddCommand(const FSGForceFeedbackCommandImpl& ForceFeedbackCommand);

    void AddCommand(const FSGTimedBuzzCommandImpl& BuzzCommand);

    void AddCommand(const FSGTimedThumpCommandImpl& ThumpCommand);

    void UpdateTimedCommands(float DeltaSeconds);

public:
    FSGForceFeedbackCommandImpl GetTotalForceFeedbackLevels(
        const FSGForceFeedbackCommandImpl& LastForceFeedbackCommand) const;

    FSGForceFeedbackCommandImpl GetTotalForceFeedbackLevels() const;

    FSGBuzzCommandImpl GetTotalBuzzLevels() const;

    FSGThumperCommandImpl GetTotalThumperLevels() const;

public:
    void FlushHaptics(const FSGForceFeedbackCommandImpl& LastBrakeLevel,
                      FSGForceFeedbackCommandImpl& OutForceFeedbackCommand,
                      FSGBuzzCommandImpl& OutBuzzCommand, FSGThumperCommandImpl& OutThumperCommand,
                      bool bClearForceFeedbackQueue = true);

    void FlushHaptics(float DeltaSeconds, const FSGForceFeedbackCommandImpl& LastBrakeLevel,
                      FSGForceFeedbackCommandImpl& OutForceFeedbackCommand, FSGBuzzCommandImpl& OutBuzzCommand,
                      FSGThumperCommandImpl& OutThumperCommand);
};