Merge remote-tracking branch 'illwieckz/pakpath'
[xonotic/netradiant.git] / include / iselection.h
1 /*
2    Copyright (C) 2001-2006, William Joseph.
3    All Rights Reserved.
4
5    This file is part of GtkRadiant.
6
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.
11
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.
16
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
20  */
21
22 #if !defined( INCLUDED_ISELECTION_H )
23 #define INCLUDED_ISELECTION_H
24
25 #include <cstddef>
26 #include "generic/constant.h"
27 #include "generic/callbackfwd.h"
28 #include "signal/signalfwd.h"
29
30 class Renderer;
31 class View;
32
33 class Selectable
34 {
35 public:
36 STRING_CONSTANT( Name, "Selectable" );
37
38 virtual void setSelected( bool select ) = 0;
39 virtual bool isSelected() const = 0;
40 };
41
42 namespace scene
43 {
44 class Instance;
45 };
46
47 class InstanceSelectionObserver
48 {
49 public:
50 virtual void onSelectedChanged( scene::Instance& instance ) = 0;
51 };
52
53 template<typename Element> class BasicVector3;
54 typedef BasicVector3<float> Vector3;
55 template<typename Element> class BasicVector4;
56 typedef BasicVector4<float> Vector4;
57 class Matrix4;
58 typedef Vector4 Quaternion;
59
60 typedef Callback1<const Selectable&> SelectionChangeCallback;
61 typedef SignalHandler1<const Selectable&> SelectionChangeHandler;
62
63 class SelectionSystem
64 {
65 public:
66 INTEGER_CONSTANT( Version, 1 );
67 STRING_CONSTANT( Name, "selection" );
68
69 enum EMode
70 {
71         eEntity,
72         ePrimitive,
73         eComponent,
74 };
75
76 enum EComponentMode
77 {
78         eDefault,
79         eVertex,
80         eEdge,
81         eFace,
82 };
83
84 enum EManipulatorMode
85 {
86         eTranslate,
87         eRotate,
88         eScale,
89         eDrag,
90         eClip,
91 };
92
93 virtual void SetMode( EMode mode ) = 0;
94 virtual EMode Mode() const = 0;
95 virtual void SetComponentMode( EComponentMode mode ) = 0;
96 virtual EComponentMode ComponentMode() const = 0;
97 virtual void SetManipulatorMode( EManipulatorMode mode ) = 0;
98 virtual EManipulatorMode ManipulatorMode() const = 0;
99
100 virtual SelectionChangeCallback getObserver( EMode mode ) = 0;
101 virtual std::size_t countSelected() const = 0;
102 virtual std::size_t countSelectedComponents() const = 0;
103 virtual void onSelectedChanged( scene::Instance& instance, const Selectable& selectable ) = 0;
104 virtual void onComponentSelection( scene::Instance& instance, const Selectable& selectable ) = 0;
105 virtual scene::Instance& ultimateSelected() const = 0;
106 virtual scene::Instance& penultimateSelected() const = 0;
107 virtual void setSelectedAll( bool selected ) = 0;
108 virtual void setSelectedAllComponents( bool selected ) = 0;
109
110 class Visitor
111 {
112 public:
113 virtual void visit( scene::Instance& instance ) const = 0;
114 };
115 virtual void foreachSelected( const Visitor& visitor ) const = 0;
116 virtual void foreachSelectedComponent( const Visitor& visitor ) const = 0;
117
118 virtual void addSelectionChangeCallback( const SelectionChangeHandler& handler ) = 0;
119
120 virtual void NudgeManipulator( const Vector3& nudge, const Vector3& view ) = 0;
121
122 virtual void translateSelected( const Vector3& translation ) = 0;
123 virtual void rotateSelected( const Quaternion& rotation ) = 0;
124 virtual void scaleSelected( const Vector3& scaling ) = 0;
125
126 virtual void pivotChanged() const = 0;
127 };
128
129 #include "modulesystem.h"
130
131 template<typename Type>
132 class GlobalModule;
133 typedef GlobalModule<SelectionSystem> GlobalSelectionModule;
134
135 template<typename Type>
136 class GlobalModuleRef;
137 typedef GlobalModuleRef<SelectionSystem> GlobalSelectionModuleRef;
138
139 inline SelectionSystem& GlobalSelectionSystem(){
140         return GlobalSelectionModule::getTable();
141 }
142
143
144 #endif