mousemodeparams.h

Go to the documentation of this file.

//************************************************************************
//                                                                      *
//           Copyright (C)  1024                                        *
//     University Corporation for Atmospheric Research                  *
//           All Rights Reserved                                        *
//                                                                      *
//************************************************************************/
//
//  File:       mousemodeparams.h
//
//  Author:     Alan Norton
//          National Center for Atmospheric Research
//          PO 3000, Boulder, Colorado
//
//  Date:       April 2014
//
//  Description:    Defines the MouseModeParams class.
//      This Params class is global.  Specifies the current MouseMode.
//      Also has various static methods for controlling mouse modes 
//
#ifndef MOUSEMODEPARAMS_H
#define MOUSEMODEPARAMS_H


#include <vector>
#include <map>
#include <vapor/common.h>
#include "params.h"
#include <vapor/MyBase.h>


using namespace VetsUtil;

namespace VAPoR {


class PARAMS_API MouseModeParams : public BasicParams {
    
public: 

    MouseModeParams(XmlNode* parent, int winnum);

    virtual ~MouseModeParams();
    
    virtual void Validate(int type);
    virtual void restart();
    

    //Enum describes various built-in mouse modes:
    enum mouseModeType {
        unknownMode=1000,
        navigateMode=0,
        regionMode=1,
        probeMode=3,
        twoDDataMode=4,
        twoDImageMode=5,
        rakeMode=2,
        barbMode=6,
        isolineMode=7
    };
    static const char* const * GetIcon(int modeIndex){
        return _modeXMPIcon[modeIndex];
    }
    static ParamsBase* CreateDefaultInstance() {return new MouseModeParams(0, -1);}
    const std::string getShortName() {return _shortName;}

    //Static methods for controlling mouse modes
    static int RegisterMouseMode(std::string tag, int modeType, const char* modeName, const char* const xpmIcon[]);

    static int AddMouseMode(const std::string paramsTag, int manipType, const char* name);

    static int getModeManipType(int modeIndex){
        return _manipFromMode[modeIndex];
    }

    static std::string getModeTag(int modeIndex){
        return _paramsFromTag[modeIndex];
    }

    static int getModeFromParams(string tag){return _modeFromParams[tag];}

    static const string getModeName(int index) {return _modeName[index];}

    static void RegisterMouseModes();

    static mouseModeType  GetCurrentMouseMode(){
        return ((MouseModeParams*)Params::GetParamsInstance(_mouseModeParamsTag))->getCurrentMouseMode();
    }
    static void SetCurrentMouseMode(mouseModeType t){
        ((MouseModeParams*)Params::GetParamsInstance(_mouseModeParamsTag))->setCurrentMouseMode(t);
    }
    static int getNumMouseModes(){
        return _modeName.size();
    }
    

#ifndef DOXYGEN_SKIP_THIS
    
    static const string _mouseModeParamsTag;

private:
    int setCurrentMouseMode(int mode){
        return SetValueLong(_mouseModeTag, "Set mouse mode",(long)mode);
    }
    mouseModeType getCurrentMouseMode(){
        return (mouseModeType)GetValueLong(_mouseModeTag);
    }
    static const string _shortName;
    static const string _mouseModeTag;
    //Mouse Mode tables.  Static
    
    static vector<string> _paramsFromTag;
    static map<string, int> _modeFromParams;
    static vector<int> _manipFromMode;
    static vector<string> _modeName;
    static map<int,const char* const *> _modeXMPIcon;
    
    
#endif //DOXYGEN_SKIP_THIS
};

};
#endif //MOUSEMODEPARAMS_H