KeyController.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
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.
 
Library: Design
File: KeyController
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/Event.h>
#include <NDEVR/SoftwareService.h>
#include <NDEVR/Dictionary.h>
#include <NDEVR/INIInterface.h>
#include <NDEVR/TranslatedString.h>
#include <NDEVR/UUID.h>
#include <functional>
namespace NDEVR
{
    class DesignObjectLookup;
    class Camera;
 
    /**--------------------------------------------------------------------------------------------------
    \brief Base class for KeyController, a service which provides functionality based on user key-presses
    *-----------------------------------------------------------------------------------------------**/
    class KeyControllerBase : public SoftwareService
    {
    public:
        virtual bool processKeyEvent(const KeyEvent& key_event, DesignObjectLookup* lookup, Camera* camera) = 0;
    };
 
    /**--------------------------------------------------------------------------------------------------
    \brief An action that can be tied to a specific KeyPress within the software.
    *-----------------------------------------------------------------------------------------------**/
    struct KeyOption
    {
        String id;
        TranslatedString display_name;
        KeyEvent key_event;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief The core class for assigning actions to key-presses and registering them as a program-wide service
    *-----------------------------------------------------------------------------------------------**/
    class BasicKeyController : public KeyControllerBase, public INIInterface
    {
    public:
        NDEVR_BASE_API BasicKeyController(const TranslatedString& key_controller_title);
        NDEVR_BASE_API bool processKeyEvent(const KeyEvent& key_event, DesignObjectLookup* lookup, Camera* camera) final override;
        NDEVR_BASE_API virtual bool processKeyEvent(const String& id, const KeyEvent& key_event, DesignObjectLookup* lookup, Camera* camera) = 0;
        NDEVR_BASE_API virtual void resetKeyControllerToDefaults() = 0;
        NDEVR_BASE_API const TranslatedString& keyControllerTitle() const { return m_key_controller_title; };
        NDEVR_BASE_API const Buffer<KeyOption>& currentKeyMaps() const { return m_key_options; };
        NDEVR_BASE_API virtual void setKeyOption(const KeyOption& option);
        NDEVR_BASE_API virtual void getINI(INIFactory& factory) override;
        NDEVR_BASE_API virtual void addKeyOption(const KeyOption& option);
    protected:
        bool m_save_ini_on_change_key_option_change = false;
        Buffer<KeyOption> m_key_options;
        TranslatedString m_key_controller_title;
    };
 
    /**--------------------------------------------------------------------------------------------------
    \brief A high-level controller that stores many sub controllers that can be used to modify behaviors
        on user key-presses
    *-----------------------------------------------------------------------------------------------**/
    class KeyController : public KeyControllerBase, public SoftwareServiceManager
    {
    public:
        NDEVR_BASE_API KeyController();
        NDEVR_BASE_API virtual ~KeyController(){}
        NDEVR_BASE_API void addController(UUID id, KeyControllerBase* controller);
        NDEVR_BASE_API void removeController(UUID id);
        NDEVR_BASE_API Buffer<KeyControllerBase*> controllers() const;
        NDEVR_BASE_API bool hasController(UUID id) const;
        NDEVR_BASE_API bool processKeyEvent(const KeyEvent& event, DesignObjectLookup* lookup, Camera* camera) override;
        //void addHotKey(KeyEvent key, std::function<bool(const KeyEvent& key_event, DesignObjectLookup* lookup, Camera* camera)> action);
        //void addRemoveHotKey(const KeyEvent& key);
        NDEVR_BASE_API static KeyController& DefaultKeyController();
    private:
        Buffer<KeyControllerBase*> m_controllers;
        Dictionary<UUID, KeyControllerBase*> m_controller_lookup;
    };
};//End namespace NDEVR