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 {
55 const Vector3 &m_origin;
56 const Vector3 &m_angles;
59 RenderableArrow(const Vector3 &origin, const Vector3 &angles)
60 : m_origin(origin), m_angles(angles)
64 void render(RenderStateFlags state) const
66 Matrix4 mat = matrix4_rotation_for_euler_xyz_degrees(m_angles);
67 arrow_draw(m_origin, matrix4_transformed_direction(mat, Vector3(1, 0, 0)),
68 matrix4_transformed_direction(mat, Vector3(0, 1, 0)),
69 matrix4_transformed_direction(mat, Vector3(0, 0, 1)));
73 inline void read_aabb(AABB &aabb, const EntityClass &eclass)
75 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<void()> m_transformChanged;
104 Callback<void()> 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();
129 typedef MemberCaller<GenericEntity, void(), &GenericEntity::updateTransform> UpdateTransformCaller;
133 m_origin = m_originKey.m_origin;
137 typedef MemberCaller<GenericEntity, void(), &GenericEntity::originChanged> OriginChangedCaller;
141 m_angles = m_anglesKey.m_angles;
145 typedef MemberCaller<GenericEntity, void(), &GenericEntity::anglesChanged> AnglesChangedCaller;
148 GenericEntity(EntityClass *eclass, scene::Node &node, const Callback<void()> &transformChanged,
149 const Callback<void()> &evaluateTransform) :
151 m_originKey(OriginChangedCaller(*this)),
152 m_origin(ORIGINKEY_IDENTITY),
153 m_anglesKey(AnglesChangedCaller(*this)),
154 m_angles(ANGLESKEY_IDENTITY),
155 m_filter(m_entity, node),
157 m_nameKeys(m_entity),
158 m_arrow(m_aabb_local.origin, m_angles),
159 m_aabb_solid(m_aabb_local),
160 m_aabb_wire(m_aabb_local),
161 m_renderName(m_named, g_vector3_identity),
162 m_transformChanged(transformChanged),
163 m_evaluateTransform(evaluateTransform)
168 GenericEntity(const GenericEntity &other, scene::Node &node, const Callback<void()> &transformChanged,
169 const Callback<void()> &evaluateTransform) :
170 m_entity(other.m_entity),
171 m_originKey(OriginChangedCaller(*this)),
172 m_origin(ORIGINKEY_IDENTITY),
173 m_anglesKey(AnglesChangedCaller(*this)),
174 m_angles(ANGLESKEY_IDENTITY),
175 m_filter(m_entity, node),
177 m_nameKeys(m_entity),
178 m_arrow(m_aabb_local.origin, m_angles),
179 m_aabb_solid(m_aabb_local),
180 m_aabb_wire(m_aabb_local),
181 m_renderName(m_named, g_vector3_identity),
182 m_transformChanged(transformChanged),
183 m_evaluateTransform(evaluateTransform)
188 InstanceCounter m_instanceCounter;
190 void instanceAttach(const scene::Path &path)
192 if (++m_instanceCounter.m_count == 1) {
193 m_filter.instanceAttach();
194 m_entity.instanceAttach(path_find_mapfile(path.begin(), path.end()));
195 m_entity.attach(m_keyObservers);
199 void instanceDetach(const scene::Path &path)
201 if (--m_instanceCounter.m_count == 0) {
202 m_entity.detach(m_keyObservers);
203 m_entity.instanceDetach(path_find_mapfile(path.begin(), path.end()));
204 m_filter.instanceDetach();
208 EntityKeyValues &getEntity()
213 const EntityKeyValues &getEntity() const
218 Namespaced &getNamespaced()
223 Nameable &getNameable()
228 TransformNode &getTransformNode()
233 const AABB &localAABB() const
238 VolumeIntersectionValue intersectVolume(const VolumeTest &volume, const Matrix4 &localToWorld) const
240 return volume.TestAABB(localAABB(), localToWorld);
243 void renderArrow(Renderer &renderer, const VolumeTest &volume, const Matrix4 &localToWorld) const
246 renderer.addRenderable(m_arrow, localToWorld);
250 void renderSolid(Renderer &renderer, const VolumeTest &volume, const Matrix4 &localToWorld) const
252 renderer.SetState(m_entity.getEntityClass().m_state_fill, Renderer::eFullMaterials);
253 renderer.addRenderable(m_aabb_solid, localToWorld);
254 renderArrow(renderer, volume, localToWorld);
257 void renderWireframe(Renderer &renderer, const VolumeTest &volume, const Matrix4 &localToWorld) const
259 renderer.SetState(m_entity.getEntityClass().m_state_wire, Renderer::eWireframeOnly);
260 renderer.addRenderable(m_aabb_wire, localToWorld);
261 renderArrow(renderer, volume, localToWorld);
263 renderer.addRenderable(m_renderName, localToWorld);
268 void testSelect(Selector &selector, SelectionTest &test, const Matrix4 &localToWorld)
270 test.BeginMesh(localToWorld);
272 SelectionIntersection best;
273 aabb_testselect(m_aabb_local, test, best);
275 selector.addIntersection(best);
279 void translate(const Vector3 &translation)
281 m_origin = origin_translated(m_origin, translation);
284 void rotate(const Quaternion &rotation)
286 m_angles = angles_rotated(m_angles, rotation);
289 void snapto(float snap)
291 m_originKey.m_origin = origin_snapped(m_originKey.m_origin, snap);
292 m_originKey.write(&m_entity);
295 void revertTransform()
297 m_origin = m_originKey.m_origin;
298 m_angles = m_anglesKey.m_angles;
301 void freezeTransform()
303 m_originKey.m_origin = m_origin;
304 m_originKey.write(&m_entity);
305 m_anglesKey.m_angles = m_angles;
306 m_anglesKey.write(&m_entity);
309 void transformChanged()
312 m_evaluateTransform();
316 typedef MemberCaller<GenericEntity, void(), &GenericEntity::transformChanged> TransformChangedCaller;
319 class GenericEntityInstance :
320 public TargetableInstance,
321 public TransformModifier,
323 public SelectionTestable {
325 InstanceTypeCastTable m_casts;
329 m_casts = TargetableInstance::StaticTypeCasts::instance().get();
330 InstanceContainedCast<GenericEntityInstance, Bounded>::install(m_casts);
331 InstanceContainedCast<GenericEntityInstance, Cullable>::install(m_casts);
332 InstanceStaticCast<GenericEntityInstance, Renderable>::install(m_casts);
333 InstanceStaticCast<GenericEntityInstance, SelectionTestable>::install(m_casts);
334 InstanceStaticCast<GenericEntityInstance, Transformable>::install(m_casts);
335 InstanceIdentityCast<GenericEntityInstance>::install(m_casts);
338 InstanceTypeCastTable &get()
344 GenericEntity &m_contained;
345 mutable AABB m_bounds;
348 typedef LazyStatic<TypeCasts> StaticTypeCasts;
350 Bounded &get(NullType<Bounded>)
355 Cullable &get(NullType<Cullable>)
360 STRING_CONSTANT(Name, "GenericEntityInstance");
362 GenericEntityInstance(const scene::Path &path, scene::Instance *parent, GenericEntity &contained) :
363 TargetableInstance(path, parent, this, StaticTypeCasts::instance().get(), contained.getEntity(), *this),
364 TransformModifier(GenericEntity::TransformChangedCaller(contained), ApplyTransformCaller(*this)),
365 m_contained(contained)
367 m_contained.instanceAttach(Instance::path());
369 StaticRenderableConnectionLines::instance().attach(*this);
372 ~GenericEntityInstance()
374 StaticRenderableConnectionLines::instance().detach(*this);
376 m_contained.instanceDetach(Instance::path());
379 void renderSolid(Renderer &renderer, const VolumeTest &volume) const
381 m_contained.renderSolid(renderer, volume, Instance::localToWorld());
384 void renderWireframe(Renderer &renderer, const VolumeTest &volume) const
386 m_contained.renderWireframe(renderer, volume, Instance::localToWorld());
389 void testSelect(Selector &selector, SelectionTest &test)
391 m_contained.testSelect(selector, test, Instance::localToWorld());
394 void evaluateTransform()
396 if (getType() == TRANSFORM_PRIMITIVE) {
397 m_contained.translate(getTranslation());
398 m_contained.rotate(getRotation());
402 void applyTransform()
404 m_contained.revertTransform();
406 m_contained.freezeTransform();
409 typedef MemberCaller<GenericEntityInstance, void(), &GenericEntityInstance::applyTransform> ApplyTransformCaller;
412 class GenericEntityNode :
413 public scene::Node::Symbiot,
414 public scene::Instantiable,
415 public scene::Cloneable {
417 NodeTypeCastTable m_casts;
421 NodeStaticCast<GenericEntityNode, scene::Instantiable>::install(m_casts);
422 NodeStaticCast<GenericEntityNode, scene::Cloneable>::install(m_casts);
423 NodeContainedCast<GenericEntityNode, Snappable>::install(m_casts);
424 NodeContainedCast<GenericEntityNode, TransformNode>::install(m_casts);
425 NodeContainedCast<GenericEntityNode, Entity>::install(m_casts);
426 NodeContainedCast<GenericEntityNode, Nameable>::install(m_casts);
427 NodeContainedCast<GenericEntityNode, Namespaced>::install(m_casts);
430 NodeTypeCastTable &get()
437 InstanceSet m_instances;
440 GenericEntity m_contained;
443 typedef LazyStatic<TypeCasts> StaticTypeCasts;
445 Snappable &get(NullType<Snappable>)
450 TransformNode &get(NullType<TransformNode>)
452 return m_contained.getTransformNode();
455 Entity &get(NullType<Entity>)
457 return m_contained.getEntity();
460 Nameable &get(NullType<Nameable>)
462 return m_contained.getNameable();
465 Namespaced &get(NullType<Namespaced>)
467 return m_contained.getNamespaced();
470 GenericEntityNode(EntityClass *eclass) :
471 m_node(this, this, StaticTypeCasts::instance().get()),
472 m_contained(eclass, m_node, InstanceSet::TransformChangedCaller(m_instances),
473 InstanceSetEvaluateTransform<GenericEntityInstance>::Caller(m_instances))
477 GenericEntityNode(const GenericEntityNode &other) :
478 scene::Node::Symbiot(other),
479 scene::Instantiable(other),
480 scene::Cloneable(other),
481 m_node(this, this, StaticTypeCasts::instance().get()),
482 m_contained(other.m_contained, m_node, InstanceSet::TransformChangedCaller(m_instances),
483 InstanceSetEvaluateTransform<GenericEntityInstance>::Caller(m_instances))
497 scene::Node &clone() const
499 return (new GenericEntityNode(*this))->node();
502 scene::Instance *create(const scene::Path &path, scene::Instance *parent)
504 return new GenericEntityInstance(path, parent, m_contained);
507 void forEachInstance(const scene::Instantiable::Visitor &visitor)
509 m_instances.forEachInstance(visitor);
512 void insert(scene::Instantiable::Observer *observer, const scene::Path &path, scene::Instance *instance)
514 m_instances.insert(observer, path, instance);
517 scene::Instance *erase(scene::Instantiable::Observer *observer, const scene::Path &path)
519 return m_instances.erase(observer, path);
523 scene::Node &New_GenericEntity(EntityClass *eclass)
525 return (new GenericEntityNode(eclass))->node();