/*****************************************************************************************
 *                                                                                       *
 * OpenSpace                                                                             *
 *                                                                                       *
 * Copyright (c) 2014-2024                                                               *
 *                                                                                       *
 * 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.                                         *
 ****************************************************************************************/

#ifndef __OPENSPACE_MODULE_TOUCH___TOUCHMODULE___H__
#define __OPENSPACE_MODULE_TOUCH___TOUCHMODULE___H__

#include <modules/touch/include/touchmarker.h>
#include <modules/touch/include/touchinteraction.h>
#include <openspace/properties/list/stringlistproperty.h>
#include <openspace/properties/scalar/boolproperty.h>
#include <openspace/util/openspacemodule.h>
#include <openspace/util/touch.h>
#include <memory>

namespace openspace {

class TuioEar;

#ifdef WIN32
class Win32TouchHook;
#endif //WIN32

class TouchModule : public OpenSpaceModule {
public:
    constexpr static const char* Name = "Touch";

    TouchModule();
    ~TouchModule();

    /**
     * Function to check if the given renderable type is one that should use direct
     * manipulation.
     */
    bool isDefaultDirectTouchType(std::string_view renderableType) const;

protected:
    void internalInitialize(const ghoul::Dictionary& dictionary) override;

private:
    /**
     * Returns true if new touch input occured since the last frame.
     */
    bool processNewInput();

    void clearInputs();

    void addTouchInput(TouchInput input);
    void updateOrAddTouchInput(TouchInput input);
    void removeTouchInput(TouchInput input);

    std::unique_ptr<TuioEar> _ear;
    TouchInteraction _touch;
    TouchMarker _markers;
    std::vector<TouchInputHolder> _touchPoints;
    std::vector<TouchInput> _deferredRemovals;
    std::vector<TouchInput> _lastTouchInputs;

    properties::BoolProperty _touchIsEnabled;
    properties::BoolProperty _hasActiveTouchEvent;
    properties::StringListProperty _defaultDirectTouchRenderableTypes;

    // A sorted version of the list in the property
    std::set<std::string> _sortedDefaultRenderableTypes;

    // contains an id and the Point that was processed last frame
    glm::ivec2 _webPositionCallback = glm::ivec2(0);
#ifdef WIN32
    std::unique_ptr<Win32TouchHook> _win32TouchHook;
#endif //WIN32
    bool _tap = false;
};

} // namespace openspace

#endif // __OPENSPACE_MODULE_TOUCH___TOUCHMODULE___H__