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 Doom3 entity which does not have a fixed size specified in its entity-definition (e.g. func_static).
25 /// This entity behaves as a group only when the "model" key is empty or is the same as the "name" key. Otherwise it behaves as a model.
26 /// When behaving as a group, the "origin" key is the translation to be applied to all brushes (not patches) grouped under this entity.
27 /// When behaving as a model, the "origin", "angle" and "rotation" keys directly control the entity's local-to-parent transform.
28 /// When either the "curve_Nurbs" or "curve_CatmullRomSpline" keys define a curve, the curve is rendered and can be edited.
30 #include "doom3group.h"
33 #include "renderable.h"
35 #include "modelskin.h"
37 #include "selectionlib.h"
38 #include "instancelib.h"
39 #include "transformlib.h"
40 #include "traverselib.h"
41 #include "entitylib.h"
43 #include "eclasslib.h"
44 #include "stream/stringstream.h"
47 #include "targetable.h"
53 #include "namedentity.h"
54 #include "keyobservers.h"
57 #include "modelskinkey.h"
62 PointVertexArray_testSelect(PointVertex *first, std::size_t count, SelectionTest &test, SelectionIntersection &best)
66 reinterpret_cast<VertexPointer::pointer>( &first->vertex ),
69 IndexPointer::index_type(count),
77 EntityKeyValues m_entity;
78 KeyObserverMap m_keyObservers;
79 TraversableNodeSet m_traverse;
80 MatrixTransform m_transform;
82 SingletonModel m_model;
83 OriginKey m_originKey;
86 RotationKey m_rotationKey;
89 ClassnameFilter m_filter;
92 TraversableObserverPairRelay m_traverseObservers;
93 Doom3GroupOrigin m_funcStaticOrigin;
94 RenderablePivot m_renderOrigin;
95 RenderableNamedEntity m_renderName;
96 mutable Vector3 m_name_origin;
100 NURBSCurve m_curveNURBS;
101 SignalHandlerId m_curveNURBSChanged;
102 CatmullRomSpline m_curveCatmullRom;
103 SignalHandlerId m_curveCatmullRomChanged;
105 mutable AABB m_curveBounds;
107 Callback<void()> m_transformChanged;
108 Callback<void()> m_evaluateTransform;
111 CopiedString m_modelKey;
114 scene::Traversable *m_traversable;
118 default_rotation(m_rotation);
120 m_keyObservers.insert("classname", ClassnameFilter::ClassnameChangedCaller(m_filter));
121 m_keyObservers.insert(Static<KeyIsName>::instance().m_nameKey, NamedEntity::IdentifierChangedCaller(m_named));
122 m_keyObservers.insert("model", Doom3Group::ModelChangedCaller(*this));
123 m_keyObservers.insert("origin", OriginKey::OriginChangedCaller(m_originKey));
124 m_keyObservers.insert("angle", RotationKey::AngleChangedCaller(m_rotationKey));
125 m_keyObservers.insert("rotation", RotationKey::RotationChangedCaller(m_rotationKey));
126 m_keyObservers.insert("name", NameChangedCaller(*this));
127 m_keyObservers.insert(curve_Nurbs, NURBSCurve::CurveChangedCaller(m_curveNURBS));
128 m_keyObservers.insert(curve_CatmullRomSpline, CatmullRomSpline::CurveChangedCaller(m_curveCatmullRom));
129 m_keyObservers.insert("skin", ModelSkinKey::SkinChangedCaller(m_skin));
131 m_traverseObservers.attach(m_funcStaticOrigin);
133 m_nameKeys.setKeyIsName(keyIsNameDoom3Doom3Group);
136 m_entity.attach(m_keyObservers);
141 m_entity.detach(m_keyObservers);
149 m_traverseObservers.detach(m_funcStaticOrigin);
154 m_traversable = &m_model.getTraversable();
155 m_model.attach(&m_traverseObservers);
161 m_model.detach(&m_traverseObservers);
164 void attachTraverse()
166 m_traversable = &m_traverse;
167 m_traverse.attach(&m_traverseObservers);
170 void detachTraverse()
173 m_traverse.detach(&m_traverseObservers);
181 void setIsModel(bool newValue)
183 if (newValue && !m_isModel) {
187 m_nameKeys.setKeyIsName(Static<KeyIsName>::instance().m_keyIsName);
188 m_model.modelChanged(m_modelKey.c_str());
189 } else if (!newValue && m_isModel) {
193 m_nameKeys.setKeyIsName(keyIsNameDoom3Doom3Group);
195 m_isModel = newValue;
201 setIsModel(!string_equal(m_modelKey.c_str(), m_name.c_str()));
204 // vc 2k5 compiler fix
209 void nameChanged(const char *value)
215 typedef MemberCaller<Doom3Group, void(const char *), &Doom3Group::nameChanged> NameChangedCaller;
217 void modelChanged(const char *value)
222 m_model.modelChanged(value);
224 m_model.modelChanged("");
228 typedef MemberCaller<Doom3Group, void(const char *), &Doom3Group::modelChanged> ModelChangedCaller;
230 void updateTransform()
232 m_transform.localToParent() = g_matrix4_identity;
234 matrix4_translate_by_vec3(m_transform.localToParent(), m_origin);
235 matrix4_multiply_by_matrix4(m_transform.localToParent(), rotation_toMatrix(m_rotation));
237 m_transformChanged();
239 m_funcStaticOrigin.originChanged();
243 typedef MemberCaller<Doom3Group, void(), &Doom3Group::updateTransform> UpdateTransformCaller;
247 m_origin = m_originKey.m_origin;
251 typedef MemberCaller<Doom3Group, void(), &Doom3Group::originChanged> OriginChangedCaller;
253 void rotationChanged()
255 rotation_assign(m_rotation, m_rotationKey.m_rotation);
259 typedef MemberCaller<Doom3Group, void(), &Doom3Group::rotationChanged> RotationChangedCaller;
264 scene::Node *node = m_model.getNode();
266 Node_modelSkinChanged(*node);
271 typedef MemberCaller<Doom3Group, void(), &Doom3Group::skinChanged> SkinChangedCaller;
274 Doom3Group(EntityClass *eclass, scene::Node &node, const Callback<void()> &transformChanged,
275 const Callback<void()> &boundsChanged, const Callback<void()> &evaluateTransform) :
277 m_originKey(OriginChangedCaller(*this)),
278 m_origin(ORIGINKEY_IDENTITY),
279 m_rotationKey(RotationChangedCaller(*this)),
280 m_filter(m_entity, node),
282 m_nameKeys(m_entity),
283 m_funcStaticOrigin(m_traverse, m_origin),
284 m_renderName(m_named, m_name_origin),
285 m_name_origin(g_vector3_identity),
286 m_skin(SkinChangedCaller(*this)),
287 m_curveNURBS(boundsChanged),
288 m_curveCatmullRom(boundsChanged),
289 m_transformChanged(transformChanged),
290 m_evaluateTransform(evaluateTransform),
296 Doom3Group(const Doom3Group &other, scene::Node &node, const Callback<void()> &transformChanged,
297 const Callback<void()> &boundsChanged, const Callback<void()> &evaluateTransform) :
298 m_entity(other.m_entity),
299 m_originKey(OriginChangedCaller(*this)),
300 m_origin(ORIGINKEY_IDENTITY),
301 m_rotationKey(RotationChangedCaller(*this)),
302 m_filter(m_entity, node),
304 m_nameKeys(m_entity),
305 m_funcStaticOrigin(m_traverse, m_origin),
306 m_renderName(m_named, g_vector3_identity),
307 m_skin(SkinChangedCaller(*this)),
308 m_curveNURBS(boundsChanged),
309 m_curveCatmullRom(boundsChanged),
310 m_transformChanged(transformChanged),
311 m_evaluateTransform(evaluateTransform),
322 InstanceCounter m_instanceCounter;
324 void instanceAttach(const scene::Path &path)
326 if (++m_instanceCounter.m_count == 1) {
327 m_filter.instanceAttach();
328 m_entity.instanceAttach(path_find_mapfile(path.begin(), path.end()));
329 m_traverse.instanceAttach(path_find_mapfile(path.begin(), path.end()));
331 m_funcStaticOrigin.enable();
335 void instanceDetach(const scene::Path &path)
337 if (--m_instanceCounter.m_count == 0) {
338 m_funcStaticOrigin.disable();
340 m_traverse.instanceDetach(path_find_mapfile(path.begin(), path.end()));
341 m_entity.instanceDetach(path_find_mapfile(path.begin(), path.end()));
342 m_filter.instanceDetach();
346 EntityKeyValues &getEntity()
351 const EntityKeyValues &getEntity() const
356 scene::Traversable &getTraversable()
358 return *m_traversable;
361 Namespaced &getNamespaced()
366 Nameable &getNameable()
371 TransformNode &getTransformNode()
376 ModelSkin &getModelSkin()
381 void attach(scene::Traversable::Observer *observer)
383 m_traverseObservers.attach(*observer);
386 void detach(scene::Traversable::Observer *observer)
388 m_traverseObservers.detach(*observer);
391 const AABB &localAABB() const
393 m_curveBounds = m_curveNURBS.m_bounds;
394 aabb_extend_by_aabb_safe(m_curveBounds, m_curveCatmullRom.m_bounds);
395 return m_curveBounds;
398 void renderSolid(Renderer &renderer, const VolumeTest &volume, const Matrix4 &localToWorld, bool selected) const
400 if (isModel() && selected) {
401 m_renderOrigin.render(renderer, volume, localToWorld);
404 renderer.SetState(m_entity.getEntityClass().m_state_wire, Renderer::eWireframeOnly);
405 renderer.SetState(m_entity.getEntityClass().m_state_wire, Renderer::eFullMaterials);
407 if (!m_curveNURBS.m_renderCurve.m_vertices.empty()) {
408 renderer.addRenderable(m_curveNURBS.m_renderCurve, localToWorld);
410 if (!m_curveCatmullRom.m_renderCurve.m_vertices.empty()) {
411 renderer.addRenderable(m_curveCatmullRom.m_renderCurve, localToWorld);
415 void renderWireframe(Renderer &renderer, const VolumeTest &volume, const Matrix4 &localToWorld, bool selected,
416 const AABB &childBounds) const
418 renderSolid(renderer, volume, localToWorld, selected);
421 // draw models as usual
423 // don't draw the name for worldspawn
424 if (!strcmp(m_entity.getEntityClass().name(), "worldspawn")) {
428 // place name in the middle of the "children cloud"
429 m_name_origin = childBounds.origin;
432 renderer.addRenderable(m_renderName, localToWorld);
436 void testSelect(Selector &selector, SelectionTest &test, SelectionIntersection &best)
438 PointVertexArray_testSelect(&m_curveNURBS.m_renderCurve.m_vertices[0],
439 m_curveNURBS.m_renderCurve.m_vertices.size(), test, best);
440 PointVertexArray_testSelect(&m_curveCatmullRom.m_renderCurve.m_vertices[0],
441 m_curveCatmullRom.m_renderCurve.m_vertices.size(), test, best);
444 void translate(const Vector3 &translation)
446 m_origin = origin_translated(m_origin, translation);
449 void rotate(const Quaternion &rotation)
451 rotation_rotate(m_rotation, rotation);
454 void snapto(float snap)
456 m_originKey.m_origin = origin_snapped(m_originKey.m_origin, snap);
457 m_originKey.write(&m_entity);
460 void revertTransform()
462 m_origin = m_originKey.m_origin;
463 rotation_assign(m_rotation, m_rotationKey.m_rotation);
464 m_curveNURBS.m_controlPointsTransformed = m_curveNURBS.m_controlPoints;
465 m_curveCatmullRom.m_controlPointsTransformed = m_curveCatmullRom.m_controlPoints;
468 void freezeTransform()
470 m_originKey.m_origin = m_origin;
471 m_originKey.write(&m_entity);
472 rotation_assign(m_rotationKey.m_rotation, m_rotation);
473 m_rotationKey.write(&m_entity);
474 m_curveNURBS.m_controlPoints = m_curveNURBS.m_controlPointsTransformed;
475 ControlPoints_write(m_curveNURBS.m_controlPoints, curve_Nurbs, m_entity);
476 m_curveCatmullRom.m_controlPoints = m_curveCatmullRom.m_controlPointsTransformed;
477 ControlPoints_write(m_curveCatmullRom.m_controlPoints, curve_CatmullRomSpline, m_entity);
480 void transformChanged()
483 m_evaluateTransform();
485 m_curveNURBS.curveChanged();
486 m_curveCatmullRom.curveChanged();
489 typedef MemberCaller<Doom3Group, void(), &Doom3Group::transformChanged> TransformChangedCaller;
492 class Doom3GroupInstance :
493 public TargetableInstance,
494 public TransformModifier,
496 public SelectionTestable,
497 public ComponentSelectionTestable,
498 public ComponentEditable,
499 public ComponentSnappable {
501 InstanceTypeCastTable m_casts;
505 m_casts = TargetableInstance::StaticTypeCasts::instance().get();
506 InstanceContainedCast<Doom3GroupInstance, Bounded>::install(m_casts);
507 InstanceStaticCast<Doom3GroupInstance, Renderable>::install(m_casts);
508 InstanceStaticCast<Doom3GroupInstance, SelectionTestable>::install(m_casts);
509 InstanceStaticCast<Doom3GroupInstance, ComponentSelectionTestable>::install(m_casts);
510 InstanceStaticCast<Doom3GroupInstance, ComponentEditable>::install(m_casts);
511 InstanceStaticCast<Doom3GroupInstance, ComponentSnappable>::install(m_casts);
512 InstanceStaticCast<Doom3GroupInstance, Transformable>::install(m_casts);
513 InstanceIdentityCast<Doom3GroupInstance>::install(m_casts);
516 InstanceTypeCastTable &get()
522 Doom3Group &m_contained;
523 CurveEdit m_curveNURBS;
524 CurveEdit m_curveCatmullRom;
525 mutable AABB m_aabb_component;
528 typedef LazyStatic<TypeCasts> StaticTypeCasts;
531 Bounded &get(NullType<Bounded>)
536 STRING_CONSTANT(Name, "Doom3GroupInstance");
538 Doom3GroupInstance(const scene::Path &path, scene::Instance *parent, Doom3Group &contained) :
539 TargetableInstance(path, parent, this, StaticTypeCasts::instance().get(), contained.getEntity(), *this),
540 TransformModifier(Doom3Group::TransformChangedCaller(contained), ApplyTransformCaller(*this)),
541 m_contained(contained),
542 m_curveNURBS(m_contained.m_curveNURBS.m_controlPointsTransformed, SelectionChangedComponentCaller(*this)),
543 m_curveCatmullRom(m_contained.m_curveCatmullRom.m_controlPointsTransformed,
544 SelectionChangedComponentCaller(*this))
546 m_contained.instanceAttach(Instance::path());
547 m_contained.m_curveNURBSChanged = m_contained.m_curveNURBS.connect(CurveEdit::CurveChangedCaller(m_curveNURBS));
548 m_contained.m_curveCatmullRomChanged = m_contained.m_curveCatmullRom.connect(
549 CurveEdit::CurveChangedCaller(m_curveCatmullRom));
551 StaticRenderableConnectionLines::instance().attach(*this);
554 ~Doom3GroupInstance()
556 StaticRenderableConnectionLines::instance().detach(*this);
558 m_contained.m_curveCatmullRom.disconnect(m_contained.m_curveCatmullRomChanged);
559 m_contained.m_curveNURBS.disconnect(m_contained.m_curveNURBSChanged);
560 m_contained.instanceDetach(Instance::path());
563 void renderSolid(Renderer &renderer, const VolumeTest &volume) const
565 m_contained.renderSolid(renderer, volume, Instance::localToWorld(), getSelectable().isSelected());
567 m_curveNURBS.renderComponentsSelected(renderer, volume, localToWorld());
568 m_curveCatmullRom.renderComponentsSelected(renderer, volume, localToWorld());
571 void renderWireframe(Renderer &renderer, const VolumeTest &volume) const
573 m_contained.renderWireframe(renderer, volume, Instance::localToWorld(), getSelectable().isSelected(),
574 Instance::childBounds());
576 m_curveNURBS.renderComponentsSelected(renderer, volume, localToWorld());
577 m_curveCatmullRom.renderComponentsSelected(renderer, volume, localToWorld());
580 void renderComponents(Renderer &renderer, const VolumeTest &volume) const
582 if (GlobalSelectionSystem().ComponentMode() == SelectionSystem::eVertex) {
583 m_curveNURBS.renderComponents(renderer, volume, localToWorld());
584 m_curveCatmullRom.renderComponents(renderer, volume, localToWorld());
588 void testSelect(Selector &selector, SelectionTest &test)
590 test.BeginMesh(localToWorld());
591 SelectionIntersection best;
593 m_contained.testSelect(selector, test, best);
596 Selector_add(selector, getSelectable(), best);
600 bool isSelectedComponents() const
602 return m_curveNURBS.isSelected() || m_curveCatmullRom.isSelected();
605 void setSelectedComponents(bool selected, SelectionSystem::EComponentMode mode)
607 if (mode == SelectionSystem::eVertex) {
608 m_curveNURBS.setSelected(selected);
609 m_curveCatmullRom.setSelected(selected);
613 void testSelectComponents(Selector &selector, SelectionTest &test, SelectionSystem::EComponentMode mode)
615 if (mode == SelectionSystem::eVertex) {
616 test.BeginMesh(localToWorld());
617 m_curveNURBS.testSelect(selector, test);
618 m_curveCatmullRom.testSelect(selector, test);
622 void transformComponents(const Matrix4 &matrix)
624 if (m_curveNURBS.isSelected()) {
625 m_curveNURBS.transform(matrix);
627 if (m_curveCatmullRom.isSelected()) {
628 m_curveCatmullRom.transform(matrix);
632 const AABB &getSelectedComponentsBounds() const
634 m_aabb_component = AABB();
635 m_curveNURBS.forEachSelected([&](const Vector3 &point) {
636 aabb_extend_by_point_safe(m_aabb_component, point);
638 m_curveCatmullRom.forEachSelected([&](const Vector3 &point) {
639 aabb_extend_by_point_safe(m_aabb_component, point);
641 return m_aabb_component;
644 void snapComponents(float snap)
646 if (m_curveNURBS.isSelected()) {
647 m_curveNURBS.snapto(snap);
648 m_curveNURBS.write(curve_Nurbs, m_contained.getEntity());
650 if (m_curveCatmullRom.isSelected()) {
651 m_curveCatmullRom.snapto(snap);
652 m_curveCatmullRom.write(curve_CatmullRomSpline, m_contained.getEntity());
656 void evaluateTransform()
658 if (getType() == TRANSFORM_PRIMITIVE) {
659 m_contained.translate(getTranslation());
660 m_contained.rotate(getRotation());
662 transformComponents(calculateTransform());
666 void applyTransform()
668 m_contained.revertTransform();
670 m_contained.freezeTransform();
673 typedef MemberCaller<Doom3GroupInstance, void(), &Doom3GroupInstance::applyTransform> ApplyTransformCaller;
675 void selectionChangedComponent(const Selectable &selectable)
677 GlobalSelectionSystem().getObserver(SelectionSystem::eComponent)(selectable);
678 GlobalSelectionSystem().onComponentSelection(*this, selectable);
681 typedef MemberCaller<Doom3GroupInstance, void(
682 const Selectable &), &Doom3GroupInstance::selectionChangedComponent> SelectionChangedComponentCaller;
685 class Doom3GroupNode :
686 public scene::Node::Symbiot,
687 public scene::Instantiable,
688 public scene::Cloneable,
689 public scene::Traversable::Observer {
691 NodeTypeCastTable m_casts;
695 NodeStaticCast<Doom3GroupNode, scene::Instantiable>::install(m_casts);
696 NodeStaticCast<Doom3GroupNode, scene::Cloneable>::install(m_casts);
697 NodeContainedCast<Doom3GroupNode, scene::Traversable>::install(m_casts);
698 NodeContainedCast<Doom3GroupNode, Snappable>::install(m_casts);
699 NodeContainedCast<Doom3GroupNode, TransformNode>::install(m_casts);
700 NodeContainedCast<Doom3GroupNode, Entity>::install(m_casts);
701 NodeContainedCast<Doom3GroupNode, Nameable>::install(m_casts);
702 NodeContainedCast<Doom3GroupNode, Namespaced>::install(m_casts);
703 NodeContainedCast<Doom3GroupNode, ModelSkin>::install(m_casts);
706 NodeTypeCastTable &get()
714 InstanceSet m_instances;
715 Doom3Group m_contained;
719 m_contained.attach(this);
724 m_contained.detach(this);
729 typedef LazyStatic<TypeCasts> StaticTypeCasts;
731 scene::Traversable &get(NullType<scene::Traversable>)
733 return m_contained.getTraversable();
736 Snappable &get(NullType<Snappable>)
741 TransformNode &get(NullType<TransformNode>)
743 return m_contained.getTransformNode();
746 Entity &get(NullType<Entity>)
748 return m_contained.getEntity();
751 Nameable &get(NullType<Nameable>)
753 return m_contained.getNameable();
756 Namespaced &get(NullType<Namespaced>)
758 return m_contained.getNamespaced();
761 ModelSkin &get(NullType<ModelSkin>)
763 return m_contained.getModelSkin();
766 Doom3GroupNode(EntityClass *eclass) :
767 m_node(this, this, StaticTypeCasts::instance().get()),
768 m_contained(eclass, m_node, InstanceSet::TransformChangedCaller(m_instances),
769 InstanceSet::BoundsChangedCaller(m_instances),
770 InstanceSetEvaluateTransform<Doom3GroupInstance>::Caller(m_instances))
775 Doom3GroupNode(const Doom3GroupNode &other) :
776 scene::Node::Symbiot(other),
777 scene::Instantiable(other),
778 scene::Cloneable(other),
779 scene::Traversable::Observer(other),
780 m_node(this, this, StaticTypeCasts::instance().get()),
781 m_contained(other.m_contained, m_node, InstanceSet::TransformChangedCaller(m_instances),
782 InstanceSet::BoundsChangedCaller(m_instances),
783 InstanceSetEvaluateTransform<Doom3GroupInstance>::Caller(m_instances))
803 scene::Node &clone() const
805 return (new Doom3GroupNode(*this))->node();
808 void insert(scene::Node &child)
810 m_instances.insert(child);
813 void erase(scene::Node &child)
815 m_instances.erase(child);
818 scene::Instance *create(const scene::Path &path, scene::Instance *parent)
820 return new Doom3GroupInstance(path, parent, m_contained);
823 void forEachInstance(const scene::Instantiable::Visitor &visitor)
825 m_instances.forEachInstance(visitor);
828 void insert(scene::Instantiable::Observer *observer, const scene::Path &path, scene::Instance *instance)
830 m_instances.insert(observer, path, instance);
833 scene::Instance *erase(scene::Instantiable::Observer *observer, const scene::Path &path)
835 return m_instances.erase(observer, path);
839 void Doom3Group_construct()
841 CurveEdit::Type::instance().m_controlsShader = GlobalShaderCache().capture("$POINT");
842 CurveEdit::Type::instance().m_selectedShader = GlobalShaderCache().capture("$SELPOINT");
845 void Doom3Group_destroy()
847 GlobalShaderCache().release("$SELPOINT");
848 GlobalShaderCache().release("$POINT");
851 scene::Node &New_Doom3Group(EntityClass *eclass)
853 return (new Doom3GroupNode(eclass))->node();