ControlEditor.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2017  Thales Lima Oliveira <thales@ufu.br>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef CONTROLEDITOR_H
#define CONTROLEDITOR_H
 
 
#include "ControlEditorBase.h"
 
#include <wx/wrapsizer.h>
#include <wx/dcclient.h>
#include <wx/dcscreen.h>
#include <wx/graphics.h>
#include <wx/progdlg.h>
 
#ifdef _MSC_VER
 //#include <windows.h>
#endif 
 
#include "../elements/controlElement/IOControl.h"
#include "../utils/PropertiesData.h"
#include "ControlSystemTest.h"
 
#include <unordered_set>
 
class FileHanding;
class Camera;
class Element;
class ControlElement;
class TransferFunction;
class ConnectionLine;
class Sum;
class Multiplier;
class Limiter;
class RateLimiter;
class Exponential;
class Constant;
class Gain;
class MathOperation;
class Divider;
class MathExpression;
 
class ControlElementSolver;
class ControlElementContainer;
 
class ChartView;
class ElementDataObject;
class ControlElementDataObject;
 
class ControlEditorManager;
 
enum class ControlElementButtonID : int {
    ID_IO = 0,
    ID_TF,
    ID_SUM,
    ID_CONST,
    ID_LIMITER,
    ID_GAIN,
    ID_MULT,
    ID_EXP,
    ID_RATELIM,
    ID_MATH_DIV,
    ID_MATH_EXPR
};
 
class ControlElementButton : public wxWindow
{
public:
    ControlElementButton(wxWindow* parent, wxString label, wxImage image, wxWindowID id, GUIColour* guiColour);
    ControlElementButton(wxWindow* parent, wxString label, std::unique_ptr<ControlElement> iconElement, wxWindowID id, GUIColour* guiColour, double buttonScale = 1.0);
    ~ControlElementButton();
 
protected:
    virtual void OnPaint(wxPaintEvent& event);
    virtual void OnMouseEnter(wxMouseEvent& event);
    virtual void OnMouseLeave(wxMouseEvent& event);
    virtual void OnLeftClickDown(wxMouseEvent& event);
    virtual void OnLeftClickUp(wxMouseEvent& event);
 
    GUIColour* m_guiColour = nullptr;
 
    std::unique_ptr<ControlElement> m_iconElement;
 
    wxString m_label;
    wxFont m_buttonFont;
    double m_buttonScale = 1.0;
    wxPoint m_labelPosition;
 
    wxImage m_image;
    wxSize m_imageSize;
    wxPoint m_imagePosition;
 
    int m_borderSize = 2;
    bool m_mouseAbove = false;
    bool m_selected = false;
 
    wxSize m_buttonSize;
};
 
class ControlEditor : public ControlEditorBase
{
public:
    enum class ControlEditorMode : int {
        MODE_EDIT = 0,
        MODE_MOVE_ELEMENT,
        MODE_MOVE_LINE,
        MODE_DRAG,
        MODE_DRAG_INSERT,
        MODE_INSERT,
        MODE_INSERT_LINE,
        MODE_SELECTION_RECT,
        MODE_PASTE,
        MODE_DRAG_PASTE
    };
    ControlEditor(wxWindow* parent, PropertiesData* properties) : ControlEditorBase(parent), m_properties(properties) {}
    ControlEditor(wxWindow* parent, PropertiesData* properties,
        int ioflags = IOControl::IN_TERMINAL_VOLTAGE | IOControl::IN_VELOCITY | IOControl::OUT_FIELD_VOLTAGE |
        IOControl::OUT_MEC_POWER);
    virtual ~ControlEditor();
 
    virtual void AddElement(ControlElementButtonID id);
    //virtual void Redraw() { m_glCanvas->Refresh(); }
    virtual void Redraw() { m_cePanel->Refresh(); }
    virtual void SetJustOpened(bool justOpened) { m_justOpened = justOpened; }
    virtual void RotateSelectedElements(bool clockwise);
    virtual void DeleteSelectedElements();
    virtual void CheckConnections();
    virtual std::vector< std::shared_ptr<ConnectionLine> > GetConnectionLineList() const { return m_connectionList; }
    virtual std::vector< std::shared_ptr<ControlElement> >  GetControlElementList() const { return m_elementList; }
    virtual void SetElementsList(const std::vector< std::shared_ptr<ControlElement> >& elementList);
    virtual void SetConnectionsList(const std::vector< std::shared_ptr<ConnectionLine> >& connectionList) { m_connectionList = connectionList; }
    virtual void SetControlContainer(ControlElementContainer* ctrlContainer) { m_ctrlContainer = ctrlContainer; }
    virtual ControlElementContainer* GetControlContainer() { return m_ctrlContainer; }
    virtual void SetPlotLib(int plotLib) { m_plotLib = plotLib; }
    virtual void SetManager(ControlEditorManager* manager) { m_ctrlManager = manager; }
    virtual std::vector<Element*> GetElementList() const;
    virtual void Fit();
 
    virtual void OnClose(wxCloseEvent& event);
    virtual void OnTestClick(wxCommandEvent& event);
    virtual void OnButtonOKClick(wxCommandEvent& event) { Close(); }
    virtual void OnImportClick(wxCommandEvent& event);
    virtual void OnExportClick(wxCommandEvent& event);
    virtual void OnKeyDown(wxKeyEvent& event);
    virtual void OnIdle(wxIdleEvent& event);
    virtual void OnScroll(wxMouseEvent& event);
    virtual void OnDoubleClick(wxMouseEvent& event);
    virtual void OnLeftClickDown(wxMouseEvent& event);
    virtual void OnLeftClickUp(wxMouseEvent& event);
    virtual void OnMiddleDown(wxMouseEvent& event);
    virtual void OnMiddleUp(wxMouseEvent& event);
    virtual void OnMouseMotion(wxMouseEvent& event);
    virtual void OnPaint(wxPaintEvent& event);
    virtual void LeftClickDown(wxMouseEvent& event);
 
    virtual void BuildColourList();
    virtual wxColour GetNextColour();
 
    void BuildControlElementPanel();
 
protected:
    virtual void OnMiddleDoubleClick(wxMouseEvent& event);
    virtual void OnFitClick(wxCommandEvent& event);
    virtual void OnCopyClick(wxCommandEvent& event);
    virtual void OnDeleteClick(wxCommandEvent& event);
    virtual void OnDragClick(wxCommandEvent& event);
    virtual void OnMoveClick(wxCommandEvent& event);
    virtual void OnNewClick(wxCommandEvent& event);
    virtual void OnPasteClick(wxCommandEvent& event);
    virtual void OnRedoClick(wxCommandEvent& event);
    virtual void OnUndoClick(wxCommandEvent& event);
    //void SetViewport();
    int GetNextID();
 
    std::vector< std::shared_ptr<ConnectionLine> >::iterator DeleteLineFromList(std::vector< std::shared_ptr<ConnectionLine> >::iterator& it);
 
    // ---------------------------------------------------------------------
    // Clipboard + Undo/Redo helpers (mirrors Workspace patterns)
    // ---------------------------------------------------------------------
    void UnselectAll();
    void CopySelectionToClipboard();
    bool PasteFromClipboard();
 
    void SaveCurrentState();
    void SetPreviousState();
    void SetNextState();
    void ClearStates();
 
    bool GetElementsCorners(wxPoint2DDouble& leftUpCorner,
        wxPoint2DDouble& rightDownCorner,
        const std::vector<Element*>& elementList) const;
 
    void ApplyFontToElements();
    wxPoint GetEditorMouseClientPoint() const;
    wxPoint2DDouble GetEditorMouseWorldPoint() const;
 
    Camera* m_camera = nullptr;
 
    PropertiesData* m_properties = nullptr;
    wxFont m_font;
 
    ControlEditorMode m_mode = ControlEditorMode::MODE_EDIT;
 
    wxRect2DDouble m_selectionRect;
    wxPoint2DDouble m_startSelRect;
 
    //std::vector<ControlElement*> m_elementList;
    std::vector< std::shared_ptr<ControlElement> > m_elementList;
    //std::vector<ConnectionLine*> m_connectionList;
    std::vector< std::shared_ptr<ConnectionLine> > m_connectionList;
 
    ControlElementContainer* m_ctrlContainer = nullptr;
    ControlEditorManager* m_ctrlManager = nullptr;
 
    bool m_justOpened = false;
    int m_ioFlags = 0;
 
    int m_inputType = 0;
    double m_startTime = 1.0;
    double m_slope = 1.0;
    double m_timeStep = 1e-4;
    double m_simTime = 10.0;
    int m_plotLib = 0;
 
    std::vector<wxColour> m_colourList;
    std::vector<wxColour>::iterator m_itColourList;
 
    // Undo / Redo state (deep copies of the whole control system)
    std::vector<std::vector<std::shared_ptr<ControlElement>>> m_elementListState;
    std::vector<std::vector<std::shared_ptr<ConnectionLine>>> m_connectionListState;
    int m_currentState = -1;
    int m_maxStates = 100;
};
#endif  // CONTROLEDITOR_H