2 Copyright (C) 1999-2007 id Software, Inc. and contributors.
3 For a list of contributors, see the accompanying CONTRIBUTORS file.
5 This file is part of GtkRadiant.
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.
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.
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
23 // 2d background Plugin
25 // Code by reyalP aka Reed Mideke
33 This little plugin allows you to display an image in the background of the
42 - three views, dialog box, toolbar
44 - tooltips, follow gtkradiant coding conventions
48 http://zerowing.idsoftware.com/bugzilla/show_bug.cgi?id=88
53 - textures 'n widgets 'n stuff.
57 //TODO we just poke the objects directly
62 #define CMD_CONFIG "Configure..."
63 #define CMD_ABOUT "About..."
64 // =============================================================================
68 _QERFuncTable_1 g_FuncTable;
69 _QERQglTable g_QglTable;
70 _QERFileSystemTable g_FileSystemTable;
71 _QEREntityTable g_EntityTable;
72 _QERAppDataTable g_DataTable;
74 // for the file load dialog
77 // =============================================================================
78 // plugin implementation
80 static const char *PLUGIN_NAME = "2d window background plugin";
82 //backwards for some reason
83 static const char *PLUGIN_COMMANDS = CMD_ABOUT ";"
88 static const char *PLUGIN_ABOUT = "2d window background v0.25\n\n"
89 "By reyalP (hellsownpuppy@yahoo.com)";
94 void DoBkgrndToggleXY();
95 void DoBkgrndToggleXZ();
96 void DoBkgrndToggleYZ();
98 #define NUM_TOOLBAR_BUTTONS 4
99 struct toolbar_button_info_s
105 IToolbarButton::EType type;
108 struct toolbar_button_info_s toolbar_buttons[NUM_TOOLBAR_BUTTONS] =
111 "bkgrnd2d_xy_toggle.bmp",
113 "Toggle xy background image",
115 IToolbarButton::eToggleButton
118 "bkgrnd2d_xz_toggle.bmp",
120 "Toggle xz background image",
122 IToolbarButton::eToggleButton
125 "bkgrnd2d_yz_toggle.bmp",
127 "Toggle yz background image",
129 IToolbarButton::eToggleButton
134 "Configure background images",
135 ShowBackgroundDialog,
136 IToolbarButton::eButton
140 class Bkgrnd2dButton : public IToolbarButton
143 const toolbar_button_info_s *bi;
144 virtual const char* getImage() const
148 virtual const char* getText() const
152 virtual const char* getTooltip() const
156 virtual void activate() const
161 virtual EType getType() const
167 Bkgrnd2dButton g_bkgrnd2dbuttons[NUM_TOOLBAR_BUTTONS];
169 unsigned int ToolbarButtonCount()
171 return NUM_TOOLBAR_BUTTONS;
174 const IToolbarButton* GetToolbarButton(unsigned int index)
176 g_bkgrnd2dbuttons[index].bi = &toolbar_buttons[index];
177 return &g_bkgrnd2dbuttons[index];
180 extern "C" const char* QERPlug_Init (void *hApp, void* pMainWidget)
182 g_pMainWidget = pMainWidget;
184 InitBackgroundDialog();
187 //TODO is it right ? is it wrong ? it works
188 //TODO figure out supported image types
189 GetFileTypeRegistry()->addType(FILETYPE_KEY, filetype_t("all files", "*.*"));
190 GetFileTypeRegistry()->addType(FILETYPE_KEY, filetype_t("jpeg files", "*.jpg"));
191 GetFileTypeRegistry()->addType(FILETYPE_KEY, filetype_t("targa files", "*.tga"));
192 return (char *) PLUGIN_NAME;
195 extern "C" const char* QERPlug_GetName ()
197 return (char *) PLUGIN_NAME;
200 extern "C" const char* QERPlug_GetCommandList ()
202 return (char *) PLUGIN_COMMANDS;
205 extern "C" void QERPlug_Dispatch (const char *p, vec3_t vMin, vec3_t vMax, bool bSingleBrush)
207 Sys_Printf (MSG_PREFIX "Command \"%s\"\n",p);
208 if(!strcmp(p, CMD_ABOUT)) {
209 g_FuncTable.m_pfnMessageBox(NULL, PLUGIN_ABOUT, "About", MB_OK, NULL);
211 else if(!strcmp(p,CMD_CONFIG)) {
212 ShowBackgroundDialog();
216 //TODO these three suck
217 void DoBkgrndToggleXY()
219 Sys_Printf (MSG_PREFIX "DoBkgrndToggleXY\n");
220 // always toggle, since the buttons do
221 backgroundXY.m_bActive = (backgroundXY.m_bActive) ? false:true;
222 // if we don't have image or extents, and we activated,
223 // bring up the dialog with the corresponding page
224 // would be better to hide or grey out button, but we can't
225 if(backgroundXY.m_bActive && !backgroundXY.Valid())
226 ShowBackgroundDialogPG(0);
228 g_FuncTable.m_pfnSysUpdateWindows(W_XY);
231 void DoBkgrndToggleXZ()
233 Sys_Printf (MSG_PREFIX "DoBkgrndToggleXZ\n");
234 backgroundXZ.m_bActive = (backgroundXZ.m_bActive) ? false:true;
235 if(backgroundXZ.m_bActive && !backgroundXZ.Valid())
236 ShowBackgroundDialogPG(1);
238 g_FuncTable.m_pfnSysUpdateWindows(W_XY);
241 void DoBkgrndToggleYZ()
243 Sys_Printf (MSG_PREFIX "DoBkgrndToggleYZ\n");
244 backgroundYZ.m_bActive = (backgroundYZ.m_bActive) ? false:true;
245 if(backgroundYZ.m_bActive && !backgroundYZ.Valid())
246 ShowBackgroundDialogPG(2);
248 g_FuncTable.m_pfnSysUpdateWindows(W_XY);
251 // =============================================================================
254 CSynapseServer* g_pSynapseServer = NULL;
255 CSynapseClientBkgrnd2d g_SynapseClient;
258 #pragma GCC visibility push(default)
260 extern "C" CSynapseClient* SYNAPSE_DLL_EXPORT Synapse_EnumerateInterfaces( const char *version, CSynapseServer *pServer ) {
262 #pragma GCC visibility pop
264 if (strcmp(version, SYNAPSE_VERSION))
266 Syn_Printf("ERROR: synapse API version mismatch: should be '" SYNAPSE_VERSION "', got '%s'\n", version);
269 g_pSynapseServer = pServer;
270 g_pSynapseServer->IncRef();
271 Set_Syn_Printf(g_pSynapseServer->Get_Syn_Printf());
273 g_SynapseClient.AddAPI(TOOLBAR_MAJOR, BKGRND2D_MINOR, sizeof(_QERPlugToolbarTable));
274 g_SynapseClient.AddAPI(PLUGIN_MAJOR, BKGRND2D_MINOR, sizeof( _QERPluginTable ) );
276 g_SynapseClient.AddAPI( RADIANT_MAJOR, NULL, sizeof( g_FuncTable ), SYN_REQUIRE, &g_FuncTable );
277 g_SynapseClient.AddAPI( QGL_MAJOR, NULL, sizeof( g_QglTable ), SYN_REQUIRE, &g_QglTable );
278 // TODO is this the right way to ask for 'whichever VFS we have loaded' ? Seems to work
279 // for misc filename functions
280 g_SynapseClient.AddAPI( VFS_MAJOR, "*", sizeof( g_FileSystemTable ), SYN_REQUIRE, &g_FileSystemTable );
282 g_SynapseClient.AddAPI( ENTITY_MAJOR, NULL, sizeof( g_EntityTable ), SYN_REQUIRE, &g_EntityTable );
284 g_SynapseClient.AddAPI( DATA_MAJOR, NULL, sizeof( g_DataTable ), SYN_REQUIRE, &g_DataTable );
286 return &g_SynapseClient;
289 bool CSynapseClientBkgrnd2d::RequestAPI(APIDescriptor_t *pAPI)
291 if (!strcmp(pAPI->major_name, PLUGIN_MAJOR))
293 _QERPluginTable* pTable= static_cast<_QERPluginTable*>(pAPI->mpTable);
295 pTable->m_pfnQERPlug_Init = QERPlug_Init;
296 pTable->m_pfnQERPlug_GetName = QERPlug_GetName;
297 pTable->m_pfnQERPlug_GetCommandList = QERPlug_GetCommandList;
298 pTable->m_pfnQERPlug_Dispatch = QERPlug_Dispatch;
301 if (!strcmp(pAPI->major_name, TOOLBAR_MAJOR))
303 _QERPlugToolbarTable* pTable= static_cast<_QERPlugToolbarTable*>(pAPI->mpTable);
305 pTable->m_pfnToolbarButtonCount = &ToolbarButtonCount;
306 pTable->m_pfnGetToolbarButton = &GetToolbarButton;
310 Syn_Printf("ERROR: RequestAPI( '%s' ) not found in '%s'\n", pAPI->major_name, GetInfo());
316 const char* CSynapseClientBkgrnd2d::GetInfo()
318 return "2d Background plugin built " __DATE__ " " RADIANT_VERSION;
321 const char* CSynapseClientBkgrnd2d::GetName()