changed doom3/quake4 light creation to use size of selected brushes
[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 const float Doom3Light_defaultRadius = 300;
182
183 AABB Doom3Light_getBounds(const AABB& workzone)
184 {
185   AABB aabb(workzone);
186
187   if(aabb.extents[0] == 0)
188   {
189     aabb.extents[0] = Doom3Light_defaultRadius;
190   }
191   if(aabb.extents[1] == 0)
192   {
193     aabb.extents[1] = Doom3Light_defaultRadius;
194   }
195   if(aabb.extents[2] == 0)
196   {
197     aabb.extents[2] = Doom3Light_defaultRadius;
198   }
199
200   if(aabb_valid(aabb))
201   {
202     return aabb;
203   }
204   return AABB(Vector3(0, 0, 0), Vector3(64, 64, 64));
205 }
206
207 int g_iLastLightIntensity;
208
209 void Entity_createFromSelection(const char* name, const Vector3& origin)
210 {
211 #if 0
212   if(string_equal_nocase(name, "worldspawn"))
213   {
214     gtk_MessageBox(GTK_WIDGET(MainFrame_getWindow()), "Can't create an entity with worldspawn.", "info");
215     return;
216   }
217 #endif
218
219   EntityClass* entityClass = GlobalEntityClassManager().findOrInsert(name, true);
220
221   bool isModel = string_equal_nocase(name, "misc_model")
222     || string_equal_nocase(name, "misc_gamemodel")
223     || string_equal_nocase(name, "model_static")
224     || (GlobalSelectionSystem().countSelected() == 0 && string_equal_nocase(name, "func_static"));
225
226   bool brushesSelected = Scene_countSelectedBrushes(GlobalSceneGraph()) != 0;
227
228   if(!(entityClass->fixedsize || isModel) && !brushesSelected)
229   {
230     globalErrorStream() << "failed to create a group entity - no brushes are selected\n";
231     return;
232   }
233
234   AABB workzone(aabb_for_minmax(Select_getWorkZone().d_work_min, Select_getWorkZone().d_work_max));
235
236
237   NodeSmartReference node(GlobalEntityCreator().createEntity(entityClass));
238
239   Node_getTraversable(GlobalSceneGraph().root())->insert(node);
240
241   scene::Path entitypath(makeReference(GlobalSceneGraph().root()));
242   entitypath.push(makeReference(node.get()));
243   scene::Instance& instance = findInstance(entitypath);
244
245   if(entityClass->fixedsize)
246   {
247     Select_Delete();
248     
249     Transformable* transform = Instance_getTransformable(instance);
250     if(transform != 0)
251     {
252       transform->setType(TRANSFORM_PRIMITIVE);
253       transform->setTranslation(origin);
254       transform->freezeTransform();
255     }
256
257     GlobalSelectionSystem().setSelectedAll(false);
258
259     Instance_setSelected(instance, true);
260   }
261   else
262   {
263     Scene_parentSelectedBrushesToEntity(GlobalSceneGraph(), node);
264     Scene_forEachChildSelectable(SelectableSetSelected(true), instance.path());
265   }
266
267   // tweaking: when right clic dropping a light entity, ask for light value in a custom dialog box
268   // see SF bug 105383
269
270   if (g_pGameDescription->mGameType == "hl")
271   {
272     // FIXME - Hydra: really we need a combined light AND color dialog for halflife.
273     if (string_equal_nocase(name, "light")
274       || string_equal_nocase(name, "light_environment")
275       || string_equal_nocase(name, "light_spot"))
276     {
277       int intensity = g_iLastLightIntensity;
278
279       if (DoLightIntensityDlg (&intensity) == eIDOK)
280       {
281         g_iLastLightIntensity = intensity;
282         char buf[30];
283         sprintf( buf, "255 255 255 %d", intensity );
284         Node_getEntity(node)->setKeyValue("_light", buf);
285       }
286     }
287   }
288   else if(string_equal_nocase(name, "light"))
289   {
290     if(g_pGameDescription->mGameType != "doom3")
291     {
292       int intensity = g_iLastLightIntensity;
293
294       if (DoLightIntensityDlg (&intensity) == eIDOK)
295       {
296         g_iLastLightIntensity = intensity;
297         char buf[10];
298         sprintf( buf, "%d", intensity );
299         Node_getEntity(node)->setKeyValue("light", buf);
300       }
301     }
302     else if(brushesSelected) // use workzone to set light position/size for doom3 lights, if there are brushes selected
303     {
304       AABB bounds(Doom3Light_getBounds(workzone));
305       StringOutputStream key(64);
306       key << bounds.origin[0] << " " << bounds.origin[1] << " " << bounds.origin[2];
307       Node_getEntity(node)->setKeyValue("origin", key.c_str());
308       key.clear();
309       key << bounds.extents[0] << " " << bounds.extents[1] << " " << bounds.extents[2];
310       Node_getEntity(node)->setKeyValue("light_radius", key.c_str());
311     }
312   }
313
314   if(isModel)
315   {
316     const char* model = misc_model_dialog(GTK_WIDGET(MainFrame_getWindow()));
317     if(model != 0)
318     {
319       Node_getEntity(node)->setKeyValue("model", model);
320     }
321   }
322 }
323
324
325 bool DoNormalisedColor(Vector3& color)
326 {
327   if(!color_dialog(GTK_WIDGET(MainFrame_getWindow()), color))
328     return false;
329   /* 
330   ** scale colors so that at least one component is at 1.0F 
331   */
332
333   float largest = 0.0F;
334
335   if ( color[0] > largest )
336     largest = color[0];
337   if ( color[1] > largest )
338     largest = color[1];
339   if ( color[2] > largest )
340     largest = color[2];
341
342   if ( largest == 0.0F )
343   {
344     color[0] = 1.0F;
345     color[1] = 1.0F;
346     color[2] = 1.0F;
347   }
348   else
349   {
350     float scaler = 1.0F / largest;
351
352     color[0] *= scaler;
353     color[1] *= scaler;
354     color[2] *= scaler;
355   }
356
357   return true;
358 }
359
360 void Entity_setColour()
361 {
362   if(GlobalSelectionSystem().countSelected() != 0)
363   {
364     const scene::Path& path = GlobalSelectionSystem().ultimateSelected().path();
365     Entity* entity = Node_getEntity(path.top());
366     if(entity != 0)
367     {
368       const char* strColor = entity->getKeyValue("_color");
369       if(!string_empty(strColor))
370       {
371         Vector3 rgb;
372         if (string_parse_vector3(strColor, rgb))
373         {
374           g_entity_globals.color_entity = rgb;
375         }
376       }
377
378       if(g_pGameDescription->mGameType == "doom3"
379         ? color_dialog(GTK_WIDGET(MainFrame_getWindow()), g_entity_globals.color_entity)
380         : DoNormalisedColor(g_entity_globals.color_entity))
381       {
382         char buffer[128];
383         sprintf(buffer, "%g %g %g", g_entity_globals.color_entity[0],
384                 g_entity_globals.color_entity[1],
385                 g_entity_globals.color_entity[2]);
386
387         Scene_EntitySetKeyValue_Selected("_color", buffer);
388       }
389     }
390   }
391 }
392
393 const char* misc_model_dialog(GtkWidget* parent)
394 {
395   StringOutputStream buffer(1024);
396
397   buffer << g_qeglobals.m_userGamePath.c_str() << "models/";
398
399   if(!file_readable(buffer.c_str()))
400   {
401     // just go to fsmain
402     buffer.clear();
403     buffer << g_qeglobals.m_userGamePath.c_str() << "/";
404   }
405
406   const char *filename = file_dialog (parent, TRUE, "Choose Model", buffer.c_str(), ModelLoader::Name());
407   if (filename != 0)
408   {
409     // use VFS to get the correct relative path
410     const char* relative = path_make_relative(filename, GlobalFileSystem().findRoot(filename));
411     if(relative == filename)
412     {
413       globalOutputStream() << "WARNING: could not extract the relative path, using full path instead\n";
414     }
415     return relative;
416   }
417   return 0;
418 }
419
420 void LightRadiiImport(EntityCreator& self, bool value)
421 {
422   self.setLightRadii(value);
423 }
424 typedef ReferenceCaller1<EntityCreator, bool, LightRadiiImport> LightRadiiImportCaller;
425
426 void LightRadiiExport(EntityCreator& self, const BoolImportCallback& importer)
427 {
428   importer(self.getLightRadii());
429 }
430 typedef ReferenceCaller1<EntityCreator, const BoolImportCallback&, LightRadiiExport> LightRadiiExportCaller;
431
432 void Entity_constructPreferences(PreferencesPage& page)
433 {
434   page.appendCheckBox(
435     "Show", "Light Radii",
436     LightRadiiImportCaller(GlobalEntityCreator()),
437     LightRadiiExportCaller(GlobalEntityCreator())
438   );
439 }
440 void Entity_constructPage(PreferenceGroup& group)
441 {
442   PreferencesPage page(group.createPage("Entities", "Entity Display Preferences"));
443   Entity_constructPreferences(page);
444 }
445 void Entity_registerPreferencesPage()
446 {
447   PreferencesDialog_addDisplayPage(FreeCaller1<PreferenceGroup&, Entity_constructPage>());
448 }
449
450
451
452 void Entity_constructMenu(GtkMenu* menu)
453 {
454   create_menu_item_with_mnemonic(menu, "_Ungroup", "UngroupSelection");
455   create_menu_item_with_mnemonic(menu, "_Connect", "ConnectSelection");
456   create_menu_item_with_mnemonic(menu, "_Select Color...", "EntityColor");
457 }
458
459
460
461 #include "preferencesystem.h"
462 #include "stringio.h"
463
464 void Entity_Construct()
465 {
466   GlobalCommands_insert("EntityColor", FreeCaller<Entity_setColour>(), Accelerator('K'));
467   GlobalCommands_insert("ConnectSelection", FreeCaller<Entity_connectSelected>(), Accelerator('K', (GdkModifierType)GDK_CONTROL_MASK));
468   GlobalCommands_insert("UngroupSelection", FreeCaller<Entity_ungroupSelected>());
469
470   GlobalPreferenceSystem().registerPreference("SI_Colors5", Vector3ImportStringCaller(g_entity_globals.color_entity), Vector3ExportStringCaller(g_entity_globals.color_entity));
471   GlobalPreferenceSystem().registerPreference("LastLightIntensity", IntImportStringCaller(g_iLastLightIntensity), IntExportStringCaller(g_iLastLightIntensity));
472
473   Entity_registerPreferencesPage();
474 }
475
476 void Entity_Destroy()
477 {
478 }
479