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
23 ///\brief Represents any entity which has a fixed size specified in its entity-definition and does not display a model (e.g. info_player_start).
25 /// This entity displays an axis-aligned bounding box of the size and colour specified in its entity-definition.
26 /// The "origin" key directly controls the entity's local-to-parent transform.
27 /// An arrow is drawn to visualise the "angle" key.
30 #include "renderable.h"
33 #include "math/frustum.h"
34 #include "selectionlib.h"
35 #include "instancelib.h"
36 #include "transformlib.h"
37 #include "entitylib.h"
39 #include "eclasslib.h"
40 #include "math/line.h"
42 #include "targetable.h"
46 #include "namedentity.h"
47 #include "keyobservers.h"
54 class RenderableArrow : public OpenGLRenderable
56 const Vector3& m_origin;
57 const Vector3& m_angles;
60 RenderableArrow(const Vector3& origin, const Vector3& angles)
61 : m_origin(origin), m_angles(angles)
65 void render(RenderStateFlags state) const
67 Matrix4 mat = matrix4_rotation_for_euler_xyz_degrees(m_angles);
68 arrow_draw(m_origin, matrix4_transformed_direction(mat, Vector3(1, 0, 0)), matrix4_transformed_direction(mat, Vector3(0, 1, 0)), matrix4_transformed_direction(mat, Vector3(0, 0, 1)));
72 inline void read_aabb(AABB& aabb, const EntityClass& eclass)
74 aabb = aabb_for_minmax(eclass.mins, eclass.maxs);
83 EntityKeyValues m_entity;
84 KeyObserverMap m_keyObservers;
85 MatrixTransform m_transform;
87 OriginKey m_originKey;
89 AnglesKey m_anglesKey;
92 ClassnameFilter m_filter;
98 RenderableArrow m_arrow;
99 RenderableSolidAABB m_aabb_solid;
100 RenderableWireframeAABB m_aabb_wire;
101 RenderableNamedEntity m_renderName;
103 Callback m_transformChanged;
104 Callback m_evaluateTransform;
108 read_aabb(m_aabb_local, m_entity.getEntityClass());
110 m_keyObservers.insert("classname", ClassnameFilter::ClassnameChangedCaller(m_filter));
111 m_keyObservers.insert(Static<KeyIsName>::instance().m_nameKey, NamedEntity::IdentifierChangedCaller(m_named));
112 m_keyObservers.insert("angle", AnglesKey::AngleChangedCaller(m_anglesKey));
113 m_keyObservers.insert("angles", AnglesKey::AnglesChangedCaller(m_anglesKey));
114 m_keyObservers.insert("origin", OriginKey::OriginChangedCaller(m_originKey));
117 // vc 2k5 compiler fix
122 void updateTransform()
124 m_transform.localToParent() = g_matrix4_identity;
125 matrix4_translate_by_vec3(m_transform.localToParent(), m_origin);
126 m_transformChanged();
128 typedef MemberCaller<GenericEntity, &GenericEntity::updateTransform> UpdateTransformCaller;
131 m_origin = m_originKey.m_origin;
134 typedef MemberCaller<GenericEntity, &GenericEntity::originChanged> OriginChangedCaller;
137 m_angles = m_anglesKey.m_angles;
140 typedef MemberCaller<GenericEntity, &GenericEntity::anglesChanged> AnglesChangedCaller;
143 GenericEntity(EntityClass* eclass, scene::Node& node, const Callback& transformChanged, const Callback& evaluateTransform) :
145 m_originKey(OriginChangedCaller(*this)),
146 m_origin(ORIGINKEY_IDENTITY),
147 m_anglesKey(AnglesChangedCaller(*this)),
148 m_angles(ANGLESKEY_IDENTITY),
149 m_filter(m_entity, node),
151 m_nameKeys(m_entity),
152 m_arrow(m_aabb_local.origin, m_angles),
153 m_aabb_solid(m_aabb_local),
154 m_aabb_wire(m_aabb_local),
155 m_renderName(m_named, g_vector3_identity),
156 m_transformChanged(transformChanged),
157 m_evaluateTransform(evaluateTransform)
161 GenericEntity(const GenericEntity& other, scene::Node& node, const Callback& transformChanged, const Callback& evaluateTransform) :
162 m_entity(other.m_entity),
163 m_originKey(OriginChangedCaller(*this)),
164 m_origin(ORIGINKEY_IDENTITY),
165 m_anglesKey(AnglesChangedCaller(*this)),
166 m_angles(ANGLESKEY_IDENTITY),
167 m_filter(m_entity, node),
169 m_nameKeys(m_entity),
170 m_arrow(m_aabb_local.origin, m_angles),
171 m_aabb_solid(m_aabb_local),
172 m_aabb_wire(m_aabb_local),
173 m_renderName(m_named, g_vector3_identity),
174 m_transformChanged(transformChanged),
175 m_evaluateTransform(evaluateTransform)
180 InstanceCounter m_instanceCounter;
181 void instanceAttach(const scene::Path& path)
183 if(++m_instanceCounter.m_count == 1)
185 m_filter.instanceAttach();
186 m_entity.instanceAttach(path_find_mapfile(path.begin(), path.end()));
187 m_entity.attach(m_keyObservers);
190 void instanceDetach(const scene::Path& path)
192 if(--m_instanceCounter.m_count == 0)
194 m_entity.detach(m_keyObservers);
195 m_entity.instanceDetach(path_find_mapfile(path.begin(), path.end()));
196 m_filter.instanceDetach();
200 EntityKeyValues& getEntity()
204 const EntityKeyValues& getEntity() const
209 Namespaced& getNamespaced()
213 Nameable& getNameable()
217 TransformNode& getTransformNode()
222 const AABB& localAABB() const
227 VolumeIntersectionValue intersectVolume(const VolumeTest& volume, const Matrix4& localToWorld) const
229 return volume.TestAABB(localAABB(), localToWorld);
232 void renderArrow(Renderer& renderer, const VolumeTest& volume, const Matrix4& localToWorld) const
236 renderer.addRenderable(m_arrow, localToWorld);
239 void renderSolid(Renderer& renderer, const VolumeTest& volume, const Matrix4& localToWorld) const
241 renderer.SetState(m_entity.getEntityClass().m_state_fill, Renderer::eFullMaterials);
242 renderer.addRenderable(m_aabb_solid, localToWorld);
243 renderArrow(renderer, volume, localToWorld);
245 void renderWireframe(Renderer& renderer, const VolumeTest& volume, const Matrix4& localToWorld) const
247 renderer.SetState(m_entity.getEntityClass().m_state_wire, Renderer::eWireframeOnly);
248 renderer.addRenderable(m_aabb_wire, localToWorld);
249 renderArrow(renderer, volume, localToWorld);
252 renderer.addRenderable(m_renderName, localToWorld);
257 void testSelect(Selector& selector, SelectionTest& test, const Matrix4& localToWorld)
259 test.BeginMesh(localToWorld);
261 SelectionIntersection best;
262 aabb_testselect(m_aabb_local, test, best);
265 selector.addIntersection(best);
269 void translate(const Vector3& translation)
271 m_origin = origin_translated(m_origin, translation);
273 void rotate(const Quaternion& rotation)
275 m_angles = angles_rotated(m_angles, rotation);
277 void snapto(float snap)
279 m_originKey.m_origin = origin_snapped(m_originKey.m_origin, snap);
280 m_originKey.write(&m_entity);
282 void revertTransform()
284 m_origin = m_originKey.m_origin;
285 m_angles = m_anglesKey.m_angles;
287 void freezeTransform()
289 m_originKey.m_origin = m_origin;
290 m_originKey.write(&m_entity);
291 m_anglesKey.m_angles = m_angles;
292 m_anglesKey.write(&m_entity);
294 void transformChanged()
297 m_evaluateTransform();
300 typedef MemberCaller<GenericEntity, &GenericEntity::transformChanged> TransformChangedCaller;
303 class GenericEntityInstance :
304 public TargetableInstance,
305 public TransformModifier,
307 public SelectionTestable
311 InstanceTypeCastTable m_casts;
315 m_casts = TargetableInstance::StaticTypeCasts::instance().get();
316 InstanceContainedCast<GenericEntityInstance, Bounded>::install(m_casts);
317 InstanceContainedCast<GenericEntityInstance, Cullable>::install(m_casts);
318 InstanceStaticCast<GenericEntityInstance, Renderable>::install(m_casts);
319 InstanceStaticCast<GenericEntityInstance, SelectionTestable>::install(m_casts);
320 InstanceStaticCast<GenericEntityInstance, Transformable>::install(m_casts);
321 InstanceIdentityCast<GenericEntityInstance>::install(m_casts);
323 InstanceTypeCastTable& get()
329 GenericEntity& m_contained;
330 mutable AABB m_bounds;
333 typedef LazyStatic<TypeCasts> StaticTypeCasts;
335 Bounded& get(NullType<Bounded>)
339 Cullable& get(NullType<Cullable>)
344 STRING_CONSTANT(Name, "GenericEntityInstance");
346 GenericEntityInstance(const scene::Path& path, scene::Instance* parent, GenericEntity& contained) :
347 TargetableInstance(path, parent, this, StaticTypeCasts::instance().get(), contained.getEntity(), *this),
348 TransformModifier(GenericEntity::TransformChangedCaller(contained), ApplyTransformCaller(*this)),
349 m_contained(contained)
351 m_contained.instanceAttach(Instance::path());
353 StaticRenderableConnectionLines::instance().attach(*this);
355 ~GenericEntityInstance()
357 StaticRenderableConnectionLines::instance().detach(*this);
359 m_contained.instanceDetach(Instance::path());
362 void renderSolid(Renderer& renderer, const VolumeTest& volume) const
364 m_contained.renderSolid(renderer, volume, Instance::localToWorld());
366 void renderWireframe(Renderer& renderer, const VolumeTest& volume) const
368 m_contained.renderWireframe(renderer, volume, Instance::localToWorld());
371 void testSelect(Selector& selector, SelectionTest& test)
373 m_contained.testSelect(selector, test, Instance::localToWorld());
376 void evaluateTransform()
378 if(getType() == TRANSFORM_PRIMITIVE)
380 m_contained.translate(getTranslation());
381 m_contained.rotate(getRotation());
384 void applyTransform()
386 m_contained.revertTransform();
388 m_contained.freezeTransform();
390 typedef MemberCaller<GenericEntityInstance, &GenericEntityInstance::applyTransform> ApplyTransformCaller;
393 class GenericEntityNode :
394 public scene::Node::Symbiot,
395 public scene::Instantiable,
396 public scene::Cloneable
400 NodeTypeCastTable m_casts;
404 NodeStaticCast<GenericEntityNode, scene::Instantiable>::install(m_casts);
405 NodeStaticCast<GenericEntityNode, scene::Cloneable>::install(m_casts);
406 NodeContainedCast<GenericEntityNode, Snappable>::install(m_casts);
407 NodeContainedCast<GenericEntityNode, TransformNode>::install(m_casts);
408 NodeContainedCast<GenericEntityNode, Entity>::install(m_casts);
409 NodeContainedCast<GenericEntityNode, Nameable>::install(m_casts);
410 NodeContainedCast<GenericEntityNode, Namespaced>::install(m_casts);
412 NodeTypeCastTable& get()
419 InstanceSet m_instances;
422 GenericEntity m_contained;
425 typedef LazyStatic<TypeCasts> StaticTypeCasts;
427 Snappable& get(NullType<Snappable>)
431 TransformNode& get(NullType<TransformNode>)
433 return m_contained.getTransformNode();
435 Entity& get(NullType<Entity>)
437 return m_contained.getEntity();
439 Nameable& get(NullType<Nameable>)
441 return m_contained.getNameable();
443 Namespaced& get(NullType<Namespaced>)
445 return m_contained.getNamespaced();
448 GenericEntityNode(EntityClass* eclass) :
449 m_node(this, this, StaticTypeCasts::instance().get()),
450 m_contained(eclass, m_node, InstanceSet::TransformChangedCaller(m_instances), InstanceSetEvaluateTransform<GenericEntityInstance>::Caller(m_instances))
453 GenericEntityNode(const GenericEntityNode& other) :
454 scene::Node::Symbiot(other),
455 scene::Instantiable(other),
456 scene::Cloneable(other),
457 m_node(this, this, StaticTypeCasts::instance().get()),
458 m_contained(other.m_contained, m_node, InstanceSet::TransformChangedCaller(m_instances), InstanceSetEvaluateTransform<GenericEntityInstance>::Caller(m_instances))
470 scene::Node& clone() const
472 return (new GenericEntityNode(*this))->node();
475 scene::Instance* create(const scene::Path& path, scene::Instance* parent)
477 return new GenericEntityInstance(path, parent, m_contained);
479 void forEachInstance(const scene::Instantiable::Visitor& visitor)
481 m_instances.forEachInstance(visitor);
483 void insert(scene::Instantiable::Observer* observer, const scene::Path& path, scene::Instance* instance)
485 m_instances.insert(observer, path, instance);
487 scene::Instance* erase(scene::Instantiable::Observer* observer, const scene::Path& path)
489 return m_instances.erase(observer, path);
493 scene::Node& New_GenericEntity(EntityClass* eclass)
495 return (new GenericEntityNode(eclass))->node();