2 Copyright (C) 2001-2006, William Joseph.
5 This file is part of GtkRadiant.
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.
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.
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
22 #if !defined (INCLUDED_ENTITYLIB_H)
23 #define INCLUDED_ENTITYLIB_H
25 #include "ireference.h"
26 #include "debugging/debugging.h"
31 #include "selectable.h"
33 #include "generic/callback.h"
34 #include "math/vector.h"
35 #include "math/aabb.h"
37 #include "string/pooledstring.h"
38 #include "generic/referencecounted.h"
40 #include "container/container.h"
41 #include "eclasslib.h"
46 inline void arrow_draw(const Vector3& origin, const Vector3& direction)
49 Vector3 left(-direction[1], direction[0], 0);
51 Vector3 endpoint(vector3_added(origin, vector3_scaled(direction, 32.0)));
53 Vector3 tip1(vector3_added(vector3_added(endpoint, vector3_scaled(direction, -8.0)), vector3_scaled(up, -4.0)));
54 Vector3 tip2(vector3_added(tip1, vector3_scaled(up, 8.0)));
55 Vector3 tip3(vector3_added(vector3_added(endpoint, vector3_scaled(direction, -8.0)), vector3_scaled(left, -4.0)));
56 Vector3 tip4(vector3_added(tip3, vector3_scaled(left, 8.0)));
60 glVertex3fv(vector3_to_array(origin));
61 glVertex3fv(vector3_to_array(endpoint));
63 glVertex3fv(vector3_to_array(endpoint));
64 glVertex3fv(vector3_to_array(tip1));
66 glVertex3fv(vector3_to_array(endpoint));
67 glVertex3fv(vector3_to_array(tip2));
69 glVertex3fv(vector3_to_array(endpoint));
70 glVertex3fv(vector3_to_array(tip3));
72 glVertex3fv(vector3_to_array(endpoint));
73 glVertex3fv(vector3_to_array(tip4));
75 glVertex3fv(vector3_to_array(tip1));
76 glVertex3fv(vector3_to_array(tip3));
78 glVertex3fv(vector3_to_array(tip3));
79 glVertex3fv(vector3_to_array(tip2));
81 glVertex3fv(vector3_to_array(tip2));
82 glVertex3fv(vector3_to_array(tip4));
84 glVertex3fv(vector3_to_array(tip4));
85 glVertex3fv(vector3_to_array(tip1));
90 class SelectionIntersection;
92 inline void aabb_testselect(const AABB& aabb, SelectionTest& test, SelectionIntersection& best)
94 const IndexPointer::index_type indices[24] = {
104 aabb_corners(aabb, points);
105 test.TestQuads(VertexPointer(reinterpret_cast<VertexPointer::pointer>(points), sizeof(Vector3)), IndexPointer(indices, 24), best);
108 inline void aabb_draw_wire(const Vector3 points[8])
110 typedef std::size_t index_t;
111 index_t indices[24] = {
112 0, 1, 1, 2, 2, 3, 3, 0,
113 4, 5, 5, 6, 6, 7, 7, 4,
114 0, 4, 1, 5, 2, 6, 3, 7,
117 glVertexPointer(3, GL_FLOAT, 0, points);
118 glDrawElements(GL_LINES, sizeof(indices)/sizeof(index_t), GL_UNSIGNED_INT, indices);
121 for(std::size_t i = 0; i < sizeof(indices)/sizeof(index_t); ++i)
123 glVertex3fv(points[indices[i]]);
129 inline void aabb_draw_flatshade(const Vector3 points[8])
133 glNormal3fv(vector3_to_array(aabb_normals[0]));
134 glVertex3fv(vector3_to_array(points[2]));
135 glVertex3fv(vector3_to_array(points[1]));
136 glVertex3fv(vector3_to_array(points[5]));
137 glVertex3fv(vector3_to_array(points[6]));
139 glNormal3fv(vector3_to_array(aabb_normals[1]));
140 glVertex3fv(vector3_to_array(points[1]));
141 glVertex3fv(vector3_to_array(points[0]));
142 glVertex3fv(vector3_to_array(points[4]));
143 glVertex3fv(vector3_to_array(points[5]));
145 glNormal3fv(vector3_to_array(aabb_normals[2]));
146 glVertex3fv(vector3_to_array(points[0]));
147 glVertex3fv(vector3_to_array(points[1]));
148 glVertex3fv(vector3_to_array(points[2]));
149 glVertex3fv(vector3_to_array(points[3]));
151 glNormal3fv(vector3_to_array(aabb_normals[3]));
152 glVertex3fv(vector3_to_array(points[0]));
153 glVertex3fv(vector3_to_array(points[3]));
154 glVertex3fv(vector3_to_array(points[7]));
155 glVertex3fv(vector3_to_array(points[4]));
157 glNormal3fv(vector3_to_array(aabb_normals[4]));
158 glVertex3fv(vector3_to_array(points[3]));
159 glVertex3fv(vector3_to_array(points[2]));
160 glVertex3fv(vector3_to_array(points[6]));
161 glVertex3fv(vector3_to_array(points[7]));
163 glNormal3fv(vector3_to_array(aabb_normals[5]));
164 glVertex3fv(vector3_to_array(points[7]));
165 glVertex3fv(vector3_to_array(points[6]));
166 glVertex3fv(vector3_to_array(points[5]));
167 glVertex3fv(vector3_to_array(points[4]));
172 inline void aabb_draw_wire(const AABB& aabb)
175 aabb_corners(aabb, points);
176 aabb_draw_wire(points);
179 inline void aabb_draw_flatshade(const AABB& aabb)
182 aabb_corners(aabb, points);
183 aabb_draw_flatshade(points);
186 inline void aabb_draw_textured(const AABB& aabb)
189 aabb_corners(aabb, points);
193 glNormal3fv(vector3_to_array(aabb_normals[0]));
194 glTexCoord2fv(aabb_texcoord_topleft);
195 glVertex3fv(vector3_to_array(points[2]));
196 glTexCoord2fv(aabb_texcoord_topright);
197 glVertex3fv(vector3_to_array(points[1]));
198 glTexCoord2fv(aabb_texcoord_botright);
199 glVertex3fv(vector3_to_array(points[5]));
200 glTexCoord2fv(aabb_texcoord_botleft);
201 glVertex3fv(vector3_to_array(points[6]));
203 glNormal3fv(vector3_to_array(aabb_normals[1]));
204 glTexCoord2fv(aabb_texcoord_topleft);
205 glVertex3fv(vector3_to_array(points[1]));
206 glTexCoord2fv(aabb_texcoord_topright);
207 glVertex3fv(vector3_to_array(points[0]));
208 glTexCoord2fv(aabb_texcoord_botright);
209 glVertex3fv(vector3_to_array(points[4]));
210 glTexCoord2fv(aabb_texcoord_botleft);
211 glVertex3fv(vector3_to_array(points[5]));
213 glNormal3fv(vector3_to_array(aabb_normals[2]));
214 glTexCoord2fv(aabb_texcoord_topleft);
215 glVertex3fv(vector3_to_array(points[0]));
216 glTexCoord2fv(aabb_texcoord_topright);
217 glVertex3fv(vector3_to_array(points[1]));
218 glTexCoord2fv(aabb_texcoord_botright);
219 glVertex3fv(vector3_to_array(points[2]));
220 glTexCoord2fv(aabb_texcoord_botleft);
221 glVertex3fv(vector3_to_array(points[3]));
223 glNormal3fv(vector3_to_array(aabb_normals[3]));
224 glTexCoord2fv(aabb_texcoord_topleft);
225 glVertex3fv(vector3_to_array(points[0]));
226 glTexCoord2fv(aabb_texcoord_topright);
227 glVertex3fv(vector3_to_array(points[3]));
228 glTexCoord2fv(aabb_texcoord_botright);
229 glVertex3fv(vector3_to_array(points[7]));
230 glTexCoord2fv(aabb_texcoord_botleft);
231 glVertex3fv(vector3_to_array(points[4]));
233 glNormal3fv(vector3_to_array(aabb_normals[4]));
234 glTexCoord2fv(aabb_texcoord_topleft);
235 glVertex3fv(vector3_to_array(points[3]));
236 glTexCoord2fv(aabb_texcoord_topright);
237 glVertex3fv(vector3_to_array(points[2]));
238 glTexCoord2fv(aabb_texcoord_botright);
239 glVertex3fv(vector3_to_array(points[6]));
240 glTexCoord2fv(aabb_texcoord_botleft);
241 glVertex3fv(vector3_to_array(points[7]));
243 glNormal3fv(vector3_to_array(aabb_normals[5]));
244 glTexCoord2fv(aabb_texcoord_topleft);
245 glVertex3fv(vector3_to_array(points[7]));
246 glTexCoord2fv(aabb_texcoord_topright);
247 glVertex3fv(vector3_to_array(points[6]));
248 glTexCoord2fv(aabb_texcoord_botright);
249 glVertex3fv(vector3_to_array(points[5]));
250 glTexCoord2fv(aabb_texcoord_botleft);
251 glVertex3fv(vector3_to_array(points[4]));
256 inline void aabb_draw_solid(const AABB& aabb, RenderStateFlags state)
258 if(state & RENDER_TEXTURE)
260 aabb_draw_textured(aabb);
264 aabb_draw_flatshade(aabb);
268 inline void aabb_draw(const AABB& aabb, RenderStateFlags state)
270 if(state & RENDER_FILL)
272 aabb_draw_solid(aabb, state);
276 aabb_draw_wire(aabb);
280 class RenderableSolidAABB : public OpenGLRenderable
284 RenderableSolidAABB(const AABB& aabb) : m_aabb(aabb)
287 void render(RenderStateFlags state) const
289 aabb_draw_solid(m_aabb, state);
293 class RenderableWireframeAABB : public OpenGLRenderable
297 RenderableWireframeAABB(const AABB& aabb) : m_aabb(aabb)
300 void render(RenderStateFlags state) const
302 aabb_draw_wire(m_aabb);
307 /// \brief A key/value pair of strings.
309 /// - Notifies observers when value changes - value changes to "" on destruction.
310 /// - Provides undo support through the global undo system.
311 class KeyValue : public EntityKeyValue
313 typedef UnsortedSet<KeyObserver> KeyObservers;
315 std::size_t m_refcount;
316 KeyObservers m_observers;
317 CopiedString m_string;
319 ObservedUndoableObject<CopiedString> m_undo;
320 static EntityCreator::KeyValueChangedFunc m_entityKeyValueChanged;
323 KeyValue(const char* string, const char* empty)
324 : m_refcount(0), m_string(string), m_empty(empty), m_undo(m_string, UndoImportCaller(*this))
330 ASSERT_MESSAGE(m_observers.empty(), "KeyValue::~KeyValue: observers still attached");
333 static void setKeyValueChangedFunc(EntityCreator::KeyValueChangedFunc func)
335 m_entityKeyValueChanged = func;
344 if(--m_refcount == 0)
350 void instanceAttach(MapFile* map)
352 m_undo.instanceAttach(map);
354 void instanceDetach(MapFile* map)
356 m_undo.instanceDetach(map);
359 void attach(const KeyObserver& observer)
361 (*m_observers.insert(observer))(c_str());
363 void detach(const KeyObserver& observer)
366 m_observers.erase(observer);
368 const char* c_str() const
370 if(string_empty(m_string.c_str()))
374 return m_string.c_str();
376 void assign(const char* other)
378 if(!string_equal(m_string.c_str(), other))
388 m_entityKeyValueChanged();
389 KeyObservers::reverse_iterator i = m_observers.rbegin();
390 while(i != m_observers.rend())
396 void importState(const CopiedString& string)
402 typedef MemberCaller1<KeyValue, const CopiedString&, &KeyValue::importState> UndoImportCaller;
405 /// \brief An unsorted list of key/value pairs.
407 /// - Notifies observers when a pair is inserted or removed.
408 /// - Provides undo support through the global undo system.
409 /// - New keys are appended to the end of the list.
410 class EntityKeyValues : public Entity
413 typedef KeyValue Value;
415 static StringPool& getPool()
417 return Static<StringPool, KeyContext>::instance();
420 static EntityCreator::KeyValueChangedFunc m_entityKeyValueChanged;
421 static Counter* m_counter;
423 EntityClass* m_eclass;
426 typedef Static<StringPool, KeyContext> KeyPool;
427 typedef PooledString<KeyPool> Key;
428 typedef SmartPointer<KeyValue> KeyValuePtr;
429 typedef UnsortedMap<Key, KeyValuePtr> KeyValues;
430 KeyValues m_keyValues;
432 typedef UnsortedSet<Observer*> Observers;
433 Observers m_observers;
435 ObservedUndoableObject<KeyValues> m_undo;
438 bool m_observerMutex;
440 void notifyInsert(const char* key, Value& value)
442 m_observerMutex = true;
443 for(Observers::iterator i = m_observers.begin(); i != m_observers.end(); ++i)
445 (*i)->insert(key, value);
447 m_observerMutex = false;
449 void notifyErase(const char* key, Value& value)
451 m_observerMutex = true;
452 for(Observers::iterator i = m_observers.begin(); i != m_observers.end(); ++i)
454 (*i)->erase(key, value);
456 m_observerMutex = false;
458 void forEachKeyValue_notifyInsert()
460 for(KeyValues::const_iterator i = m_keyValues.begin(); i != m_keyValues.end(); ++i)
462 notifyInsert((*i).first.c_str(), *(*i).second);
465 void forEachKeyValue_notifyErase()
467 for(KeyValues::const_iterator i = m_keyValues.begin(); i != m_keyValues.end(); ++i)
469 notifyErase((*i).first.c_str(), *(*i).second);
473 void insert(const char* key, const KeyValuePtr& keyValue)
475 KeyValues::iterator i = m_keyValues.insert(KeyValues::value_type(key, keyValue));
476 notifyInsert(key, *(*i).second);
480 (*i).second->instanceAttach(m_undo.map());
484 void insert(const char* key, const char* value)
486 KeyValues::iterator i = m_keyValues.find(key);
487 if(i != m_keyValues.end())
489 (*i).second->assign(value);
494 insert(key, KeyValuePtr(new KeyValue(value, EntityClass_valueForKey(*m_eclass, key))));
498 void erase(KeyValues::iterator i)
502 (*i).second->instanceDetach(m_undo.map());
506 KeyValuePtr value((*i).second);
507 m_keyValues.erase(i);
508 notifyErase(key.c_str(), *value);
511 void erase(const char* key)
513 KeyValues::iterator i = m_keyValues.find(key);
514 if(i != m_keyValues.end())
524 EntityKeyValues(EntityClass* eclass) :
526 m_undo(m_keyValues, UndoImportCaller(*this)),
528 m_observerMutex(false),
529 m_isContainer(!eclass->fixedsize)
532 EntityKeyValues(const EntityKeyValues& other) :
534 m_eclass(&other.getEntityClass()),
535 m_undo(m_keyValues, UndoImportCaller(*this)),
537 m_observerMutex(false),
538 m_isContainer(other.m_isContainer)
540 for(KeyValues::const_iterator i = other.m_keyValues.begin(); i != other.m_keyValues.end(); ++i)
542 insert((*i).first.c_str(), (*i).second->c_str());
547 for(Observers::iterator i = m_observers.begin(); i != m_observers.end();)
549 // post-increment to allow current element to be removed safely
552 ASSERT_MESSAGE(m_observers.empty(), "EntityKeyValues::~EntityKeyValues: observers still attached");
555 static void setKeyValueChangedFunc(EntityCreator::KeyValueChangedFunc func)
557 m_entityKeyValueChanged = func;
558 KeyValue::setKeyValueChangedFunc(func);
560 static void setCounter(Counter* counter)
565 void importState(const KeyValues& keyValues)
567 for(KeyValues::iterator i = m_keyValues.begin(); i != m_keyValues.end();)
572 for(KeyValues::const_iterator i = keyValues.begin(); i != keyValues.end(); ++i)
574 insert((*i).first.c_str(), (*i).second);
577 m_entityKeyValueChanged();
579 typedef MemberCaller1<EntityKeyValues, const KeyValues&, &EntityKeyValues::importState> UndoImportCaller;
581 void attach(Observer& observer)
583 ASSERT_MESSAGE(!m_observerMutex, "observer cannot be attached during iteration");
584 m_observers.insert(&observer);
585 for(KeyValues::const_iterator i = m_keyValues.begin(); i != m_keyValues.end(); ++i)
587 observer.insert((*i).first.c_str(), *(*i).second);
590 void detach(Observer& observer)
592 ASSERT_MESSAGE(!m_observerMutex, "observer cannot be detached during iteration");
593 m_observers.erase(&observer);
594 for(KeyValues::const_iterator i = m_keyValues.begin(); i != m_keyValues.end(); ++i)
596 observer.erase((*i).first.c_str(), *(*i).second);
600 void forEachKeyValue_instanceAttach(MapFile* map)
602 for(KeyValues::const_iterator i = m_keyValues.begin(); i != m_keyValues.end(); ++i)
604 (*i).second->instanceAttach(map);
607 void forEachKeyValue_instanceDetach(MapFile* map)
609 for(KeyValues::const_iterator i = m_keyValues.begin(); i != m_keyValues.end(); ++i)
611 (*i).second->instanceDetach(map);
615 void instanceAttach(MapFile* map)
619 m_counter->increment();
623 forEachKeyValue_instanceAttach(map);
624 m_undo.instanceAttach(map);
626 void instanceDetach(MapFile* map)
630 m_counter->decrement();
633 m_undo.instanceDetach(map);
634 forEachKeyValue_instanceDetach(map);
639 EntityClass& getEntityClass() const
643 void forEachKeyValue(Visitor& visitor) const
645 for(KeyValues::const_iterator i = m_keyValues.begin(); i != m_keyValues.end(); ++i)
647 visitor.visit((*i).first.c_str(), (*i).second->c_str());
650 void setKeyValue(const char* key, const char* value)
653 /*|| string_equal(EntityClass_valueForKey(*m_eclass, key), value)*/) // don't delete values equal to default
661 m_entityKeyValueChanged();
663 const char* getKeyValue(const char* key) const
665 KeyValues::const_iterator i = m_keyValues.find(key);
666 if(i != m_keyValues.end())
668 return (*i).second->c_str();
671 return EntityClass_valueForKey(*m_eclass, key);
674 bool isContainer() const
676 return m_isContainer;
680 /// \brief A Resource reference with a controlled lifetime.
681 /// \brief The resource is released when the ResourceReference is destroyed.
682 class ResourceReference
685 Resource* m_resource;
687 ResourceReference(const char* name)
692 ResourceReference(const ResourceReference& other)
693 : m_name(other.m_name)
697 ResourceReference& operator=(const ResourceReference& other)
699 ResourceReference tmp(other);
710 m_resource = GlobalReferenceCache().capture(m_name.c_str());
714 GlobalReferenceCache().release(m_name.c_str());
717 const char* getName() const
719 return m_name.c_str();
721 void setName(const char* name)
723 ResourceReference tmp(name);
727 void swap(ResourceReference& other)
729 std::swap(m_resource, other.m_resource);
730 std::swap(m_name, other.m_name);
733 void attach(ModuleObserver& observer)
735 m_resource->attach(observer);
737 void detach(ModuleObserver& observer)
739 m_resource->detach(observer);
750 /// \brief Swaps the values of \p self and \p other.
751 /// Overloads std::swap.
752 inline void swap(ResourceReference& self, ResourceReference& other)