VuoNodeLibrary.hh

Go to the documentation of this file.

 
#pragma once
 
#include "VuoHeap.h"
 
class VuoCompiler;
class VuoCompilerNodeClass;
class VuoEditorComposition;
class VuoNodeClass;
class VuoNodePopover;
 
namespace Ui
{
    class VuoNodeLibrary;
}
 
class VuoNodeLibrary : public QDockWidget
{
    Q_OBJECT
 
public:
    enum nodeLibraryDisplayMode
    {
        displayByClass,
        displayByName
    };
 
    enum nodeLibraryState
    {
        nodeLibraryHidden,
        nodeLibraryDocked,
        nodeLibraryFloating
    };
 
    explicit VuoNodeLibrary(VuoCompiler *compiler, QWidget *parent = 0,
                            VuoNodeLibrary::nodeLibraryDisplayMode displayMode = VuoNodeLibrary::displayByClass);
    void setCompiler(VuoCompiler *compiler);
    static void cullHiddenNodeClasses(vector<VuoCompilerNodeClass *> &nodeClasses);
    void prepareAndMakeVisible();
    void fixWidth(bool fix);
    void displayPopoverForCurrentNodeClass();
    bool eventFilter(QObject *object, QEvent *event) VuoWarnUnusedResult;
    ~VuoNodeLibrary();
    static QStringList tokenizeNodeName(QString nodeName, QString className);
    static bool isStopWord(QString word);
    bool getHumanReadable();
    void focusTextFilter();
    void searchForText(QString text);
    void getState(QString &filterText, set<string> &selectedNodeClasses, string &documentedNodeClass);
    void setState(QString filterText, set<string> selectedNodeClasses, string documentedNodeClass);
    QString getSelectedDocumentationText();
    void emitNodeLibraryHiddenOrUnhidden(bool unhidden);
    void releaseDocumentationWidget();
    void clearNodeClassList();
    void updateNodeClassList(const vector<string> &nodeClassesToRemove, const vector<VuoCompilerNodeClass *> &nodeClassesToAdd);
    void highlightNodeClass(string targetNodeClassName, bool highlightAsNewlyInstalled=true, bool resetPreviousSelection=true);
    void prepareAndDisplayNodePopoverForClass(string nodeClassName);
 
signals:
    void componentsAdded(QList<QGraphicsItem *> addedComponents, VuoEditorComposition *target); 
    void changedIsHumanReadable(bool humanReadable); 
    void nodeLibraryHiddenOrUnhidden(bool unhidden); 
    void nodeLibraryReceivedPasteCommand(); 
    void nodeLibraryMoved(QPoint newPos); 
    void nodeLibraryWidthChanged(int); 
    void nodeLibraryHeightChanged(int); 
    void nodeDocumentationPanelWidthChanged(int); 
    void nodeDocumentationPanelHeightChanged(int); 
    void documentationSelectionChanged(); 
    void aboutToBeDestroyed(); 
 
public slots:
    void clickedNamesButton();
    void clickedFlatClassButton();
    void setHumanReadable(bool humanReadable);
    void prepareAndDisplayNodePopoverForClass(VuoNodeClass *nodeClass);
    void displayPopoverInPane(QWidget *panelContentWidget, QString resourceDir="");
    void updateUI();
 
protected:
    void moveEvent(QMoveEvent *event);
    void resizeEvent(QResizeEvent *event);
    void showEvent(QShowEvent *event);
    void closeEvent(QCloseEvent *event);
    void keyPressEvent(QKeyEvent *event);
 
private slots:
    void updateListViewForNewFilterTextOnTimer();
    void updateListViewForNewFilterTextNow();
    void emitNodeDocumentationPanelHeightChanged();
    void updateColor(bool isDark);
 
private:
    friend class TestVuoEditor;
 
    Ui::VuoNodeLibrary *ui;
    VuoCompiler *compiler;
    vector<VuoCompilerNodeClass *> loadedNodeClasses;
    static map<VuoCompilerNodeClass *, int> newlyInstalledNodeClasses;
    map<string, VuoNodePopover *> popoverForNodeClass;
    map<string, string> capitalizationForNodeClass;
    static map<pair<QString, QString>, QStringList> tokensForNodeClass;
    static map<string, int> nodeClassFrequency;
    static set<string> stopWords;
    int preferredNodeDocumentationPanelHeight;
    int preferredNodeLibraryWidth;
    bool hasBeenShown;
    int defaultMinimumWidth;
    int defaultMaximumWidth;
    QTimer *updateListViewTimer;
 
    void populateList(vector<VuoCompilerNodeClass *> nodeClasses, bool resetSelection);
    static bool nodeHasPortMatchingString(VuoCompilerNodeClass *cnc, string needle, bool isInput);
    static bool nodeHasSourceType(VuoCompilerNodeClass *cnc, string sourceType);
    void updateListView(bool resetSelection);
    vector<VuoCompilerNodeClass *> getMatchingNodeClassesForSearchTerms(QStringList rawTermList);
    void updateListViewForNewDisplayMode();
    VuoNodePopover * initializeNodePopoverForClass(VuoNodeClass *nodeClass, VuoCompiler *compiler);
    VuoNodePopover * getNodePopoverForClass(VuoNodeClass *nodeClass, VuoCompiler *compiler);
    void updateSplitterPosition();
    static bool nodeClassLessThan(VuoCompilerNodeClass *nodeClass1, VuoCompilerNodeClass *nodeClass2);
    QStringList applyFilterTransformations(QStringList filterTokenList);
    void populateNodeClassFrequencyMap();
    void populateStopWordList();
    void recordNodeClassCapitalizations();
    void releaseNodePopovers();
 
#ifdef VUO_PRO
#include "pro/VuoNodeLibrary_Pro.hh"
#endif
};