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 "vapor/VAssert.h"
#include <QObject>
#include <QLineEdit>
#include <QSlider>
#include "vapor/ControlExecutive.h"
#include <vapor/GUIStateParams.h>
#include <vapor/SettingsParams.h>
#include <vapor/AnimationParams.h>
 
#ifdef WIN32
    // Annoying unreferenced formal parameter warning
    #pragma warning(disable : 4100)
#endif
 
class ColorbarSettings;
 
 
//
class EventRouter {
public:
    EventRouter(VAPoR::ControlExec *ce, string paramsType);
 
    virtual ~EventRouter() {}
 
    virtual VAPoR::ParamsBase *GetActiveParams() const;
 
    virtual void hookUpTab() {}
 
    virtual void GetWebHelp(std::vector<std::pair<string, string>> &help) const {}
 
    virtual void updateTab();
 
    virtual void confirmText();
 
    void SetTextChanged(bool on)
    {
#ifdef VAPOR3_0_0_ALPHA
        if (!_updatingTab) _textChangedFlag = on;
#endif
    }
 
    //
    virtual void captureMouseUp(){};
 
    virtual void captureMouseDown(int mouseNum) {}
 
    virtual void StartCursorMove();
 
    virtual void EndCursorMove();
 
    GUIStateParams *GetStateParams() const
    {
        VAssert(_controlExec != NULL);
        return ((GUIStateParams *)_controlExec->GetParamsMgr()->GetParams(GUIStateParams::GetClassType()));
    }
 
    AnimationParams *GetAnimationParams() const
    {
        VAssert(_controlExec != NULL);
        return ((AnimationParams *)_controlExec->GetParamsMgr()->GetParams(AnimationParams::GetClassType()));
    }
 
    size_t GetCurrentTimeStep() const { return GetCurrentTimeStep(_controlExec); }
 
    static size_t GetCurrentTimeStep(VAPoR::ControlExec *ce)
    {
        AnimationParams *aParams;
        aParams = (AnimationParams *)ce->GetParamsMgr()->GetParams(AnimationParams::GetClassType());
        VAssert(aParams);
 
        return (aParams->GetCurrentTimestep());
    }
 
    virtual string GetType() const = 0;
 
    virtual void LoadDataNotify(string dataSetName) {}
 
protected:
    EventRouter() {}
 
    virtual void _initializeTab() {}
 
    virtual void _updateTab() = 0;
 
    virtual void _confirmText(){};
 
    VAPoR::ControlExec *_controlExec;
    bool                _textChangedFlag;
 
protected:
    string _paramsType;
 
private:
    // paths to params that have been initialized
    std::vector<string> _initPaths;
};
#endif    // EVENTROUTER_H