RenderEventRouter.h

Go to the documentation of this file.

//************************************************************************
//                                  *
//           Copyright (C)  2017                *
//     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 RenderEventRouter class
//      This (pure virtual) class manages communication between
//      renderer gui elements, visualizers, and params.
 
#ifndef RENDEREREVENTROUTER_H
#define RENDEREREVENTROUTER_H
 
#include "EventRouter.h"
#include "Flags.h"
 
namespace VAPoR {
class ControlExec;
class RenderParams;
class ParamsMgr;
}    // namespace VAPoR
 
#ifdef WIN32
     // Annoying unreferenced formal parameter warning
    #pragma warning(disable : 4100)
#endif
 
class ColorbarWidget;
 
 
//
class RenderEventRouter : public EventRouter {
public:
    RenderEventRouter(VAPoR::ControlExec *ce, string paramsType) : EventRouter(ce, paramsType) { _instName = ""; }
 
    virtual ~RenderEventRouter() {}
 
    void SetActive(string instName) { _instName = instName; }
 
    virtual void hookUpTab() {}
 
    virtual void updateTab();
 
    virtual void confirmText() { EventRouter::confirmText(); }
 
    virtual bool Supports2DVariables() const = 0;
 
    virtual bool Supports3DVariables() const = 0;
 
    virtual bool SupportsParticleVariables() const { return false; };
 
    //
    void updateRenderer(VAPoR::RenderParams *rParams, bool prevEnabled, string VizName, string renderInstName, bool newWindow);
 
    //
    virtual void sessionLoadTF(string name) {}
 
#ifdef VAPOR3_0_0_ALPHA
    //
    virtual void UpdateMapBounds() {}
#endif
 
    virtual void fitToView() {}
 
    virtual ColorbarWidget *getColorbarWidget() { return NULL; }
 
    virtual void variableChanged() {}
 
#ifdef VAPOR3_0_0_ALPHA
    virtual float CalcCurrentValue(const double point[3]);
#endif
 
    VAPoR::RenderParams *GetActiveParams() const;
 
    VAPoR::DataMgr *GetActiveDataMgr() const;
 
    string GetDescription() const { return (_getDescription()); }
 
    string GetSmallIconImagePath() const;
    string GetIconImagePath() const;
 
protected:
    RenderEventRouter() {}
 
    virtual void _updateTab() = 0;
 
    virtual void _confirmText(){};
 
    virtual string _getDescription() const = 0;
 
    virtual string _getSmallIconImagePath() const = 0;
 
    virtual string _getIconImagePath() const = 0;
 
private:
    string _instName;
};
 
 
//
// RenderEventRouterFactory Class
//
 
class RenderEventRouterFactory {
public:
    static RenderEventRouterFactory *Instance()
    {
        static RenderEventRouterFactory instance;
        return &instance;
    }
 
    void RegisterFactoryFunction(string name, function<RenderEventRouter *(QWidget *, VAPoR::ControlExec *)> classFactoryFunction)
    {
        // register the class factory function
        _factoryFunctionRegistry[name] = classFactoryFunction;
    }
 
    RenderEventRouter *(CreateInstance(string classType, QWidget *, VAPoR::ControlExec *));
 
    vector<string> GetFactoryNames() const;
 
private:
    map<string, function<RenderEventRouter *(QWidget *, VAPoR::ControlExec *)>> _factoryFunctionRegistry;
 
    RenderEventRouterFactory() {}
    RenderEventRouterFactory(const RenderEventRouterFactory &) {}
    RenderEventRouterFactory &operator=(const RenderEventRouterFactory &) { return *this; }
};
 
//
// RenderEventRouterRegistrar Class
//
// Register RenderEventRouter derived class with:
//
//  static RenderEventRouterRegistrar<RERClass> registrar("myclassname");
//
// where 'RERClass' is a class derived from 'RenderEventRouter', and
// "myclassname" is the name of the class
//
 
template<class T> class RenderEventRouterRegistrar {
public:
    RenderEventRouterRegistrar(string classType)
    {
        // register the class factory function
        //
        RenderEventRouterFactory::Instance()->RegisterFactoryFunction(classType, [](QWidget *parent, VAPoR::ControlExec *ce) -> RenderEventRouter * { return new T(parent, ce); });
    }
};
 
#endif    // RENDEREREVENTROUTER_H