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.
//
#ifndef MOUSEMODEPARAMS_H
#define MOUSEMODEPARAMS_H
 
#include <vector>
#include <map>
 
#include <vapor/ParamsBase.h>
 
class PARAMS_API MouseModeParams : public VAPoR::ParamsBase {
public:
    struct MouseMode {
        string             name;
        const char *const *icon;
    };
 
    //
    MouseModeParams(VAPoR::ParamsBase::StateSave *ssave);
 
    //
    MouseModeParams(VAPoR::ParamsBase::StateSave *ssave, VAPoR::XmlNode *node);
 
    virtual ~MouseModeParams();
 
    const char *const *GetIcon(string name) const
    {
        auto itr = _modes.cbegin();
        for (; itr != _modes.cend(); ++itr)
            if (itr->name == name) break;
        VAssert(itr != _modes.end());
        return itr->icon;
    }
 
    //
    string GetCurrentMouseMode() const { return GetValueString(_currentMouseModeTag, GetNavigateModeName()); }
 
    //
    void SetCurrentMouseMode(string name);
 
    int GetNumMouseModes() { return _modes.size(); }
 
    //
    vector<string> GetAllMouseModes()
    {
        vector<string> v;
        for (auto itr = _modes.cbegin(); itr != _modes.cend(); ++itr) { v.push_back(itr->name); }
        return (v);
    }
 
    // Get static string identifier for this params class
    //
    static string GetClassType() { return ("MouseModeParamsTag"); }
 
    static string GetNavigateModeName() { return ("Navigate"); }
 
    static string GetRegionModeName() { return ("Region"); }
 
private:
    static const string _currentMouseModeTag;
 
    vector<MouseMode> _modes;
 
    void _init();
    void _setUpDefault();
};
 
#endif    // MOUSEMODEPARAMS_H