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