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 displays a model (e.g. ammo_bfg).
25 /// This entity displays the model specified in its entity-definition.
26 /// The "origin" and "angle" keys directly control the entity's local-to-parent transform.
27 /// The "rotation" key directly controls the entity's local-to-parent transform for Doom3 only.
29 #include "eclassmodel.h"
32 #include "renderable.h"
35 #include "selectionlib.h"
36 #include "instancelib.h"
37 #include "transformlib.h"
38 #include "traverselib.h"
39 #include "entitylib.h"
41 #include "eclasslib.h"
44 #include "targetable.h"
50 #include "namedentity.h"
51 #include "keyobservers.h"
53 #include "modelskinkey.h"
60 MatrixTransform m_transform;
61 EntityKeyValues m_entity;
62 KeyObserverMap m_keyObservers;
64 OriginKey m_originKey;
68 RotationKey m_rotationKey;
70 SingletonModel m_model;
72 ClassnameFilter m_filter;
75 RenderablePivot m_renderOrigin;
76 RenderableNamedEntity m_renderName;
79 Callback m_transformChanged;
80 Callback m_evaluateTransform;
84 default_rotation(m_rotation);
86 m_keyObservers.insert("classname", ClassnameFilter::ClassnameChangedCaller(m_filter));
87 m_keyObservers.insert(Static<KeyIsName>::instance().m_nameKey, NamedEntity::IdentifierChangedCaller(m_named));
88 if(g_gameType == eGameTypeDoom3)
90 m_keyObservers.insert("angle", RotationKey::AngleChangedCaller(m_rotationKey));
91 m_keyObservers.insert("rotation", RotationKey::RotationChangedCaller(m_rotationKey));
95 m_keyObservers.insert("angle", AngleKey::AngleChangedCaller(m_angleKey));
97 m_keyObservers.insert("origin", OriginKey::OriginChangedCaller(m_originKey));
100 // vc 2k5 compiler fix
105 void updateTransform()
107 m_transform.localToParent() = g_matrix4_identity;
108 matrix4_translate_by_vec3(m_transform.localToParent(), m_origin);
110 if(g_gameType == eGameTypeDoom3)
112 matrix4_multiply_by_matrix4(m_transform.localToParent(), rotation_toMatrix(m_rotation));
116 matrix4_multiply_by_matrix4(m_transform.localToParent(), matrix4_rotation_for_z_degrees(m_angle));
119 m_transformChanged();
121 typedef MemberCaller<EclassModel, &EclassModel::updateTransform> UpdateTransformCaller;
125 m_origin = m_originKey.m_origin;
128 typedef MemberCaller<EclassModel, &EclassModel::originChanged> OriginChangedCaller;
131 m_angle = m_angleKey.m_angle;
134 typedef MemberCaller<EclassModel, &EclassModel::angleChanged> AngleChangedCaller;
135 void rotationChanged()
137 rotation_assign(m_rotation, m_rotationKey.m_rotation);
140 typedef MemberCaller<EclassModel, &EclassModel::rotationChanged> RotationChangedCaller;
144 scene::Node* node = m_model.getNode();
147 Node_modelSkinChanged(*node);
150 typedef MemberCaller<EclassModel, &EclassModel::skinChanged> SkinChangedCaller;
154 EclassModel(EntityClass* eclass, scene::Node& node, const Callback& transformChanged, const Callback& evaluateTransform) :
156 m_originKey(OriginChangedCaller(*this)),
157 m_origin(ORIGINKEY_IDENTITY),
158 m_angleKey(AngleChangedCaller(*this)),
159 m_angle(ANGLEKEY_IDENTITY),
160 m_rotationKey(RotationChangedCaller(*this)),
161 m_filter(m_entity, node),
163 m_nameKeys(m_entity),
164 m_renderName(m_named, g_vector3_identity),
165 m_skin(SkinChangedCaller(*this)),
166 m_transformChanged(transformChanged),
167 m_evaluateTransform(evaluateTransform)
171 EclassModel(const EclassModel& other, scene::Node& node, const Callback& transformChanged, const Callback& evaluateTransform) :
172 m_entity(other.m_entity),
173 m_originKey(OriginChangedCaller(*this)),
174 m_origin(ORIGINKEY_IDENTITY),
175 m_angleKey(AngleChangedCaller(*this)),
176 m_angle(ANGLEKEY_IDENTITY),
177 m_rotationKey(RotationChangedCaller(*this)),
178 m_filter(m_entity, node),
180 m_nameKeys(m_entity),
181 m_renderName(m_named, g_vector3_identity),
182 m_skin(SkinChangedCaller(*this)),
183 m_transformChanged(transformChanged),
184 m_evaluateTransform(evaluateTransform)
189 InstanceCounter m_instanceCounter;
190 void instanceAttach(const scene::Path& path)
192 if(++m_instanceCounter.m_count == 1)
194 m_filter.instanceAttach();
195 m_entity.instanceAttach(path_find_mapfile(path.begin(), path.end()));
196 m_entity.attach(m_keyObservers);
197 m_model.modelChanged(m_entity.getEntityClass().modelpath());
198 m_skin.skinChanged(m_entity.getEntityClass().skin());
201 void instanceDetach(const scene::Path& path)
203 if(--m_instanceCounter.m_count == 0)
205 m_skin.skinChanged("");
206 m_model.modelChanged("");
207 m_entity.detach(m_keyObservers);
208 m_entity.instanceDetach(path_find_mapfile(path.begin(), path.end()));
209 m_filter.instanceDetach();
213 EntityKeyValues& getEntity()
217 const EntityKeyValues& getEntity() const
222 scene::Traversable& getTraversable()
224 return m_model.getTraversable();
226 Namespaced& getNamespaced()
230 Nameable& getNameable()
234 TransformNode& getTransformNode()
238 ModelSkin& getModelSkin()
243 void attach(scene::Traversable::Observer* observer)
245 m_model.attach(observer);
247 void detach(scene::Traversable::Observer* observer)
249 m_model.detach(observer);
252 void renderSolid(Renderer& renderer, const VolumeTest& volume, const Matrix4& localToWorld, bool selected) const
256 m_renderOrigin.render(renderer, volume, localToWorld);
259 renderer.SetState(m_entity.getEntityClass().m_state_wire, Renderer::eWireframeOnly);
261 void renderWireframe(Renderer& renderer, const VolumeTest& volume, const Matrix4& localToWorld, bool selected) const
263 renderSolid(renderer, volume, localToWorld, selected);
266 renderer.addRenderable(m_renderName, localToWorld);
270 void translate(const Vector3& translation)
272 m_origin = origin_translated(m_origin, translation);
274 void rotate(const Quaternion& rotation)
276 if(g_gameType == eGameTypeDoom3)
278 rotation_rotate(m_rotation, rotation);
282 m_angle = angle_rotated(m_angle, rotation);
285 void snapto(float snap)
287 m_originKey.m_origin = origin_snapped(m_originKey.m_origin, snap);
288 m_originKey.write(&m_entity);
290 void revertTransform()
292 m_origin = m_originKey.m_origin;
293 if(g_gameType == eGameTypeDoom3)
295 rotation_assign(m_rotation, m_rotationKey.m_rotation);
299 m_angle = m_angleKey.m_angle;
302 void freezeTransform()
304 m_originKey.m_origin = m_origin;
305 m_originKey.write(&m_entity);
306 if(g_gameType == eGameTypeDoom3)
308 rotation_assign(m_rotationKey.m_rotation, m_rotation);
309 m_rotationKey.write(&m_entity);
313 m_angleKey.m_angle = m_angle;
314 m_angleKey.write(&m_entity);
317 void transformChanged()
320 m_evaluateTransform();
323 typedef MemberCaller<EclassModel, &EclassModel::transformChanged> TransformChangedCaller;
326 class EclassModelInstance : public TargetableInstance, public TransformModifier, public Renderable
330 InstanceTypeCastTable m_casts;
334 m_casts = TargetableInstance::StaticTypeCasts::instance().get();
335 InstanceStaticCast<EclassModelInstance, Renderable>::install(m_casts);
336 InstanceStaticCast<EclassModelInstance, Transformable>::install(m_casts);
337 InstanceIdentityCast<EclassModelInstance>::install(m_casts);
339 InstanceTypeCastTable& get()
345 EclassModel& m_contained;
347 typedef LazyStatic<TypeCasts> StaticTypeCasts;
349 STRING_CONSTANT(Name, "EclassModelInstance");
351 EclassModelInstance(const scene::Path& path, scene::Instance* parent, EclassModel& contained) :
352 TargetableInstance(path, parent, this, StaticTypeCasts::instance().get(), contained.getEntity(), *this),
353 TransformModifier(EclassModel::TransformChangedCaller(contained), ApplyTransformCaller(*this)),
354 m_contained(contained)
356 m_contained.instanceAttach(Instance::path());
358 StaticRenderableConnectionLines::instance().attach(*this);
360 ~EclassModelInstance()
362 StaticRenderableConnectionLines::instance().detach(*this);
364 m_contained.instanceDetach(Instance::path());
366 void renderSolid(Renderer& renderer, const VolumeTest& volume) const
368 m_contained.renderSolid(renderer, volume, Instance::localToWorld(), getSelectable().isSelected());
370 void renderWireframe(Renderer& renderer, const VolumeTest& volume) const
372 m_contained.renderWireframe(renderer, volume, Instance::localToWorld(), getSelectable().isSelected());
375 void evaluateTransform()
377 if(getType() == TRANSFORM_PRIMITIVE)
379 m_contained.translate(getTranslation());
380 m_contained.rotate(getRotation());
383 void applyTransform()
385 m_contained.revertTransform();
387 m_contained.freezeTransform();
389 typedef MemberCaller<EclassModelInstance, &EclassModelInstance::applyTransform> ApplyTransformCaller;
392 class EclassModelNode :
393 public scene::Node::Symbiot,
394 public scene::Instantiable,
395 public scene::Cloneable,
396 public scene::Traversable::Observer
400 NodeTypeCastTable m_casts;
404 NodeStaticCast<EclassModelNode, scene::Instantiable>::install(m_casts);
405 NodeStaticCast<EclassModelNode, scene::Cloneable>::install(m_casts);
406 NodeContainedCast<EclassModelNode, scene::Traversable>::install(m_casts);
407 NodeContainedCast<EclassModelNode, Snappable>::install(m_casts);
408 NodeContainedCast<EclassModelNode, TransformNode>::install(m_casts);
409 NodeContainedCast<EclassModelNode, Entity>::install(m_casts);
410 NodeContainedCast<EclassModelNode, Nameable>::install(m_casts);
411 NodeContainedCast<EclassModelNode, Namespaced>::install(m_casts);
412 NodeContainedCast<EclassModelNode, ModelSkin>::install(m_casts);
414 NodeTypeCastTable& get()
422 InstanceSet m_instances;
423 EclassModel m_contained;
427 m_contained.attach(this);
431 m_contained.detach(this);
435 typedef LazyStatic<TypeCasts> StaticTypeCasts;
437 scene::Traversable& get(NullType<scene::Traversable>)
439 return m_contained.getTraversable();
441 Snappable& get(NullType<Snappable>)
445 TransformNode& get(NullType<TransformNode>)
447 return m_contained.getTransformNode();
449 Entity& get(NullType<Entity>)
451 return m_contained.getEntity();
453 Nameable& get(NullType<Nameable>)
455 return m_contained.getNameable();
457 Namespaced& get(NullType<Namespaced>)
459 return m_contained.getNamespaced();
461 ModelSkin& get(NullType<ModelSkin>)
463 return m_contained.getModelSkin();
466 EclassModelNode(EntityClass* eclass) :
467 m_node(this, this, StaticTypeCasts::instance().get()),
468 m_contained(eclass, m_node, InstanceSet::TransformChangedCaller(m_instances), InstanceSetEvaluateTransform<EclassModelInstance>::Caller(m_instances))
472 EclassModelNode(const EclassModelNode& other) :
473 scene::Node::Symbiot(other),
474 scene::Instantiable(other),
475 scene::Cloneable(other),
476 scene::Traversable::Observer(other),
477 m_node(this, this, StaticTypeCasts::instance().get()),
478 m_contained(other.m_contained, m_node, InstanceSet::TransformChangedCaller(m_instances), InstanceSetEvaluateTransform<EclassModelInstance>::Caller(m_instances))
495 void insert(scene::Node& child)
497 m_instances.insert(child);
499 void erase(scene::Node& child)
501 m_instances.erase(child);
504 scene::Node& clone() const
506 return (new EclassModelNode(*this))->node();
509 scene::Instance* create(const scene::Path& path, scene::Instance* parent)
511 return new EclassModelInstance(path, parent, m_contained);
513 void forEachInstance(const scene::Instantiable::Visitor& visitor)
515 m_instances.forEachInstance(visitor);
517 void insert(scene::Instantiable::Observer* observer, const scene::Path& path, scene::Instance* instance)
519 m_instances.insert(observer, path, instance);
521 scene::Instance* erase(scene::Instantiable::Observer* observer, const scene::Path& path)
523 return m_instances.erase(observer, path);
527 scene::Node& New_EclassModel(EntityClass* eclass)
529 return (new EclassModelNode(eclass))->node();