added buffering to minimise GtkTextBuffer insert calls
[xonotic/netradiant.git] / plugins / entity / entity.cpp
1 /*
2 Copyright (C) 2001-2006, William Joseph.
3 All Rights Reserved.
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 "ifilter.h"
25 #include "selectable.h"
26 #include "namespace.h"
27
28 #include "scenelib.h"
29 #include "entitylib.h"
30 #include "eclasslib.h"
31 #include "pivot.h"
32
33 #include "targetable.h"
34 #include "uniquenames.h"
35 #include "namekeys.h"
36 #include "stream/stringstream.h"
37 #include "filters.h"
38
39
40 #include "miscmodel.h"
41 #include "light.h"
42 #include "group.h"
43 #include "eclassmodel.h"
44 #include "generic.h"
45 #include "doom3group.h"
46
47
48
49 EGameType g_gameType;
50
51 inline scene::Node& entity_for_eclass(EntityClass* eclass)
52 {
53   if(classname_equal(eclass->name(), "misc_model")
54   || classname_equal(eclass->name(), "misc_gamemodel")
55   || classname_equal(eclass->name(), "model_static"))
56   {
57     return New_MiscModel(eclass);
58   }
59   else if(classname_equal(eclass->name(), "light")
60     || classname_equal(eclass->name(), "lightJunior"))
61   {
62     return New_Light(eclass);
63   }
64   if(!eclass->fixedsize)
65   {
66     if(g_gameType == eGameTypeDoom3)
67     {
68       return New_Doom3Group(eclass);
69     }
70     else
71     {
72       return New_Group(eclass);
73     }
74   }
75   else if(!string_empty(eclass->modelpath()))
76   {
77     return New_EclassModel(eclass);
78   }
79   else
80   {
81     return New_GenericEntity(eclass);
82   }
83 }
84
85 void Entity_setName(Entity& entity, const char* name)
86 {
87   entity.setKeyValue("name", name);
88 }
89 typedef ReferenceCaller1<Entity, const char*, Entity_setName> EntitySetNameCaller;
90
91 inline Namespaced* Node_getNamespaced(scene::Node& node)
92 {
93   return NodeTypeCast<Namespaced>::cast(node);
94 }
95
96 inline scene::Node& node_for_eclass(EntityClass* eclass)
97 {
98   scene::Node& node = entity_for_eclass(eclass);
99   Node_getEntity(node)->setKeyValue("classname", eclass->name());
100
101   if(g_gameType == eGameTypeDoom3
102     && string_not_empty(eclass->name())
103     && !string_equal(eclass->name(), "worldspawn")
104     && !string_equal(eclass->name(), "UNKNOWN_CLASS"))
105   {
106     char buffer[1024];
107     strcpy(buffer, eclass->name());
108     strcat(buffer, "_1");
109     GlobalNamespace().makeUnique(buffer, EntitySetNameCaller(*Node_getEntity(node)));
110   }
111
112   Namespaced* namespaced = Node_getNamespaced(node);
113   if(namespaced != 0)
114   {
115     namespaced->setNamespace(GlobalNamespace());
116   }
117
118   return node;
119 }
120
121 EntityCreator::KeyValueChangedFunc EntityKeyValues::m_entityKeyValueChanged = 0;
122 EntityCreator::KeyValueChangedFunc KeyValue::m_entityKeyValueChanged = 0;
123 Counter* EntityKeyValues::m_counter = 0;
124
125 bool g_showNames = true;
126 bool g_showAngles = true;
127 bool g_newLightDraw = true;
128 bool g_lightRadii = false;
129
130 class ConnectEntities
131 {
132 public:
133   Entity* m_e1;
134   Entity* m_e2;
135   ConnectEntities(Entity* e1, Entity* e2) : m_e1(e1), m_e2(e2)
136   {
137   }
138   void connect(const char* name)
139   {
140           m_e1->setKeyValue("target", name);
141           m_e2->setKeyValue("targetname", name);
142   }
143   typedef MemberCaller1<ConnectEntities, const char*, &ConnectEntities::connect> ConnectCaller;
144 };
145
146 inline Entity* ScenePath_getEntity(const scene::Path& path)
147 {
148   Entity* entity = Node_getEntity(path.top());
149   if(entity == 0)
150   {
151     entity = Node_getEntity(path.parent());
152   }
153   return entity;
154 }
155
156 class Quake3EntityCreator : public EntityCreator
157 {
158 public:
159   scene::Node& createEntity(EntityClass* eclass)
160   {
161     return node_for_eclass(eclass);
162   }
163   void setKeyValueChangedFunc(KeyValueChangedFunc func)
164   {
165     EntityKeyValues::setKeyValueChangedFunc(func);
166   }
167   void setCounter(Counter* counter)
168   {
169     EntityKeyValues::setCounter(counter);
170   }
171   void connectEntities(const scene::Path& path, const scene::Path& targetPath)
172   {
173     Entity* e1 = ScenePath_getEntity(path);
174     Entity* e2 = ScenePath_getEntity(targetPath);
175
176     if(e1 == 0 || e2 == 0)
177     {
178       globalErrorStream() << "entityConnectSelected: both of the selected instances must be an entity\n";
179       return;
180     }
181
182     if(e1 == e2)
183     {
184       globalErrorStream() << "entityConnectSelected: the selected instances must not both be from the same entity\n";
185       return;
186     }
187
188
189     UndoableCommand undo("entityConnectSelected");
190
191     if(g_gameType == eGameTypeDoom3)
192     {
193       StringOutputStream key(16);
194       for(unsigned int i = 0; ; ++i)
195       {
196         key << "target";
197         if(i != 0)
198         {
199            key << i;
200         }
201         const char* value = e1->getKeyValue(key.c_str());
202         if(string_empty(value))
203         {
204           e1->setKeyValue(key.c_str(), e2->getKeyValue("name"));
205           break;
206         }
207         key.clear();
208       }
209     }
210     else
211     {
212       ConnectEntities connector(e1, e2);
213       const char* value = e2->getKeyValue("targetname");
214       if(string_empty(value))
215       {
216         value = e1->getKeyValue("target");
217       }
218       if(!string_empty(value))
219       {
220         connector.connect(value);
221       }
222       else
223       {
224         const char* type = e2->getKeyValue("classname");
225         if(string_empty(type))
226         {
227           type = "t";
228         }
229         StringOutputStream key(64);
230         key << type << "1";
231         GlobalNamespace().makeUnique(key.c_str(), ConnectEntities::ConnectCaller(connector));
232       }
233     }
234
235     SceneChangeNotify();
236   }
237   void setLightRadii(bool lightRadii)
238   {
239     g_lightRadii = lightRadii;
240   }
241   bool getLightRadii()
242   {
243     return g_lightRadii;
244   }
245   void setShowNames(bool showNames)
246   {
247     g_showNames = showNames;
248   }
249   bool getShowNames()
250   {
251     return g_showNames;
252   }
253   void setShowAngles(bool showAngles)
254   {
255     g_showAngles = showAngles;
256   }
257   bool getShowAngles()
258   {
259     return g_showAngles;
260   }
261 };
262
263 Quake3EntityCreator g_Quake3EntityCreator;
264
265 EntityCreator& GetEntityCreator()
266 {
267   return g_Quake3EntityCreator;
268 }
269
270
271
272 class filter_entity_classname : public EntityFilter
273 {
274   const char* m_classname;
275 public:
276   filter_entity_classname(const char* classname) : m_classname(classname)
277   {
278   }
279   bool filter(const Entity& entity) const
280   {
281     return string_equal(entity.getKeyValue("classname"), m_classname);
282   }
283 };
284
285 class filter_entity_classgroup : public EntityFilter
286 {
287   const char* m_classgroup;
288   std::size_t m_length;
289 public:
290   filter_entity_classgroup(const char* classgroup) : m_classgroup(classgroup), m_length(string_length(m_classgroup))
291   {
292   }
293   bool filter(const Entity& entity) const
294   {
295     return string_equal_n(entity.getKeyValue("classname"), m_classgroup, m_length);
296   }
297 };
298
299 filter_entity_classname g_filter_entity_world("worldspawn");
300 filter_entity_classname g_filter_entity_func_group("func_group");
301 filter_entity_classname g_filter_entity_light("light");
302 filter_entity_classname g_filter_entity_misc_model("misc_model");
303 filter_entity_classgroup g_filter_entity_trigger("trigger_");
304 filter_entity_classgroup g_filter_entity_path("path_");
305
306 class filter_entity_doom3model : public EntityFilter
307 {
308 public:
309   bool filter(const Entity& entity) const
310   {
311     return string_equal(entity.getKeyValue("classname"), "func_static")
312       && !string_equal(entity.getKeyValue("model"), entity.getKeyValue("name"));
313   }
314 };
315
316 filter_entity_doom3model g_filter_entity_doom3model;
317
318
319 void Entity_InitFilters()
320 {
321         add_entity_filter(g_filter_entity_world, EXCLUDE_WORLD);
322         add_entity_filter(g_filter_entity_func_group, EXCLUDE_WORLD);
323         add_entity_filter(g_filter_entity_world, EXCLUDE_ENT, true);
324   add_entity_filter(g_filter_entity_trigger, EXCLUDE_TRIGGERS);
325         add_entity_filter(g_filter_entity_misc_model, EXCLUDE_MODELS);
326         add_entity_filter(g_filter_entity_doom3model, EXCLUDE_MODELS);
327         add_entity_filter(g_filter_entity_light, EXCLUDE_LIGHTS);
328         add_entity_filter(g_filter_entity_path, EXCLUDE_PATHS);
329 }
330
331
332 #include "preferencesystem.h"
333
334 void Entity_Construct(EGameType gameType)
335 {
336   g_gameType = gameType;
337   if(g_gameType == eGameTypeDoom3)
338   {
339     g_targetable_nameKey = "name";
340
341     Static<KeyIsName>::instance().m_keyIsName = keyIsNameDoom3;
342     Static<KeyIsName>::instance().m_nameKey = "name";
343   }
344   else
345   {
346     Static<KeyIsName>::instance().m_keyIsName = keyIsNameQuake3;
347     Static<KeyIsName>::instance().m_nameKey = "targetname";
348   }
349
350   GlobalPreferenceSystem().registerPreference("SI_ShowNames", BoolImportStringCaller(g_showNames), BoolExportStringCaller(g_showNames));
351   GlobalPreferenceSystem().registerPreference("SI_ShowAngles", BoolImportStringCaller(g_showAngles), BoolExportStringCaller(g_showAngles));
352   GlobalPreferenceSystem().registerPreference("NewLightStyle", BoolImportStringCaller(g_newLightDraw), BoolExportStringCaller(g_newLightDraw));
353   GlobalPreferenceSystem().registerPreference("LightRadiuses", BoolImportStringCaller(g_lightRadii), BoolExportStringCaller(g_lightRadii));
354
355   Entity_InitFilters();
356   LightType lightType = LIGHTTYPE_DEFAULT;
357   if(g_gameType == eGameTypeRTCW)
358   {
359     lightType = LIGHTTYPE_RTCW;
360   }
361   else if(g_gameType == eGameTypeDoom3)
362   {
363     lightType = LIGHTTYPE_DOOM3;
364   }
365   Light_Construct(lightType);
366   MiscModel_construct();
367   Doom3Group_construct();
368
369   RenderablePivot::StaticShader::instance() = GlobalShaderCache().capture("$PIVOT");
370
371   GlobalShaderCache().attachRenderable(StaticRenderableConnectionLines::instance());
372 }
373
374 void Entity_Destroy()
375 {
376   GlobalShaderCache().detachRenderable(StaticRenderableConnectionLines::instance());
377
378   GlobalShaderCache().release("$PIVOT");
379
380   Doom3Group_destroy();
381   MiscModel_destroy();
382   Light_Destroy();
383 }