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