contrib/bkgrnd2d/plugin.cpp

   1 /*
   2 Copyright (C) 1999-2007 id Software, Inc. and contributors.
   3 For a list of contributors, see the accompanying CONTRIBUTORS file.
   4
   5 This file is part of GtkRadiant.
   6
   7 GtkRadiant is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2 of the License, or
  10 (at your option) any later version.
  11
  12 GtkRadiant is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GtkRadiant; if not, write to the Free Software
  19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20 */
  21
  22 //
  23 // 2d background Plugin
  24 //
  25 // Code by reyalP aka Reed Mideke
  26 //
  27 // Based on
  28 //
  29
  30 /*
  31     Overview
  32     ========
  33         This little plugin allows you to display an image in the background of the
  34         gtkradiant XY window.
  35
  36     Version History
  37     ===============
  38
  39     v0.1
  40       - Initial version.
  41         v0.2
  42           - three views, dialog box, toolbar
  43     v0.25
  44       - tooltips, follow gtkradiant coding conventions
  45
  46     How ?
  47     -----
  48      - textures 'n widgets 'n stuff.
  49 */
  50
  51 //#include "plugin.h"
  52 //TODO we just poke the objects directly
  53 #include "bkgrnd2d.h"
  54 #include "dialog.h"
  55
  56 #define CMD_SEP "-"
  57 #define CMD_CONFIG "Configure..."
  58 #define CMD_ABOUT "About..."
  59 // =============================================================================
  60 // Globals
  61
  62 // function tables
  63 _QERFuncTable_1 g_FuncTable;
  64 _QERQglTable g_QglTable;
  65 _QERFileSystemTable g_FileSystemTable;
  66 _QEREntityTable g_EntityTable;
  67 _QERAppDataTable g_DataTable;
  68
  69 // for the file load dialog
  70 void *g_pMainWidget;
  71
  72 // =============================================================================
  73 // plugin implementation
  74
  75 static const char *PLUGIN_NAME = "2d window background plugin";
  76
  77 //backwards for some reason
  78 static const char *PLUGIN_COMMANDS = CMD_ABOUT ";"
  79                                      CMD_SEP ";"
  80                                                                                          CMD_CONFIG
  81                                      ;
  82
  83 static const char *PLUGIN_ABOUT = "2d window background v0.25\n\n"
  84                                   "By reyalP (hellsownpuppy@yahoo.com)";
  85
  86
  87
  88
  89 void DoBkgrndToggleXY();
  90 void DoBkgrndToggleXZ();
  91 void DoBkgrndToggleYZ();
  92
  93 #define NUM_TOOLBAR_BUTTONS 4
  94 struct toolbar_button_info_s
  95 {
  96         char *image;
  97         char *text;
  98         char *tip;
  99         void (*func)();
 100         IToolbarButton::EType type;
 101 };
 102
 103 struct toolbar_button_info_s toolbar_buttons[NUM_TOOLBAR_BUTTONS] =
 104 {
 105         {
 106                 "bkgrnd2d_xy_toggle.bmp",
 107                 "xy background",
 108     "Toggle xy background image",
 109                 DoBkgrndToggleXY,
 110                 IToolbarButton::eToggleButton
 111         },
 112         {
 113                 "bkgrnd2d_xz_toggle.bmp",
 114                 "xz background",
 115     "Toggle xz background image",
 116                 DoBkgrndToggleXZ,
 117                 IToolbarButton::eToggleButton
 118         },
 119         {
 120                 "bkgrnd2d_yz_toggle.bmp",
 121                 "yz background",
 122     "Toggle yz background image",
 123                 DoBkgrndToggleYZ,
 124                 IToolbarButton::eToggleButton
 125         },
 126         {
 127                 "bkgrnd2d_conf.bmp",
 128                 "Configure",
 129     "Configure background images",
 130                 ShowBackgroundDialog,
 131                 IToolbarButton::eButton
 132         },
 133 };
 134
 135 class Bkgrnd2dButton : public IToolbarButton
 136 {
 137 public:
 138   const toolbar_button_info_s *bi;
 139   virtual const char* getImage() const
 140   {
 141     return bi->image;
 142   }
 143   virtual const char* getText() const
 144   {
 145     return bi->text;
 146   }
 147   virtual const char* getTooltip() const
 148   {
 149     return bi->tip;
 150   }
 151   virtual void activate() const
 152   {
 153     bi->func();
 154     return ;
 155   }
 156   virtual EType getType() const
 157   {
 158     return bi->type;
 159   }
 160 };
 161
 162 Bkgrnd2dButton g_bkgrnd2dbuttons[NUM_TOOLBAR_BUTTONS];
 163
 164 unsigned int ToolbarButtonCount()
 165 {
 166   return NUM_TOOLBAR_BUTTONS;
 167 }
 168
 169 const IToolbarButton* GetToolbarButton(unsigned int index)
 170 {
 171   g_bkgrnd2dbuttons[index].bi = &toolbar_buttons[index];
 172   return &g_bkgrnd2dbuttons[index];
 173 }
 174
 175 extern "C" const char* QERPlug_Init (void *hApp, void* pMainWidget)
 176 {
 177   g_pMainWidget = pMainWidget;
 178
 179   InitBackgroundDialog();
 180   render.Register();
 181
 182 //TODO is it right ? is it wrong ? it works
 183 //TODO figure out supported image types
 184   GetFileTypeRegistry()->addType(FILETYPE_KEY, filetype_t("all files", "*.*"));
 185   GetFileTypeRegistry()->addType(FILETYPE_KEY, filetype_t("jpeg files", "*.jpg"));
 186   GetFileTypeRegistry()->addType(FILETYPE_KEY, filetype_t("targa files", "*.tga"));
 187   return (char *) PLUGIN_NAME;
 188 }
 189
 190 extern "C" const char* QERPlug_GetName ()
 191 {
 192   return (char *) PLUGIN_NAME;
 193 }
 194
 195 extern "C" const char* QERPlug_GetCommandList ()
 196 {
 197   return (char *) PLUGIN_COMMANDS;
 198 }
 199
 200 extern "C" void QERPlug_Dispatch (const char *p, vec3_t vMin, vec3_t vMax, bool bSingleBrush)
 201 {
 202   Sys_Printf (MSG_PREFIX "Command \"%s\"\n",p);
 203   if(!strcmp(p, CMD_ABOUT)) {
 204         g_FuncTable.m_pfnMessageBox(NULL, PLUGIN_ABOUT, "About", MB_OK, NULL);
 205   }
 206   else if(!strcmp(p,CMD_CONFIG)) {
 207         ShowBackgroundDialog();
 208   }
 209 }
 210
 211 //TODO these three suck
 212 void DoBkgrndToggleXY()
 213 {
 214   Sys_Printf (MSG_PREFIX "DoBkgrndToggleXY\n");
 215   // always toggle, since the buttons do
 216   backgroundXY.m_bActive = (backgroundXY.m_bActive) ? false:true;
 217   // if we don't have image or extents, and we activated,
 218   // bring up the dialog with the corresponding page
 219   // would be better to hide or grey out button, but we can't
 220   if(backgroundXY.m_bActive && !backgroundXY.Valid())
 221           ShowBackgroundDialogPG(0);
 222   else
 223           g_FuncTable.m_pfnSysUpdateWindows(W_XY);
 224 }
 225
 226 void DoBkgrndToggleXZ()
 227 {
 228   Sys_Printf (MSG_PREFIX "DoBkgrndToggleXZ\n");
 229   backgroundXZ.m_bActive = (backgroundXZ.m_bActive) ? false:true;
 230   if(backgroundXZ.m_bActive && !backgroundXZ.Valid())
 231           ShowBackgroundDialogPG(1);
 232   else
 233           g_FuncTable.m_pfnSysUpdateWindows(W_XY);
 234 }
 235
 236 void DoBkgrndToggleYZ()
 237 {
 238   Sys_Printf (MSG_PREFIX "DoBkgrndToggleYZ\n");
 239   backgroundYZ.m_bActive = (backgroundYZ.m_bActive) ? false:true;
 240   if(backgroundYZ.m_bActive && !backgroundYZ.Valid())
 241           ShowBackgroundDialogPG(2);
 242   else
 243           g_FuncTable.m_pfnSysUpdateWindows(W_XY);
 244 }
 245
 246 // =============================================================================
 247 // SYNAPSE
 248
 249 CSynapseServer* g_pSynapseServer = NULL;
 250 CSynapseClientBkgrnd2d g_SynapseClient;
 251
 252 #if __GNUC__ >= 4
 253 #pragma GCC visibility push(default)
 254 #endif
 255 extern "C" CSynapseClient* SYNAPSE_DLL_EXPORT Synapse_EnumerateInterfaces( const char *version, CSynapseServer *pServer ) {
 256 #if __GNUC__ >= 4
 257 #pragma GCC visibility pop
 258 #endif
 259   if (strcmp(version, SYNAPSE_VERSION))
 260   {
 261     Syn_Printf("ERROR: synapse API version mismatch: should be '" SYNAPSE_VERSION "', got '%s'\n", version);
 262     return NULL;
 263   }
 264   g_pSynapseServer = pServer;
 265   g_pSynapseServer->IncRef();
 266   Set_Syn_Printf(g_pSynapseServer->Get_Syn_Printf());
 267
 268   g_SynapseClient.AddAPI(TOOLBAR_MAJOR, BKGRND2D_MINOR, sizeof(_QERPlugToolbarTable));
 269   g_SynapseClient.AddAPI(PLUGIN_MAJOR, BKGRND2D_MINOR, sizeof( _QERPluginTable ) );
 270
 271   g_SynapseClient.AddAPI( RADIANT_MAJOR, NULL, sizeof( g_FuncTable ), SYN_REQUIRE, &g_FuncTable );
 272   g_SynapseClient.AddAPI( QGL_MAJOR, NULL, sizeof( g_QglTable ), SYN_REQUIRE, &g_QglTable );
 273 // TODO is this the right way to ask for 'whichever VFS we have loaded' ? Seems to work
 274 // for misc filename functions
 275   g_SynapseClient.AddAPI( VFS_MAJOR, "*", sizeof( g_FileSystemTable ), SYN_REQUIRE, &g_FileSystemTable );
 276 // get worldspawn
 277   g_SynapseClient.AddAPI( ENTITY_MAJOR, NULL, sizeof( g_EntityTable ), SYN_REQUIRE, &g_EntityTable );
 278 // selected brushes
 279   g_SynapseClient.AddAPI( DATA_MAJOR, NULL, sizeof( g_DataTable ), SYN_REQUIRE, &g_DataTable );
 280
 281   return &g_SynapseClient;
 282 }
 283
 284 bool CSynapseClientBkgrnd2d::RequestAPI(APIDescriptor_t *pAPI)
 285 {
 286   if (!strcmp(pAPI->major_name, PLUGIN_MAJOR))
 287   {
 288     _QERPluginTable* pTable= static_cast<_QERPluginTable*>(pAPI->mpTable);
 289
 290     pTable->m_pfnQERPlug_Init = QERPlug_Init;
 291     pTable->m_pfnQERPlug_GetName = QERPlug_GetName;
 292     pTable->m_pfnQERPlug_GetCommandList = QERPlug_GetCommandList;
 293     pTable->m_pfnQERPlug_Dispatch = QERPlug_Dispatch;
 294     return true;
 295   }
 296   if (!strcmp(pAPI->major_name, TOOLBAR_MAJOR))
 297   {
 298     _QERPlugToolbarTable* pTable= static_cast<_QERPlugToolbarTable*>(pAPI->mpTable);
 299
 300     pTable->m_pfnToolbarButtonCount = &ToolbarButtonCount;
 301     pTable->m_pfnGetToolbarButton = &GetToolbarButton;
 302     return true;
 303   }
 304
 305   Syn_Printf("ERROR: RequestAPI( '%s' ) not found in '%s'\n", pAPI->major_name, GetInfo());
 306   return false;
 307 }
 308
 309 #include "version.h"
 310
 311 const char* CSynapseClientBkgrnd2d::GetInfo()
 312 {
 313   return "2d Background plugin built " __DATE__ " " RADIANT_VERSION;
 314 }
 315
 316 const char* CSynapseClientBkgrnd2d::GetName()
 317 {
 318   return "bkgrnd2d";
 319 }
 320