eventrouter.h

Go to the documentation of this file.

//************************************************************************
//                                                                      *
//           Copyright (C)  2006                                        *
//     University Corporation for Atmospheric Research                  *
//           All Rights Reserved                                        *
//                                                                      *
//************************************************************************/
//                  
//  File:       eventrouter.h
//
//  Author:     Alan Norton
//          National Center for Atmospheric Research
//          PO 3000, Boulder, Colorado
//
//  Date:       May 2006
//
//  Description:  Definition of EventRouter class   
//      This (pure virtual) class manages communication between
//      gui elements, visualizers, and params.

#ifndef EVENTROUTER_H
#define EVENTROUTER_H
#include "assert.h"
#include "params.h"
#include "vizwin.h"
#include <qobject.h>
#include "vapor/ControlExecutive.h"

class QWidget;
class QHBoxLayout;
class QGroupBox;
class QComboBox;
class QButtonGroup;
class MappingFrame;

#ifdef WIN32
//Annoying unreferenced formal parameter warning
#pragma warning( disable : 4100)
#endif

namespace VAPoR{
class Histo;

//
class EventRouter
{
    
public:
    EventRouter(){
    
        _currentHistogram = 0;
        _updatingTab = false;
        _textChangedFlag=false;
    }
    virtual void hookUpTab() = 0;

    void updateTab();

    virtual void confirmText();

    void reinitTab(bool doOverride);

    virtual void updateUrgentTabState() {return;}

    void SetTextChanged(bool on) {if(!_updatingTab) _textChangedFlag = on;}

    virtual void captureMouseUp() {assert(0);}

    virtual void captureMouseDown(int mouseNum) {assert(0);}

    string getTag() {
        return _paramsTag;
    }
    
    virtual void updateRenderer(RenderParams* rp, bool wasEnabled, int instance, bool newVis);
    
    virtual void cleanParams(Params* rp ) {}
    
    virtual void sessionLoadTF(string name ) {assert(0);}

    virtual void SetLocal(Params* p, bool lg);
    
    virtual void SetEnabled(bool On, int instance );

    virtual void setEditorDirty(RenderParams*);

    virtual void updateMapBounds(RenderParams*) {assert (0);}

    void saveTF(RenderParams* rParams);

    void fileSaveTF(RenderParams* rParams);

    void loadInstalledTF(RenderParams* rParams, string varname);

    void loadTF(RenderParams* rParams, string varname);

    void fileLoadTF(RenderParams* rParams, string varname, const char* startPath, bool savePath);

    virtual Histo* getHistogram(RenderParams* rParam, bool mustGet, bool isIsoWin = false);

    virtual void refreshHistogram(RenderParams* rp){}

    void refresh2DHistogram(RenderParams*);

    void calcSliceHistogram(RenderParams* rp, int ts, Histo* histo);

    virtual MappingFrame* getMappingFrame() {return NULL;}

    virtual void StartCursorMove();

    virtual void EndCursorMove();

    virtual void SetDimension(int dim) {}

    virtual void variableChanged() {} 

    static void SetVizWinMgr(VizWinMgr* vizMgr) {_vizMgr = vizMgr;}

    static void SetDataMgr(DataMgrV3_0* dataMgr) {_dataMgr = dataMgr;}

    static void SetMainForm(MainForm* mainForm) {_mainForm = mainForm;}

    static DataMgrV3_0* GetDataMgr() { return _dataMgr;}
    
    virtual void invalidateRenderer(RenderParams* rParams) {return;}

protected:
    
    virtual void _updateTab(Params* p) = 0;

    virtual void _confirmText(Params* p) = 0;

    virtual void _reinitTab(bool doOverride) = 0;
    
    vector<QAction*>* makeWebHelpActions(const char* text[], const char* urls[]);

    static EventRouter* GetEventRouter(const std::string& tag){
        return VizWinMgr::getEventRouter(tag);
    }

    virtual float calcCurrentValue(RenderParams* p, const double point[3]);

    Params* GetActiveParams(){
        return ControlExec::GetActiveParams(_paramsTag);
    }
    Params* GetActiveParams(string tag){
        return ControlExec::GetActiveParams(tag);
    }

    int GetActiveVizIndex() {return ControlExec::GetActiveVizIndex();}

    void ForceRender(bool always = false) {
        _vizMgr->forceRender(GetActiveParams(), always);
    }


    Visualizer* GetActiveVisualizer(){
        return ControlExec::GetVisualizer(GetActiveVizIndex());

    }


#ifndef DOXYGEN_SKIP_THIS
    
    vector<QAction*>* _webHelpActions;
    
    Histo* _currentHistogram;
    string _paramsTag;
    static DataMgrV3_0* _dataMgr;
    
    static MainForm* _mainForm;
    bool _textChangedFlag;
    static float _OUT_OF_BOUNDS;
    
private:
    static VizWinMgr* _vizMgr;
    bool _updatingTab;
#endif //DOXYGEN_SKIP_THIS
};
};
#endif // EVENTROUTER_H