contrib/meshtex/PluginModule.h

   1 /**
   2  * @file PluginModule.h
   3  * Declares the PluginModule class.
   4  * @ingroup generic-plugin
   5  */
   6
   7 /*
   8  * Copyright 2012 Joel Baxter
   9  *
  10  * This file is part of MeshTex.
  11  *
  12  * MeshTex is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation, either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * MeshTex is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with MeshTex.  If not, see <http://www.gnu.org/licenses/>.
  24  */
  25
  26 #if !defined(INCLUDED_PLUGINMODULE_H)
  27 #define INCLUDED_PLUGINMODULE_H
  28
  29 #include "PluginProperties.h"
  30
  31 #include "iplugin.h"
  32 #include "typesystem.h"
  33 #include "qerplugin.h"
  34
  35 /**
  36  * A singleton object that handles registering as a plugin with Radiant.
  37  *
  38  * @ingroup generic-plugin
  39  */
  40 class PluginModule : public TypeSystemRef
  41 {
  42 public: // public types
  43
  44    /// @cond DOXYGEN_INTERNAL_RADIANT_ODDITIES_SKIP
  45
  46    /**
  47     * Prepare for uses of the token Type in singletonmodule.h; indicate
  48     * that _QERPluginTable should be substituted there.
  49     */
  50    typedef _QERPluginTable Type;
  51
  52    /**
  53     * Radiant constant wrapper for the plugin's name string.
  54     */
  55    STRING_CONSTANT(Name, PLUGIN_NAME);
  56
  57    /// @endcond
  58
  59 public: // public methods
  60
  61    /// @name Lifecycle
  62    //@{
  63    PluginModule();
  64    ~PluginModule();
  65    //@}
  66    /// @name Plugin function table interface
  67    //@{
  68    _QERPluginTable *getTable();
  69    //@}
  70    /// @name Plugin function table members
  71    //@{
  72    static const char *QERPluginInit(void *hApp,
  73                                     void *pMainWidget);
  74    static const char *QERPluginGetName();
  75    static const char *QERPluginGetCommandList();
  76    static const char *QERPluginGetCommandTitleList();
  77    static void QERPluginDispatch(const char *command,
  78                                  float *vMin,
  79                                  float *vMax,
  80                                  bool bSingleBrush);
  81    //@}
  82
  83 private: // private member vars
  84
  85    static _QERPluginTable _pluginAPI;
  86 };
  87
  88 #endif // #if !defined(INCLUDED_PLUGINMODULE_H)