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, worldspawn;
 188         //typedef std::pair<NodeSmartReference, NodeSmartReference> DeletionPair;
 189         //Stack<DeletionPair> deleteme;
 190         public:
 191         EntityGroupSelected(const scene::Path &p): group(p.top().get()), worldspawn(Map_FindOrInsertWorldspawn(g_map))
 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 != worldspawn)
 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_compare_nocase_n(name, "misc_", 5) == 0 && string_equal_nocase(name + string_length(name) - 5, "model")) // misc_*model (also misc_model)
 332     || string_equal_nocase(name, "model_static")
 333     || (GlobalSelectionSystem().countSelected() == 0 && string_equal_nocase(name, "func_static"));
 334
 335   bool brushesSelected = Scene_countSelectedBrushes(GlobalSceneGraph()) != 0;
 336
 337   if(!(entityClass->fixedsize || isModel) && !brushesSelected)
 338   {
 339     globalErrorStream() << "failed to create a group entity - no brushes are selected\n";
 340     return;
 341   }
 342
 343   AABB workzone(aabb_for_minmax(Select_getWorkZone().d_work_min, Select_getWorkZone().d_work_max));
 344
 345
 346   NodeSmartReference node(GlobalEntityCreator().createEntity(entityClass));
 347
 348   Node_getTraversable(GlobalSceneGraph().root())->insert(node);
 349
 350   scene::Path entitypath(makeReference(GlobalSceneGraph().root()));
 351   entitypath.push(makeReference(node.get()));
 352   scene::Instance& instance = findInstance(entitypath);
 353
 354   if(entityClass->fixedsize || (isModel && !brushesSelected))
 355   {
 356     Select_Delete();
 357
 358     Transformable* transform = Instance_getTransformable(instance);
 359     if(transform != 0)
 360     {
 361       transform->setType(TRANSFORM_PRIMITIVE);
 362       transform->setTranslation(origin);
 363       transform->freezeTransform();
 364     }
 365
 366     GlobalSelectionSystem().setSelectedAll(false);
 367
 368     Instance_setSelected(instance, true);
 369   }
 370   else
 371   {
 372     if (g_pGameDescription->mGameType == "doom3")
 373     {
 374       Node_getEntity(node)->setKeyValue("model", Node_getEntity(node)->getKeyValue("name"));
 375     }
 376
 377     Scene_parentSelectedBrushesToEntity(GlobalSceneGraph(), node);
 378     Scene_forEachChildSelectable(SelectableSetSelected(true), instance.path());
 379   }
 380
 381   // tweaking: when right clic dropping a light entity, ask for light value in a custom dialog box
 382   // see SF bug 105383
 383
 384   if (g_pGameDescription->mGameType == "hl")
 385   {
 386     // FIXME - Hydra: really we need a combined light AND color dialog for halflife.
 387     if (string_equal_nocase(name, "light")
 388       || string_equal_nocase(name, "light_environment")
 389       || string_equal_nocase(name, "light_spot"))
 390     {
 391       int intensity = g_iLastLightIntensity;
 392
 393       if (DoLightIntensityDlg (&intensity) == eIDOK)
 394       {
 395         g_iLastLightIntensity = intensity;
 396         char buf[30];
 397         sprintf( buf, "255 255 255 %d", intensity );
 398         Node_getEntity(node)->setKeyValue("_light", buf);
 399       }
 400     }
 401   }
 402   else if(string_equal_nocase(name, "light"))
 403   {
 404     if(g_pGameDescription->mGameType != "doom3")
 405     {
 406       int intensity = g_iLastLightIntensity;
 407
 408       if (DoLightIntensityDlg (&intensity) == eIDOK)
 409       {
 410         g_iLastLightIntensity = intensity;
 411         char buf[10];
 412         sprintf( buf, "%d", intensity );
 413         Node_getEntity(node)->setKeyValue("light", buf);
 414       }
 415     }
 416     else if(brushesSelected) // use workzone to set light position/size for doom3 lights, if there are brushes selected
 417     {
 418       AABB bounds(Doom3Light_getBounds(workzone));
 419       StringOutputStream key(64);
 420       key << bounds.origin[0] << " " << bounds.origin[1] << " " << bounds.origin[2];
 421       Node_getEntity(node)->setKeyValue("origin", key.c_str());
 422       key.clear();
 423       key << bounds.extents[0] << " " << bounds.extents[1] << " " << bounds.extents[2];
 424       Node_getEntity(node)->setKeyValue("light_radius", key.c_str());
 425     }
 426   }
 427
 428   if(isModel)
 429   {
 430     const char* model = misc_model_dialog(GTK_WIDGET(MainFrame_getWindow()));
 431     if(model != 0)
 432     {
 433       Node_getEntity(node)->setKeyValue("model", model);
 434     }
 435   }
 436 }
 437
 438 #if 0
 439 bool DoNormalisedColor(Vector3& color)
 440 {
 441   if(!color_dialog(GTK_WIDGET(MainFrame_getWindow()), color))
 442     return false;
 443   /*
 444   ** scale colors so that at least one component is at 1.0F
 445   */
 446
 447   float largest = 0.0F;
 448
 449   if ( color[0] > largest )
 450     largest = color[0];
 451   if ( color[1] > largest )
 452     largest = color[1];
 453   if ( color[2] > largest )
 454     largest = color[2];
 455
 456   if ( largest == 0.0F )
 457   {
 458     color[0] = 1.0F;
 459     color[1] = 1.0F;
 460     color[2] = 1.0F;
 461   }
 462   else
 463   {
 464     float scaler = 1.0F / largest;
 465
 466     color[0] *= scaler;
 467     color[1] *= scaler;
 468     color[2] *= scaler;
 469   }
 470
 471   return true;
 472 }
 473 #endif
 474
 475 void NormalizeColor(Vector3& color)
 476 {
 477   // scale colors so that at least one component is at 1.0F
 478
 479   float largest = 0.0F;
 480
 481   if ( color[0] > largest )
 482     largest = color[0];
 483   if ( color[1] > largest )
 484     largest = color[1];
 485   if ( color[2] > largest )
 486     largest = color[2];
 487
 488   if ( largest == 0.0F )
 489   {
 490     color[0] = 1.0F;
 491     color[1] = 1.0F;
 492     color[2] = 1.0F;
 493   }
 494   else
 495   {
 496     float scaler = 1.0F / largest;
 497
 498     color[0] *= scaler;
 499     color[1] *= scaler;
 500     color[2] *= scaler;
 501   }
 502 }
 503
 504 void Entity_normalizeColor()
 505 {
 506         if(GlobalSelectionSystem().countSelected() != 0)
 507         {
 508                 const scene::Path& path = GlobalSelectionSystem().ultimateSelected().path();
 509                 Entity* entity = Node_getEntity(path.top());
 510
 511                 if(entity != 0)
 512                 {
 513                         const char* strColor = entity->getKeyValue("_color");
 514                         if(!string_empty(strColor))
 515                         {
 516                                 Vector3 rgb;
 517                                 if (string_parse_vector3(strColor, rgb))
 518                                 {
 519                                         g_entity_globals.color_entity = rgb;
 520                                         NormalizeColor(g_entity_globals.color_entity);
 521
 522                                         char buffer[128];
 523                                         sprintf(buffer, "%g %g %g", g_entity_globals.color_entity[0],
 524                                                 g_entity_globals.color_entity[1],
 525                                                 g_entity_globals.color_entity[2]);
 526
 527                                         Scene_EntitySetKeyValue_Selected("_color", buffer);
 528                                 }
 529                         }
 530                 }
 531         }
 532 }
 533
 534 void Entity_setColour()
 535 {
 536   if(GlobalSelectionSystem().countSelected() != 0)
 537   {
 538         bool normalize = false;
 539     const scene::Path& path = GlobalSelectionSystem().ultimateSelected().path();
 540     Entity* entity = Node_getEntity(path.top());
 541
 542     if(entity != 0)
 543     {
 544       const char* strColor = entity->getKeyValue("_color");
 545       if(!string_empty(strColor))
 546       {
 547         Vector3 rgb;
 548         if (string_parse_vector3(strColor, rgb))
 549         {
 550           g_entity_globals.color_entity = rgb;
 551         }
 552       }
 553
 554           if( g_pGameDescription->mGameType == "doom3" )
 555                   normalize = false;
 556
 557           if(color_dialog(GTK_WIDGET(MainFrame_getWindow()), g_entity_globals.color_entity))
 558           {
 559                   if( normalize )
 560                           NormalizeColor(g_entity_globals.color_entity);
 561
 562                   char buffer[128];
 563                   sprintf(buffer, "%g %g %g", g_entity_globals.color_entity[0],
 564                           g_entity_globals.color_entity[1],
 565                           g_entity_globals.color_entity[2]);
 566
 567                   Scene_EntitySetKeyValue_Selected("_color", buffer);
 568           }
 569     }
 570   }
 571 }
 572
 573 const char* misc_model_dialog(GtkWidget* parent)
 574 {
 575   StringOutputStream buffer(1024);
 576
 577   buffer << g_qeglobals.m_userGamePath.c_str() << "models/";
 578
 579   if(!file_readable(buffer.c_str()))
 580   {
 581     // just go to fsmain
 582     buffer.clear();
 583     buffer << g_qeglobals.m_userGamePath.c_str() << "/";
 584   }
 585
 586   const char *filename = file_dialog (parent, TRUE, "Choose Model", buffer.c_str(), ModelLoader::Name());
 587   if (filename != 0)
 588   {
 589     // use VFS to get the correct relative path
 590     const char* relative = path_make_relative(filename, GlobalFileSystem().findRoot(filename));
 591     if(relative == filename)
 592     {
 593       globalOutputStream() << "WARNING: could not extract the relative path, using full path instead\n";
 594     }
 595     return relative;
 596   }
 597   return 0;
 598 }
 599
 600 void LightRadiiImport(EntityCreator& self, bool value)
 601 {
 602   self.setLightRadii(value);
 603 }
 604 typedef ReferenceCaller1<EntityCreator, bool, LightRadiiImport> LightRadiiImportCaller;
 605
 606 void LightRadiiExport(EntityCreator& self, const BoolImportCallback& importer)
 607 {
 608   importer(self.getLightRadii());
 609 }
 610 typedef ReferenceCaller1<EntityCreator, const BoolImportCallback&, LightRadiiExport> LightRadiiExportCaller;
 611
 612 void Entity_constructPreferences(PreferencesPage& page)
 613 {
 614   page.appendCheckBox(
 615     "Show", "Light Radii",
 616     LightRadiiImportCaller(GlobalEntityCreator()),
 617     LightRadiiExportCaller(GlobalEntityCreator())
 618   );
 619 }
 620 void Entity_constructPage(PreferenceGroup& group)
 621 {
 622   PreferencesPage page(group.createPage("Entities", "Entity Display Preferences"));
 623   Entity_constructPreferences(page);
 624 }
 625 void Entity_registerPreferencesPage()
 626 {
 627   PreferencesDialog_addDisplayPage(FreeCaller1<PreferenceGroup&, Entity_constructPage>());
 628 }
 629
 630
 631
 632 void Entity_constructMenu(GtkMenu* menu)
 633 {
 634   create_menu_item_with_mnemonic(menu, "_Regroup", "GroupSelection");
 635   create_menu_item_with_mnemonic(menu, "_Ungroup", "UngroupSelection");
 636   create_menu_item_with_mnemonic(menu, "_Connect", "ConnectSelection");
 637   create_menu_item_with_mnemonic(menu, "_KillConnect", "KillConnectSelection");
 638   create_menu_item_with_mnemonic(menu, "_Select Color...", "EntityColor");
 639   create_menu_item_with_mnemonic(menu, "_Normalize Color...", "NormalizeColor");
 640 }
 641
 642
 643
 644 #include "preferencesystem.h"
 645 #include "stringio.h"
 646
 647 void Entity_Construct()
 648 {
 649   GlobalCommands_insert("EntityColor", FreeCaller<Entity_setColour>(), Accelerator('K'));
 650   GlobalCommands_insert("NormalizeColor", FreeCaller<Entity_normalizeColor>());
 651   GlobalCommands_insert("ConnectSelection", FreeCaller<Entity_connectSelected>(), Accelerator('K', (GdkModifierType)GDK_CONTROL_MASK));
 652   GlobalCommands_insert("KillConnectSelection", FreeCaller<Entity_killconnectSelected>(), Accelerator('K', (GdkModifierType)(GDK_SHIFT_MASK)));
 653   GlobalCommands_insert("GroupSelection", FreeCaller<Entity_groupSelected>());
 654   GlobalCommands_insert("UngroupSelection", FreeCaller<Entity_ungroupSelected>());
 655
 656   GlobalPreferenceSystem().registerPreference("SI_Colors5", Vector3ImportStringCaller(g_entity_globals.color_entity), Vector3ExportStringCaller(g_entity_globals.color_entity));
 657   GlobalPreferenceSystem().registerPreference("LastLightIntensity", IntImportStringCaller(g_iLastLightIntensity), IntExportStringCaller(g_iLastLightIntensity));
 658
 659   Entity_registerPreferencesPage();
 660 }
 661
 662 void Entity_Destroy()
 663 {
 664 }
 665