instanceparams.h

Go to the documentation of this file.

//************************************************************************
//                                                                      *
//           Copyright (C)  2014                                        *
//     University Corporation for Atmospheric Research                  *
//           All Rights Reserved                                        *
//                                                                      *
//************************************************************************/
//
//  File:       instanceparams.h
//
//  Author:     Alan Norton
//          National Center for Atmospheric Research
//          PO 3000, Boulder, Colorado
//
//  Date:       April 2014
//
//  Description:    Defines the InstanceParams class.
//      This Params class is global.  Specifies the current instances associated with RenderParams.
//      Also has various static methods for obtaining and setting properties of the Instance Params
//      For each Params (tag) and each Visualizer (number), there is one or more instances
//      and one of the instances is the Current instance.
//      In addition, whenever a new instance is created or deleted, that new instance's paramnode is
//      saved in the InstanceParams, to facilitate undo/redo of creation and deletion.
//      The Paramnode in the Instance params is otherwise not changed
//      
//
#ifndef INSTANCEPARAMS_H
#define INSTANCEPARAMS_H


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


using namespace VetsUtil;

namespace VAPoR {



class PARAMS_API InstanceParams : public BasicParams {
    
public: 

    static int AddInstance(const std::string rendererName, int viznum, RenderParams* p);

    static int RemoveSelectedInstance(int viz);

    static int GetSelectedIndex(int viz){
        return ((InstanceParams*)Params::GetParamsInstance(_instanceParamsTag))->getSelectedIndex(viz);
    }
    static int GetSelectedInstance(int viz, int* pType, int* instance);

    static int SetSelectedIndex(int viz, int index){
        return ((InstanceParams*)Params::GetParamsInstance(_instanceParamsTag))->setSelectedIndex(viz, index);
    }
    static RenderParams* GetSelectedRenderParams(int viz);

    static RenderParams* GetRenderParamsInstance(int viz, int renIndex);
    
    static int GetNumInstances(int viz);


    InstanceParams(XmlNode* parent, int winnum);

    virtual ~InstanceParams();
    
    virtual void Validate(int type);
    virtual void restart();
    
    static int AddVizWin(int viznum){
        return (((InstanceParams*)Params::GetParamsInstance(_instanceParamsTag))->addVizWin(viznum));
    }
    static void UndoRedo(bool isUndo, int /*instance*/, Params* beforeP, Params* afterP, Params* auxBP=0, Params*auxAP=0);

    static int RemoveVizWin(int viznum);
    
    static ParamsBase* CreateDefaultInstance() {return new InstanceParams(0, -1);}
    const std::string getShortName() {return _shortName;}
    //Determine what visualizer has changed between prev and next InstanceParams, 
    //and whether it's Add(1), Remove(-1), or Select(0) change.
    static int changeType(InstanceParams* p1, InstanceParams* p2, int* viz, int* type);
    
    //Convert a visualizer index into a string name, to be used for ParamNode tag
    static ParamNode* getVizNode(int viz);
    //Renumber the renderer instances associated with a visualizer, needed after
    //a new instance is inserted or an existing instance is removed.
    //Return 0 if successful.
    static int renumberInstances(int viz, int changedType);
    

#ifndef DOXYGEN_SKIP_THIS
    
    static const string _instanceParamsTag;
    static const string _shortName;
    static const string _visualizersTag;
    
    static const string _renderParamsNodeTag;
    static const string _instanceInfoTag;
    static const string _selectionInfoTag;
    int getCurrentInstance(std::string tag, int viz);
private:
    
    ParamNode* getRenderParamsNode();
    void setRenderParamsNode(ParamNode* pnode);
    void removeRenderParamsNode(){
        GetRootNode()->GetNode(_renderParamsNodeTag)->DeleteAll();
    }

    int addVizWin(int viznum);
    
    int setSelectedIndex(int viz, int index);
    int getSelectedIndex(int viz);

    
#endif //DOXYGEN_SKIP_THIS
};

};
#endif //VIZWINPARAMS_H