6fb499fd35589d202661a177d148b993a2534ce0
[xonotic/netradiant.git] / radiant / entity.cpp
1 /*
2 Copyright (C) 1999-2006 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 #include "entity.h"
23
24 #include "ientity.h"
25 #include "iselection.h"
26 #include "imodel.h"
27 #include "ifilesystem.h"
28 #include "iundo.h"
29 #include "editable.h"
30
31 #include "eclasslib.h"
32 #include "scenelib.h"
33 #include "os/path.h"
34 #include "os/file.h"
35 #include "stream/stringstream.h"
36 #include "stringio.h"
37
38 #include "gtkutil/filechooser.h"
39 #include "gtkmisc.h"
40 #include "select.h"
41 #include "map.h"
42 #include "preferences.h"
43 #include "gtkdlgs.h"
44 #include "mainframe.h"
45 #include "qe3.h"
46 #include "commands.h"
47
48 struct entity_globals_t
49 {
50   Vector3 color_entity;
51
52   entity_globals_t() :
53     color_entity(0.0f, 0.0f, 0.0f)
54   {
55   }
56 };
57
58 entity_globals_t g_entity_globals;
59
60 class EntitySetKeyValueSelected : public scene::Graph::Walker
61 {
62   const char* m_key;
63   const char* m_value;
64 public:
65   EntitySetKeyValueSelected(const char* key, const char* value)
66     : m_key(key), m_value(value)
67   {
68   }
69   bool pre(const scene::Path& path, scene::Instance& instance) const
70   {
71     return true;
72   }
73   void post(const scene::Path& path, scene::Instance& instance) const
74   {
75     Entity* entity = Node_getEntity(path.top());
76     if(entity != 0
77       && (instance.childSelected() || Instance_getSelectable(instance)->isSelected()))
78     {
79       entity->setKeyValue(m_key, m_value);
80     }
81   }
82 };
83
84 class EntitySetClassnameSelected : public scene::Graph::Walker
85 {
86   const char* m_classname;
87 public:
88   EntitySetClassnameSelected(const char* classname)
89     : m_classname(classname)
90   {
91   }
92   bool pre(const scene::Path& path, scene::Instance& instance) const
93   {
94     return true;
95   }
96   void post(const scene::Path& path, scene::Instance& instance) const
97   {
98     Entity* entity = Node_getEntity(path.top());
99     if(entity != 0
100       && (instance.childSelected() || Instance_getSelectable(instance)->isSelected()))
101     { 
102       NodeSmartReference node(GlobalEntityCreator().createEntity(GlobalEntityClassManager().findOrInsert(m_classname, node_is_group(path.top()))));
103
104       EntityCopyingVisitor visitor(*Node_getEntity(node));
105
106       entity->forEachKeyValue(visitor);
107
108       NodeSmartReference child(path.top().get());
109       NodeSmartReference parent(path.parent().get());
110       Node_getTraversable(parent)->erase(child);
111       if(Node_getTraversable(child) != 0
112         && Node_getTraversable(node) != 0
113         && node_is_group(node))
114       {
115         parentBrushes(child, node);
116       }
117       Node_getTraversable(parent)->insert(node);
118     }
119   }
120 };
121
122 void Scene_EntitySetKeyValue_Selected(const char* key, const char* value)
123 {
124   GlobalSceneGraph().traverse(EntitySetKeyValueSelected(key, value));
125 }
126
127 void Scene_EntitySetClassname_Selected(const char* classname)
128 {
129   GlobalSceneGraph().traverse(EntitySetClassnameSelected(classname));
130 }
131
132
133 class EntityUngroupVisitor : public SelectionSystem::Visitor
134 {
135   const scene::Path& m_parent;
136 public:
137   EntityUngroupVisitor(const scene::Path& parent) : m_parent(parent)
138   {
139   }
140   void visit(scene::Instance& instance) const
141   {
142     if(Node_getEntity(instance.path().top()) != 0
143       && node_is_group(instance.path().top()))
144     {
145       if(m_parent.top().get_pointer() != instance.path().top().get_pointer())
146       {
147         parentBrushes(instance.path().top(), m_parent.top());
148         Path_deleteTop(instance.path());
149       }
150     }
151   }
152 };
153
154 void Entity_ungroupSelected()
155 {
156   UndoableCommand undo("ungroupSelectedEntities");
157
158   scene::Path world_path(makeReference(GlobalSceneGraph().root()));
159   world_path.push(makeReference(Map_FindOrInsertWorldspawn(g_map)));
160
161   GlobalSelectionSystem().foreachSelected(EntityUngroupVisitor(world_path));
162 }
163
164
165
166 void Entity_connectSelected()
167 {
168   if(GlobalSelectionSystem().countSelected() == 2)
169   {
170     GlobalEntityCreator().connectEntities(
171       GlobalSelectionSystem().penultimateSelected().path(),
172       GlobalSelectionSystem().ultimateSelected().path()
173     );
174   }
175   else
176   {
177     globalErrorStream() << "entityConnectSelected: exactly two instances must be selected\n";
178   }
179 }
180
181 AABB Doom3Light_getBounds(const AABB& workzone)
182 {
183   AABB aabb(workzone);
184
185   Vector3 defaultRadius(300, 300, 300);
186   if(!string_parse_vector3(EntityClass_valueForKey(*GlobalEntityClassManager().findOrInsert("light", false), "light_radius"), defaultRadius))
187   {
188     globalErrorStream() << "Doom3Light_getBounds: failed to parse default light radius\n";
189   }
190
191   if(aabb.extents[0] == 0)
192   {
193     aabb.extents[0] = defaultRadius[0];
194   }
195   if(aabb.extents[1] == 0)
196   {
197     aabb.extents[1] = defaultRadius[1];
198   }
199   if(aabb.extents[2] == 0)
200   {
201     aabb.extents[2] = defaultRadius[2];
202   }
203
204   if(aabb_valid(aabb))
205   {
206     return aabb;
207   }
208   return AABB(Vector3(0, 0, 0), Vector3(64, 64, 64));
209 }
210
211 int g_iLastLightIntensity;
212
213 void Entity_createFromSelection(const char* name, const Vector3& origin)
214 {
215 #if 0
216   if(string_equal_nocase(name, "worldspawn"))
217   {
218     gtk_MessageBox(GTK_WIDGET(MainFrame_getWindow()), "Can't create an entity with worldspawn.", "info");
219     return;
220   }
221 #endif
222
223   EntityClass* entityClass = GlobalEntityClassManager().findOrInsert(name, true);
224
225   bool isModel = string_equal_nocase(name, "misc_model")
226     || string_equal_nocase(name, "misc_gamemodel")
227     || string_equal_nocase(name, "model_static")
228     || (GlobalSelectionSystem().countSelected() == 0 && string_equal_nocase(name, "func_static"));
229
230   bool brushesSelected = Scene_countSelectedBrushes(GlobalSceneGraph()) != 0;
231
232   if(!(entityClass->fixedsize || isModel) && !brushesSelected)
233   {
234     globalErrorStream() << "failed to create a group entity - no brushes are selected\n";
235     return;
236   }
237
238   AABB workzone(aabb_for_minmax(Select_getWorkZone().d_work_min, Select_getWorkZone().d_work_max));
239
240
241   NodeSmartReference node(GlobalEntityCreator().createEntity(entityClass));
242
243   Node_getTraversable(GlobalSceneGraph().root())->insert(node);
244
245   scene::Path entitypath(makeReference(GlobalSceneGraph().root()));
246   entitypath.push(makeReference(node.get()));
247   scene::Instance& instance = findInstance(entitypath);
248
249   if(entityClass->fixedsize || (isModel && !brushesSelected))
250   {
251     Select_Delete();
252     
253     Transformable* transform = Instance_getTransformable(instance);
254     if(transform != 0)
255     {
256       transform->setType(TRANSFORM_PRIMITIVE);
257       transform->setTranslation(origin);
258       transform->freezeTransform();
259     }
260
261     GlobalSelectionSystem().setSelectedAll(false);
262
263     Instance_setSelected(instance, true);
264   }
265   else
266   {
267     if (g_pGameDescription->mGameType == "doom3")
268     {
269       Node_getEntity(node)->setKeyValue("model", Node_getEntity(node)->getKeyValue("name"));
270     }
271
272     Scene_parentSelectedBrushesToEntity(GlobalSceneGraph(), node);
273     Scene_forEachChildSelectable(SelectableSetSelected(true), instance.path());
274   }
275
276   // tweaking: when right clic dropping a light entity, ask for light value in a custom dialog box
277   // see SF bug 105383
278
279   if (g_pGameDescription->mGameType == "hl")
280   {
281     // FIXME - Hydra: really we need a combined light AND color dialog for halflife.
282     if (string_equal_nocase(name, "light")
283       || string_equal_nocase(name, "light_environment")
284       || string_equal_nocase(name, "light_spot"))
285     {
286       int intensity = g_iLastLightIntensity;
287
288       if (DoLightIntensityDlg (&intensity) == eIDOK)
289       {
290         g_iLastLightIntensity = intensity;
291         char buf[30];
292         sprintf( buf, "255 255 255 %d", intensity );
293         Node_getEntity(node)->setKeyValue("_light", buf);
294       }
295     }
296   }
297   else if(string_equal_nocase(name, "light"))
298   {
299     if(g_pGameDescription->mGameType != "doom3")
300     {
301       int intensity = g_iLastLightIntensity;
302
303       if (DoLightIntensityDlg (&intensity) == eIDOK)
304       {
305         g_iLastLightIntensity = intensity;
306         char buf[10];
307         sprintf( buf, "%d", intensity );
308         Node_getEntity(node)->setKeyValue("light", buf);
309       }
310     }
311     else if(brushesSelected) // use workzone to set light position/size for doom3 lights, if there are brushes selected
312     {
313       AABB bounds(Doom3Light_getBounds(workzone));
314       StringOutputStream key(64);
315       key << bounds.origin[0] << " " << bounds.origin[1] << " " << bounds.origin[2];
316       Node_getEntity(node)->setKeyValue("origin", key.c_str());
317       key.clear();
318       key << bounds.extents[0] << " " << bounds.extents[1] << " " << bounds.extents[2];
319       Node_getEntity(node)->setKeyValue("light_radius", key.c_str());
320     }
321   }
322
323   if(isModel)
324   {
325     const char* model = misc_model_dialog(GTK_WIDGET(MainFrame_getWindow()));
326     if(model != 0)
327     {
328       Node_getEntity(node)->setKeyValue("model", model);
329     }
330   }
331 }
332
333
334 bool DoNormalisedColor(Vector3& color)
335 {
336   if(!color_dialog(GTK_WIDGET(MainFrame_getWindow()), color))
337     return false;
338   /* 
339   ** scale colors so that at least one component is at 1.0F 
340   */
341
342   float largest = 0.0F;
343
344   if ( color[0] > largest )
345     largest = color[0];
346   if ( color[1] > largest )
347     largest = color[1];
348   if ( color[2] > largest )
349     largest = color[2];
350
351   if ( largest == 0.0F )
352   {
353     color[0] = 1.0F;
354     color[1] = 1.0F;
355     color[2] = 1.0F;
356   }
357   else
358   {
359     float scaler = 1.0F / largest;
360
361     color[0] *= scaler;
362     color[1] *= scaler;
363     color[2] *= scaler;
364   }
365
366   return true;
367 }
368
369 void Entity_setColour()
370 {
371   if(GlobalSelectionSystem().countSelected() != 0)
372   {
373     const scene::Path& path = GlobalSelectionSystem().ultimateSelected().path();
374     Entity* entity = Node_getEntity(path.top());
375     if(entity != 0)
376     {
377       const char* strColor = entity->getKeyValue("_color");
378       if(!string_empty(strColor))
379       {
380         Vector3 rgb;
381         if (string_parse_vector3(strColor, rgb))
382         {
383           g_entity_globals.color_entity = rgb;
384         }
385       }
386
387       if(g_pGameDescription->mGameType == "doom3"
388         ? color_dialog(GTK_WIDGET(MainFrame_getWindow()), g_entity_globals.color_entity)
389         : DoNormalisedColor(g_entity_globals.color_entity))
390       {
391         char buffer[128];
392         sprintf(buffer, "%g %g %g", g_entity_globals.color_entity[0],
393                 g_entity_globals.color_entity[1],
394                 g_entity_globals.color_entity[2]);
395
396         Scene_EntitySetKeyValue_Selected("_color", buffer);
397       }
398     }
399   }
400 }
401
402 const char* misc_model_dialog(GtkWidget* parent)
403 {
404   StringOutputStream buffer(1024);
405
406   buffer << g_qeglobals.m_userGamePath.c_str() << "models/";
407
408   if(!file_readable(buffer.c_str()))
409   {
410     // just go to fsmain
411     buffer.clear();
412     buffer << g_qeglobals.m_userGamePath.c_str() << "/";
413   }
414
415   const char *filename = file_dialog (parent, TRUE, "Choose Model", buffer.c_str(), ModelLoader::Name());
416   if (filename != 0)
417   {
418     // use VFS to get the correct relative path
419     const char* relative = path_make_relative(filename, GlobalFileSystem().findRoot(filename));
420     if(relative == filename)
421     {
422       globalOutputStream() << "WARNING: could not extract the relative path, using full path instead\n";
423     }
424     return relative;
425   }
426   return 0;
427 }
428
429 void LightRadiiImport(EntityCreator& self, bool value)
430 {
431   self.setLightRadii(value);
432 }
433 typedef ReferenceCaller1<EntityCreator, bool, LightRadiiImport> LightRadiiImportCaller;
434
435 void LightRadiiExport(EntityCreator& self, const BoolImportCallback& importer)
436 {
437   importer(self.getLightRadii());
438 }
439 typedef ReferenceCaller1<EntityCreator, const BoolImportCallback&, LightRadiiExport> LightRadiiExportCaller;
440
441 void Entity_constructPreferences(PreferencesPage& page)
442 {
443   page.appendCheckBox(
444     "Show", "Light Radii",
445     LightRadiiImportCaller(GlobalEntityCreator()),
446     LightRadiiExportCaller(GlobalEntityCreator())
447   );
448 }
449 void Entity_constructPage(PreferenceGroup& group)
450 {
451   PreferencesPage page(group.createPage("Entities", "Entity Display Preferences"));
452   Entity_constructPreferences(page);
453 }
454 void Entity_registerPreferencesPage()
455 {
456   PreferencesDialog_addDisplayPage(FreeCaller1<PreferenceGroup&, Entity_constructPage>());
457 }
458
459
460
461 void Entity_constructMenu(GtkMenu* menu)
462 {
463   create_menu_item_with_mnemonic(menu, "_Ungroup", "UngroupSelection");
464   create_menu_item_with_mnemonic(menu, "_Connect", "ConnectSelection");
465   create_menu_item_with_mnemonic(menu, "_Select Color...", "EntityColor");
466 }
467
468
469
470 #include "preferencesystem.h"
471 #include "stringio.h"
472
473 void Entity_Construct()
474 {
475   GlobalCommands_insert("EntityColor", FreeCaller<Entity_setColour>(), Accelerator('K'));
476   GlobalCommands_insert("ConnectSelection", FreeCaller<Entity_connectSelected>(), Accelerator('K', (GdkModifierType)GDK_CONTROL_MASK));
477   GlobalCommands_insert("UngroupSelection", FreeCaller<Entity_ungroupSelected>());
478
479   GlobalPreferenceSystem().registerPreference("SI_Colors5", Vector3ImportStringCaller(g_entity_globals.color_entity), Vector3ExportStringCaller(g_entity_globals.color_entity));
480   GlobalPreferenceSystem().registerPreference("LastLightIntensity", IntImportStringCaller(g_iLastLightIntensity), IntExportStringCaller(g_iLastLightIntensity));
481
482   Entity_registerPreferencesPage();
483 }
484
485 void Entity_Destroy()
486 {
487 }
488