Plugin.h

Go to the documentation of this file.

// Gmsh - Copyright (C) 1997-2022 C. Geuzaine, J.-F. Remacle
//
// See the LICENSE.txt file in the Gmsh root directory for license information.
// Please report all issues on https://gitlab.onelab.info/gmsh/gmsh/issues.
 
#ifndef PLUGIN_H
#define PLUGIN_H
 
// To create a plugin:
// 1) Create a dynamic lib containing GMSH_RegisterPlugin();
// 2) When there is an unacceptable error in the plugin, just throw
//    this, the plugin manager will be able to catch the exception.
//  Some Plugins are default gmsh plugins and are insterted directly
//  in the executable. I think that it's a good way to start.
 
#include <string>
#include "Options.h"
#include "GmshMessage.h"
#include "PView.h"
#include "PViewDataList.h"
 
class PluginDialogBox;
class Vertex;
template <class scalar> class fullMatrix;
 
class GMSH_Plugin {
public:
  // 4 kinds of plugins
  typedef enum {
    GMSH_CAD_PLUGIN,
    GMSH_MESH_PLUGIN,
    GMSH_POST_PLUGIN,
    GMSH_SOLVER_PLUGIN
  } GMSH_PLUGIN_TYPE;
 
  // a dialog box for the user interface
  PluginDialogBox *dialogBox;
 
  // for internal use by PluginManager
  void *hlib;
 
  GMSH_Plugin() : dialogBox(nullptr), hlib(nullptr) {}
  virtual ~GMSH_Plugin() {}
 
  // return plugin type, name and info
  virtual GMSH_PLUGIN_TYPE getType() const = 0;
  virtual std::string getName() const = 0;
  virtual std::string getShortHelp() const = 0;
  virtual std::string getHelp() const = 0;
  virtual std::string getAuthor() const { return "C. Geuzaine, J.-F. Remacle"; }
  virtual std::string getCopyright() const
  {
    return "C. Geuzaine, J.-F. Remacle";
  }
 
  // when an error is thrown by the plugin, the plugin manager will
  // show the message and hopefully continue
  virtual void catchErrorMessage(char *errorMessage) const;
 
  // gmsh-style numeric options
  virtual int getNbOptions() const { return 0; }
  virtual StringXNumber *getOption(int iopt) { return nullptr; };
 
  // gmsh-style string options
  virtual int getNbOptionsStr() const { return 0; }
  virtual StringXString *getOptionStr(int iopt) { return nullptr; }
 
  // serialize plugin options into a string
  std::string serialize();
 
  // run the plugin
  virtual int run() = 0;
 
  // dynamic pointer to a drawing function
  static void setDrawFunction(void (*fct)(void *));
#ifndef SWIG
  static void (*draw)(void *);
#endif
};
 
// The base class for post-processing plugins. The user can either
// modify or duplicate a post-processing view
class GMSH_PostPlugin : public GMSH_Plugin {
public:
  inline GMSH_PLUGIN_TYPE getType() const
  {
    return GMSH_Plugin::GMSH_POST_PLUGIN;
  }
  // run the plugin
  virtual int run()
  {
    PView *v = execute(nullptr);
    if(v) return v->getTag();
    return 0;
  }
  // if the returned pointer is the same as the argument, then the
  // view is simply modified, else, a new view is added in the view
  // list
  virtual PView *execute(PView *) = 0;
  // excute on a remote dataset
  virtual PView *executeRemote(PView *);
  // get the view given an index and a default value (if index < 0 use
  // the default view if available; otherwise use the last view in the
  // list)
  virtual PView *getView(int index, PView *view);
  // get the data in list format
  virtual PViewDataList *getDataList(PView *view, bool showError = true);
  // get the the adapted data (i.e. linear, on refined mesh) if
  // available, otherwise get the original data
  virtual PViewData *getPossiblyAdaptiveData(PView *view);
  virtual void assignSpecificVisibility() const {}
  virtual bool geometricalFilter(fullMatrix<double> *) const { return true; }
};
 
// The base class for solver plugins. The idea is to be able to
// associate some properties to physical entities, so that we can
// interface gmsh with a solver (ABAQUS...), i.e., create the input
// file for the solver
class GMSH_SolverPlugin : public GMSH_Plugin {
public:
  inline GMSH_PLUGIN_TYPE getType() const
  {
    return GMSH_Plugin::GMSH_SOLVER_PLUGIN;
  }
  virtual int run() { return 0; }
  // popup dialog box
  virtual void popupPropertiesForPhysicalEntity(int dim) = 0;
  // add the given group to the solver data
  virtual void receiveNewPhysicalGroup(int dim, int id) = 0;
  // load the solver input file related to the gmsh geo file
  virtual void readSolverFile(const char *) = 0;
  // save the solver file
  virtual void writeSolverFile(const char *) const = 0;
  // enhance graphics for a giver geo point
  virtual bool GL_enhancePoint(Vertex *v) { return false; }
  // enhance graphics for a giver geo line
  virtual bool GL_enhanceLine(int CurveId, Vertex *v1, Vertex *v2)
  {
    return false;
  }
};
 
class GMSH_MeshPlugin : public GMSH_Plugin {
  inline GMSH_PLUGIN_TYPE getType() const
  {
    return GMSH_Plugin::GMSH_MESH_PLUGIN;
  }
  virtual int run() { return 0; }
};
 
#endif