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