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 - textures 'n widgets 'n stuff.
52 //TODO we just poke the objects directly
57 #define CMD_CONFIG "Configure..."
58 #define CMD_ABOUT "About..."
59 // =============================================================================
63 _QERFuncTable_1 g_FuncTable;
64 _QERQglTable g_QglTable;
65 _QERFileSystemTable g_FileSystemTable;
66 _QEREntityTable g_EntityTable;
67 _QERAppDataTable g_DataTable;
69 // for the file load dialog
72 // =============================================================================
73 // plugin implementation
75 static const char *PLUGIN_NAME = "2d window background plugin";
77 //backwards for some reason
78 static const char *PLUGIN_COMMANDS = CMD_ABOUT ";"
83 static const char *PLUGIN_ABOUT = "2d window background v0.25\n\n"
84 "By reyalP (hellsownpuppy@yahoo.com)";
89 void DoBkgrndToggleXY();
90 void DoBkgrndToggleXZ();
91 void DoBkgrndToggleYZ();
93 #define NUM_TOOLBAR_BUTTONS 4
94 struct toolbar_button_info_s
100 IToolbarButton::EType type;
103 struct toolbar_button_info_s toolbar_buttons[NUM_TOOLBAR_BUTTONS] =
106 "bkgrnd2d_xy_toggle.bmp",
108 "Toggle xy background image",
110 IToolbarButton::eToggleButton
113 "bkgrnd2d_xz_toggle.bmp",
115 "Toggle xz background image",
117 IToolbarButton::eToggleButton
120 "bkgrnd2d_yz_toggle.bmp",
122 "Toggle yz background image",
124 IToolbarButton::eToggleButton
129 "Configure background images",
130 ShowBackgroundDialog,
131 IToolbarButton::eButton
135 class Bkgrnd2dButton : public IToolbarButton
138 const toolbar_button_info_s *bi;
139 virtual const char* getImage() const {
142 virtual const char* getText() const {
145 virtual const char* getTooltip() const {
148 virtual void activate() const {
152 virtual EType getType() const {
157 Bkgrnd2dButton g_bkgrnd2dbuttons[NUM_TOOLBAR_BUTTONS];
159 unsigned int ToolbarButtonCount(){
160 return NUM_TOOLBAR_BUTTONS;
163 const IToolbarButton* GetToolbarButton( unsigned int index ){
164 g_bkgrnd2dbuttons[index].bi = &toolbar_buttons[index];
165 return &g_bkgrnd2dbuttons[index];
168 extern "C" const char* QERPlug_Init( void *hApp, void* pMainWidget ){
169 g_pMainWidget = pMainWidget;
171 InitBackgroundDialog();
174 //TODO is it right ? is it wrong ? it works
175 //TODO figure out supported image types
176 GetFileTypeRegistry()->addType( FILETYPE_KEY, filetype_t( "all files", "*.*" ) );
177 GetFileTypeRegistry()->addType( FILETYPE_KEY, filetype_t( "jpeg files", "*.jpg" ) );
178 GetFileTypeRegistry()->addType( FILETYPE_KEY, filetype_t( "targa files", "*.tga" ) );
179 return (char *) PLUGIN_NAME;
182 extern "C" const char* QERPlug_GetName(){
183 return (char *) PLUGIN_NAME;
186 extern "C" const char* QERPlug_GetCommandList(){
187 return (char *) PLUGIN_COMMANDS;
190 extern "C" void QERPlug_Dispatch( const char *p, vec3_t vMin, vec3_t vMax, bool bSingleBrush ){
191 Sys_Printf( MSG_PREFIX "Command \"%s\"\n",p );
192 if ( !strcmp( p, CMD_ABOUT ) ) {
193 g_FuncTable.m_pfnMessageBox( NULL, PLUGIN_ABOUT, "About", MB_OK, NULL );
195 else if ( !strcmp( p,CMD_CONFIG ) ) {
196 ShowBackgroundDialog();
200 //TODO these three suck
201 void DoBkgrndToggleXY(){
202 Sys_Printf( MSG_PREFIX "DoBkgrndToggleXY\n" );
203 // always toggle, since the buttons do
204 backgroundXY.m_bActive = ( backgroundXY.m_bActive ) ? false : true;
205 // if we don't have image or extents, and we activated,
206 // bring up the dialog with the corresponding page
207 // would be better to hide or grey out button, but we can't
208 if ( backgroundXY.m_bActive && !backgroundXY.Valid() ) {
209 ShowBackgroundDialogPG( 0 );
212 g_FuncTable.m_pfnSysUpdateWindows( W_XY );
216 void DoBkgrndToggleXZ(){
217 Sys_Printf( MSG_PREFIX "DoBkgrndToggleXZ\n" );
218 backgroundXZ.m_bActive = ( backgroundXZ.m_bActive ) ? false : true;
219 if ( backgroundXZ.m_bActive && !backgroundXZ.Valid() ) {
220 ShowBackgroundDialogPG( 1 );
223 g_FuncTable.m_pfnSysUpdateWindows( W_XY );
227 void DoBkgrndToggleYZ(){
228 Sys_Printf( MSG_PREFIX "DoBkgrndToggleYZ\n" );
229 backgroundYZ.m_bActive = ( backgroundYZ.m_bActive ) ? false : true;
230 if ( backgroundYZ.m_bActive && !backgroundYZ.Valid() ) {
231 ShowBackgroundDialogPG( 2 );
234 g_FuncTable.m_pfnSysUpdateWindows( W_XY );
238 // =============================================================================
241 CSynapseServer* g_pSynapseServer = NULL;
242 CSynapseClientBkgrnd2d g_SynapseClient;
245 #pragma GCC visibility push(default)
247 extern "C" CSynapseClient * SYNAPSE_DLL_EXPORT Synapse_EnumerateInterfaces( const char *version, CSynapseServer *pServer ) {
249 #pragma GCC visibility pop
251 if ( strcmp( version, SYNAPSE_VERSION ) ) {
252 Syn_Printf( "ERROR: synapse API version mismatch: should be '" SYNAPSE_VERSION "', got '%s'\n", version );
255 g_pSynapseServer = pServer;
256 g_pSynapseServer->IncRef();
257 Set_Syn_Printf( g_pSynapseServer->Get_Syn_Printf() );
259 g_SynapseClient.AddAPI( TOOLBAR_MAJOR, BKGRND2D_MINOR, sizeof( _QERPlugToolbarTable ) );
260 g_SynapseClient.AddAPI( PLUGIN_MAJOR, BKGRND2D_MINOR, sizeof( _QERPluginTable ) );
262 g_SynapseClient.AddAPI( RADIANT_MAJOR, NULL, sizeof( g_FuncTable ), SYN_REQUIRE, &g_FuncTable );
263 g_SynapseClient.AddAPI( QGL_MAJOR, NULL, sizeof( g_QglTable ), SYN_REQUIRE, &g_QglTable );
264 // TODO is this the right way to ask for 'whichever VFS we have loaded' ? Seems to work
265 // for misc filename functions
266 g_SynapseClient.AddAPI( VFS_MAJOR, "*", sizeof( g_FileSystemTable ), SYN_REQUIRE, &g_FileSystemTable );
268 g_SynapseClient.AddAPI( ENTITY_MAJOR, NULL, sizeof( g_EntityTable ), SYN_REQUIRE, &g_EntityTable );
270 g_SynapseClient.AddAPI( DATA_MAJOR, NULL, sizeof( g_DataTable ), SYN_REQUIRE, &g_DataTable );
272 return &g_SynapseClient;
275 bool CSynapseClientBkgrnd2d::RequestAPI( APIDescriptor_t *pAPI ){
276 if ( !strcmp( pAPI->major_name, PLUGIN_MAJOR ) ) {
277 _QERPluginTable* pTable = static_cast<_QERPluginTable*>( pAPI->mpTable );
279 pTable->m_pfnQERPlug_Init = QERPlug_Init;
280 pTable->m_pfnQERPlug_GetName = QERPlug_GetName;
281 pTable->m_pfnQERPlug_GetCommandList = QERPlug_GetCommandList;
282 pTable->m_pfnQERPlug_Dispatch = QERPlug_Dispatch;
285 if ( !strcmp( pAPI->major_name, TOOLBAR_MAJOR ) ) {
286 _QERPlugToolbarTable* pTable = static_cast<_QERPlugToolbarTable*>( pAPI->mpTable );
288 pTable->m_pfnToolbarButtonCount = &ToolbarButtonCount;
289 pTable->m_pfnGetToolbarButton = &GetToolbarButton;
293 Syn_Printf( "ERROR: RequestAPI( '%s' ) not found in '%s'\n", pAPI->major_name, GetInfo() );
299 const char* CSynapseClientBkgrnd2d::GetInfo(){
300 return "2d Background plugin built " __DATE__ " " RADIANT_VERSION;
303 const char* CSynapseClientBkgrnd2d::GetName(){