add a feature shift-k to assign killtarget, not target like ctrl-k
[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 void Entity_ungroupSelected()
134 {
135   if (GlobalSelectionSystem().countSelected() < 1) return;
136
137   UndoableCommand undo("ungroupSelectedEntities");
138
139   scene::Path world_path(makeReference(GlobalSceneGraph().root()));
140   world_path.push(makeReference(Map_FindOrInsertWorldspawn(g_map)));
141
142   scene::Instance &instance = GlobalSelectionSystem().ultimateSelected();
143   scene::Path path = instance.path();
144
145   if (!Node_isEntity(path.top())) path.pop();
146
147   if(Node_getEntity(path.top()) != 0
148     && node_is_group(path.top()))
149   {
150     if(world_path.top().get_pointer() != path.top().get_pointer())
151     {
152       parentBrushes(path.top(), world_path.top());
153       Path_deleteTop(path);
154     }
155   }
156 }
157
158
159 class EntityFindSelected : public scene::Graph::Walker
160 {
161 public:
162   mutable const scene::Path *groupPath;
163   mutable scene::Instance *groupInstance;
164   EntityFindSelected(): groupPath(0), groupInstance(0)
165   {
166   }
167   bool pre(const scene::Path& path, scene::Instance& instance) const
168   {
169     return true;
170   }
171   void post(const scene::Path& path, scene::Instance& instance) const
172   {
173     Entity* entity = Node_getEntity(path.top());
174     if(entity != 0
175       && Instance_getSelectable(instance)->isSelected()
176           && node_is_group(path.top())
177           && !groupPath)
178     { 
179           groupPath = &path;
180           groupInstance = &instance;
181     }
182   }
183 };
184
185 class EntityGroupSelected : public scene::Graph::Walker
186 {
187         NodeSmartReference group;
188         //typedef std::pair<NodeSmartReference, NodeSmartReference> DeletionPair;
189         //Stack<DeletionPair> deleteme;
190         public:
191         EntityGroupSelected(const scene::Path &p): group(p.top().get())
192         {
193         }
194         bool pre(const scene::Path& path, scene::Instance& instance) const
195         {
196                 return true;
197         }
198         void post(const scene::Path& path, scene::Instance& instance) const
199         {
200                 Selectable *selectable = Instance_getSelectable(instance);
201                 if(selectable && selectable->isSelected())
202                 { 
203                         Entity* entity = Node_getEntity(path.top());
204                         if(entity == 0 && Node_isPrimitive(path.top()))
205                         {
206                                 NodeSmartReference child(path.top().get());
207                                 NodeSmartReference parent(path.parent().get());
208
209                                 if(path.size() >= 3 && parent != Map_FindOrInsertWorldspawn(g_map))
210                                 {
211                                         NodeSmartReference parentparent(path[path.size() - 3].get());
212
213                                         Node_getTraversable(parent)->erase(child);
214                                         Node_getTraversable(group)->insert(child);
215
216                                         if(Node_getTraversable(parent)->empty())
217                                         {
218                                                 //deleteme.push(DeletionPair(parentparent, parent));
219                                                 Node_getTraversable(parentparent)->erase(parent);
220                                         }
221                                 }
222                                 else
223                                 {
224                                         Node_getTraversable(parent)->erase(child);
225                                         Node_getTraversable(group)->insert(child);
226                                 }
227                         }
228                 }
229         }
230 };
231
232 void Entity_groupSelected()
233 {
234   if (GlobalSelectionSystem().countSelected() < 1) return;
235
236   UndoableCommand undo("groupSelectedEntities");
237
238   scene::Path world_path(makeReference(GlobalSceneGraph().root()));
239   world_path.push(makeReference(Map_FindOrInsertWorldspawn(g_map)));
240
241   EntityFindSelected fse;
242   GlobalSceneGraph().traverse(fse);
243   if(fse.groupPath)
244   {
245           GlobalSceneGraph().traverse(EntityGroupSelected(*fse.groupPath));
246   }
247   else
248   {
249           GlobalSceneGraph().traverse(EntityGroupSelected(world_path));
250   }
251 }
252
253
254
255 void Entity_connectSelected()
256 {
257   if(GlobalSelectionSystem().countSelected() == 2)
258   {
259     GlobalEntityCreator().connectEntities(
260       GlobalSelectionSystem().penultimateSelected().path(),
261       GlobalSelectionSystem().ultimateSelected().path(),
262       0
263     );
264   }
265   else
266   {
267     globalErrorStream() << "entityConnectSelected: exactly two instances must be selected\n";
268   }
269 }
270
271 void Entity_killconnectSelected()
272 {
273   if(GlobalSelectionSystem().countSelected() == 2)
274   {
275     GlobalEntityCreator().connectEntities(
276       GlobalSelectionSystem().penultimateSelected().path(),
277       GlobalSelectionSystem().ultimateSelected().path(),
278       1
279     );
280   }
281   else
282   {
283     globalErrorStream() << "entityKillConnectSelected: exactly two instances must be selected\n";
284   }
285 }
286
287 AABB Doom3Light_getBounds(const AABB& workzone)
288 {
289   AABB aabb(workzone);
290
291   Vector3 defaultRadius(300, 300, 300);
292   if(!string_parse_vector3(EntityClass_valueForKey(*GlobalEntityClassManager().findOrInsert("light", false), "light_radius"), defaultRadius))
293   {
294     globalErrorStream() << "Doom3Light_getBounds: failed to parse default light radius\n";
295   }
296
297   if(aabb.extents[0] == 0)
298   {
299     aabb.extents[0] = defaultRadius[0];
300   }
301   if(aabb.extents[1] == 0)
302   {
303     aabb.extents[1] = defaultRadius[1];
304   }
305   if(aabb.extents[2] == 0)
306   {
307     aabb.extents[2] = defaultRadius[2];
308   }
309
310   if(aabb_valid(aabb))
311   {
312     return aabb;
313   }
314   return AABB(Vector3(0, 0, 0), Vector3(64, 64, 64));
315 }
316
317 int g_iLastLightIntensity;
318
319 void Entity_createFromSelection(const char* name, const Vector3& origin)
320 {
321 #if 0
322   if(string_equal_nocase(name, "worldspawn"))
323   {
324     gtk_MessageBox(GTK_WIDGET(MainFrame_getWindow()), "Can't create an entity with worldspawn.", "info");
325     return;
326   }
327 #endif
328
329   EntityClass* entityClass = GlobalEntityClassManager().findOrInsert(name, true);
330
331   bool isModel = string_equal_nocase(name, "misc_model")
332     || string_equal_nocase(name, "misc_gamemodel")
333     || string_equal_nocase(name, "model_static")
334     || (GlobalSelectionSystem().countSelected() == 0 && string_equal_nocase(name, "func_static"));
335
336   bool brushesSelected = Scene_countSelectedBrushes(GlobalSceneGraph()) != 0;
337
338   if(!(entityClass->fixedsize || isModel) && !brushesSelected)
339   {
340     globalErrorStream() << "failed to create a group entity - no brushes are selected\n";
341     return;
342   }
343
344   AABB workzone(aabb_for_minmax(Select_getWorkZone().d_work_min, Select_getWorkZone().d_work_max));
345
346
347   NodeSmartReference node(GlobalEntityCreator().createEntity(entityClass));
348
349   Node_getTraversable(GlobalSceneGraph().root())->insert(node);
350
351   scene::Path entitypath(makeReference(GlobalSceneGraph().root()));
352   entitypath.push(makeReference(node.get()));
353   scene::Instance& instance = findInstance(entitypath);
354
355   if(entityClass->fixedsize || (isModel && !brushesSelected))
356   {
357     Select_Delete();
358     
359     Transformable* transform = Instance_getTransformable(instance);
360     if(transform != 0)
361     {
362       transform->setType(TRANSFORM_PRIMITIVE);
363       transform->setTranslation(origin);
364       transform->freezeTransform();
365     }
366
367     GlobalSelectionSystem().setSelectedAll(false);
368
369     Instance_setSelected(instance, true);
370   }
371   else
372   {
373     if (g_pGameDescription->mGameType == "doom3")
374     {
375       Node_getEntity(node)->setKeyValue("model", Node_getEntity(node)->getKeyValue("name"));
376     }
377
378     Scene_parentSelectedBrushesToEntity(GlobalSceneGraph(), node);
379     Scene_forEachChildSelectable(SelectableSetSelected(true), instance.path());
380   }
381
382   // tweaking: when right clic dropping a light entity, ask for light value in a custom dialog box
383   // see SF bug 105383
384
385   if (g_pGameDescription->mGameType == "hl")
386   {
387     // FIXME - Hydra: really we need a combined light AND color dialog for halflife.
388     if (string_equal_nocase(name, "light")
389       || string_equal_nocase(name, "light_environment")
390       || string_equal_nocase(name, "light_spot"))
391     {
392       int intensity = g_iLastLightIntensity;
393
394       if (DoLightIntensityDlg (&intensity) == eIDOK)
395       {
396         g_iLastLightIntensity = intensity;
397         char buf[30];
398         sprintf( buf, "255 255 255 %d", intensity );
399         Node_getEntity(node)->setKeyValue("_light", buf);
400       }
401     }
402   }
403   else if(string_equal_nocase(name, "light"))
404   {
405     if(g_pGameDescription->mGameType != "doom3")
406     {
407       int intensity = g_iLastLightIntensity;
408
409       if (DoLightIntensityDlg (&intensity) == eIDOK)
410       {
411         g_iLastLightIntensity = intensity;
412         char buf[10];
413         sprintf( buf, "%d", intensity );
414         Node_getEntity(node)->setKeyValue("light", buf);
415       }
416     }
417     else if(brushesSelected) // use workzone to set light position/size for doom3 lights, if there are brushes selected
418     {
419       AABB bounds(Doom3Light_getBounds(workzone));
420       StringOutputStream key(64);
421       key << bounds.origin[0] << " " << bounds.origin[1] << " " << bounds.origin[2];
422       Node_getEntity(node)->setKeyValue("origin", key.c_str());
423       key.clear();
424       key << bounds.extents[0] << " " << bounds.extents[1] << " " << bounds.extents[2];
425       Node_getEntity(node)->setKeyValue("light_radius", key.c_str());
426     }
427   }
428
429   if(isModel)
430   {
431     const char* model = misc_model_dialog(GTK_WIDGET(MainFrame_getWindow()));
432     if(model != 0)
433     {
434       Node_getEntity(node)->setKeyValue("model", model);
435     }
436   }
437 }
438
439 #if 0
440 bool DoNormalisedColor(Vector3& color)
441 {
442   if(!color_dialog(GTK_WIDGET(MainFrame_getWindow()), color))
443     return false;
444   /* 
445   ** scale colors so that at least one component is at 1.0F 
446   */
447
448   float largest = 0.0F;
449
450   if ( color[0] > largest )
451     largest = color[0];
452   if ( color[1] > largest )
453     largest = color[1];
454   if ( color[2] > largest )
455     largest = color[2];
456
457   if ( largest == 0.0F )
458   {
459     color[0] = 1.0F;
460     color[1] = 1.0F;
461     color[2] = 1.0F;
462   }
463   else
464   {
465     float scaler = 1.0F / largest;
466
467     color[0] *= scaler;
468     color[1] *= scaler;
469     color[2] *= scaler;
470   }
471
472   return true;
473 }
474 #endif 
475
476 void NormalizeColor(Vector3& color)
477 {
478   // scale colors so that at least one component is at 1.0F 
479
480   float largest = 0.0F;
481
482   if ( color[0] > largest )
483     largest = color[0];
484   if ( color[1] > largest )
485     largest = color[1];
486   if ( color[2] > largest )
487     largest = color[2];
488
489   if ( largest == 0.0F )
490   {
491     color[0] = 1.0F;
492     color[1] = 1.0F;
493     color[2] = 1.0F;
494   }
495   else
496   {
497     float scaler = 1.0F / largest;
498
499     color[0] *= scaler;
500     color[1] *= scaler;
501     color[2] *= scaler;
502   }
503 }
504
505 void Entity_normalizeColor()
506 {
507         if(GlobalSelectionSystem().countSelected() != 0)
508         {
509                 const scene::Path& path = GlobalSelectionSystem().ultimateSelected().path();
510                 Entity* entity = Node_getEntity(path.top());
511
512                 if(entity != 0)
513                 {
514                         const char* strColor = entity->getKeyValue("_color");
515                         if(!string_empty(strColor))
516                         {
517                                 Vector3 rgb;
518                                 if (string_parse_vector3(strColor, rgb))
519                                 {
520                                         g_entity_globals.color_entity = rgb;
521                                         NormalizeColor(g_entity_globals.color_entity);
522
523                                         char buffer[128];
524                                         sprintf(buffer, "%g %g %g", g_entity_globals.color_entity[0],
525                                                 g_entity_globals.color_entity[1],
526                                                 g_entity_globals.color_entity[2]);
527
528                                         Scene_EntitySetKeyValue_Selected("_color", buffer);
529                                 }
530                         }
531                 }
532         }
533 }
534
535 void Entity_setColour()
536 {
537   if(GlobalSelectionSystem().countSelected() != 0)
538   {
539         bool normalize = false;
540     const scene::Path& path = GlobalSelectionSystem().ultimateSelected().path();
541     Entity* entity = Node_getEntity(path.top());
542
543     if(entity != 0)
544     {
545       const char* strColor = entity->getKeyValue("_color");
546       if(!string_empty(strColor))
547       {
548         Vector3 rgb;
549         if (string_parse_vector3(strColor, rgb))
550         {
551           g_entity_globals.color_entity = rgb;
552         }
553       }
554
555           if( g_pGameDescription->mGameType == "doom3" )
556                   normalize = false;
557
558           if(color_dialog(GTK_WIDGET(MainFrame_getWindow()), g_entity_globals.color_entity))
559           {
560                   if( normalize )
561                           NormalizeColor(g_entity_globals.color_entity);
562
563                   char buffer[128];
564                   sprintf(buffer, "%g %g %g", g_entity_globals.color_entity[0],
565                           g_entity_globals.color_entity[1],
566                           g_entity_globals.color_entity[2]);
567
568                   Scene_EntitySetKeyValue_Selected("_color", buffer);
569           }
570     }
571   }
572 }
573
574 const char* misc_model_dialog(GtkWidget* parent)
575 {
576   StringOutputStream buffer(1024);
577
578   buffer << g_qeglobals.m_userGamePath.c_str() << "models/";
579
580   if(!file_readable(buffer.c_str()))
581   {
582     // just go to fsmain
583     buffer.clear();
584     buffer << g_qeglobals.m_userGamePath.c_str() << "/";
585   }
586
587   const char *filename = file_dialog (parent, TRUE, "Choose Model", buffer.c_str(), ModelLoader::Name());
588   if (filename != 0)
589   {
590     // use VFS to get the correct relative path
591     const char* relative = path_make_relative(filename, GlobalFileSystem().findRoot(filename));
592     if(relative == filename)
593     {
594       globalOutputStream() << "WARNING: could not extract the relative path, using full path instead\n";
595     }
596     return relative;
597   }
598   return 0;
599 }
600
601 void LightRadiiImport(EntityCreator& self, bool value)
602 {
603   self.setLightRadii(value);
604 }
605 typedef ReferenceCaller1<EntityCreator, bool, LightRadiiImport> LightRadiiImportCaller;
606
607 void LightRadiiExport(EntityCreator& self, const BoolImportCallback& importer)
608 {
609   importer(self.getLightRadii());
610 }
611 typedef ReferenceCaller1<EntityCreator, const BoolImportCallback&, LightRadiiExport> LightRadiiExportCaller;
612
613 void Entity_constructPreferences(PreferencesPage& page)
614 {
615   page.appendCheckBox(
616     "Show", "Light Radii",
617     LightRadiiImportCaller(GlobalEntityCreator()),
618     LightRadiiExportCaller(GlobalEntityCreator())
619   );
620 }
621 void Entity_constructPage(PreferenceGroup& group)
622 {
623   PreferencesPage page(group.createPage("Entities", "Entity Display Preferences"));
624   Entity_constructPreferences(page);
625 }
626 void Entity_registerPreferencesPage()
627 {
628   PreferencesDialog_addDisplayPage(FreeCaller1<PreferenceGroup&, Entity_constructPage>());
629 }
630
631
632
633 void Entity_constructMenu(GtkMenu* menu)
634 {
635   create_menu_item_with_mnemonic(menu, "_Regroup", "GroupSelection");
636   create_menu_item_with_mnemonic(menu, "_Ungroup", "UngroupSelection");
637   create_menu_item_with_mnemonic(menu, "_Connect", "ConnectSelection");
638   create_menu_item_with_mnemonic(menu, "_KillConnect", "KillConnectSelection");
639   create_menu_item_with_mnemonic(menu, "_Select Color...", "EntityColor");
640   create_menu_item_with_mnemonic(menu, "_Normalize Color...", "NormalizeColor");
641 }
642
643
644
645 #include "preferencesystem.h"
646 #include "stringio.h"
647
648 void Entity_Construct()
649 {
650   GlobalCommands_insert("EntityColor", FreeCaller<Entity_setColour>(), Accelerator('K'));
651   GlobalCommands_insert("NormalizeColor", FreeCaller<Entity_normalizeColor>());
652   GlobalCommands_insert("ConnectSelection", FreeCaller<Entity_connectSelected>(), Accelerator('K', (GdkModifierType)GDK_CONTROL_MASK));
653   GlobalCommands_insert("KillConnectSelection", FreeCaller<Entity_killconnectSelected>(), Accelerator('K', (GdkModifierType)(GDK_SHIFT_MASK)));
654   GlobalCommands_insert("GroupSelection", FreeCaller<Entity_groupSelected>());
655   GlobalCommands_insert("UngroupSelection", FreeCaller<Entity_ungroupSelected>());
656
657   GlobalPreferenceSystem().registerPreference("SI_Colors5", Vector3ImportStringCaller(g_entity_globals.color_entity), Vector3ExportStringCaller(g_entity_globals.color_entity));
658   GlobalPreferenceSystem().registerPreference("LastLightIntensity", IntImportStringCaller(g_iLastLightIntensity), IntExportStringCaller(g_iLastLightIntensity));
659
660   Entity_registerPreferencesPage();
661 }
662
663 void Entity_Destroy()
664 {
665 }
666