radiant/filters.cpp

   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 #include "filters.h"
  23
  24 #include "debugging/debugging.h"
  25
  26 #include "ifilter.h"
  27
  28 #include "scenelib.h"
  29
  30 #include <list>
  31 #include <set>
  32
  33 #include "gtkutil/widget.h"
  34 #include "gtkutil/menu.h"
  35 #include "gtkmisc.h"
  36 #include "mainframe.h"
  37 #include "commands.h"
  38 #include "preferences.h"
  39
  40 struct filters_globals_t {
  41     std::size_t exclude;
  42
  43     filters_globals_t() :
  44             exclude(0)
  45     {
  46     }
  47 };
  48
  49 filters_globals_t g_filters_globals;
  50
  51 inline bool filter_active(int mask)
  52 {
  53     return (g_filters_globals.exclude & mask) > 0;
  54 }
  55
  56 class FilterWrapper {
  57 public:
  58     FilterWrapper(Filter &filter, int mask) : m_filter(filter), m_mask(mask)
  59     {
  60     }
  61
  62     void update()
  63     {
  64         m_filter.setActive(filter_active(m_mask));
  65     }
  66
  67 private:
  68     Filter &m_filter;
  69     int m_mask;
  70 };
  71
  72 typedef std::list<FilterWrapper> Filters;
  73 Filters g_filters;
  74
  75 typedef std::set<Filterable *> Filterables;
  76 Filterables g_filterables;
  77
  78 void UpdateFilters()
  79 {
  80     {
  81         for (Filters::iterator i = g_filters.begin(); i != g_filters.end(); ++i) {
  82             (*i).update();
  83         }
  84     }
  85
  86     {
  87         for (Filterables::iterator i = g_filterables.begin(); i != g_filterables.end(); ++i) {
  88             (*i)->updateFiltered();
  89         }
  90     }
  91 }
  92
  93
  94 class BasicFilterSystem : public FilterSystem {
  95 public:
  96     void addFilter(Filter &filter, int mask)
  97     {
  98         g_filters.push_back(FilterWrapper(filter, mask));
  99         g_filters.back().update();
 100     }
 101
 102     void registerFilterable(Filterable &filterable)
 103     {
 104         ASSERT_MESSAGE(g_filterables.find(&filterable) == g_filterables.end(), "filterable already registered");
 105         filterable.updateFiltered();
 106         g_filterables.insert(&filterable);
 107     }
 108
 109     void unregisterFilterable(Filterable &filterable)
 110     {
 111         ASSERT_MESSAGE(g_filterables.find(&filterable) != g_filterables.end(), "filterable not registered");
 112         g_filterables.erase(&filterable);
 113     }
 114 };
 115
 116 BasicFilterSystem g_FilterSystem;
 117
 118 FilterSystem &GetFilterSystem()
 119 {
 120     return g_FilterSystem;
 121 }
 122
 123 void PerformFiltering()
 124 {
 125     UpdateFilters();
 126     SceneChangeNotify();
 127 }
 128
 129 class ToggleFilterFlag {
 130     const unsigned int m_mask;
 131 public:
 132     ToggleItem m_item;
 133
 134     ToggleFilterFlag(unsigned int mask) : m_mask(mask), m_item(ActiveCaller(*this))
 135     {
 136     }
 137
 138     ToggleFilterFlag(const ToggleFilterFlag &other) : m_mask(other.m_mask), m_item(ActiveCaller(*this))
 139     {
 140     }
 141
 142     void active(const Callback<void(bool)> &importCallback)
 143     {
 144         importCallback((g_filters_globals.exclude & m_mask) != 0);
 145     }
 146
 147     typedef MemberCaller<ToggleFilterFlag, void(const Callback<void(bool)> &), &ToggleFilterFlag::active> ActiveCaller;
 148
 149     void toggle()
 150     {
 151         g_filters_globals.exclude ^= m_mask;
 152         m_item.update();
 153         PerformFiltering();
 154     }
 155
 156     void reset()
 157     {
 158         g_filters_globals.exclude = 0;
 159         m_item.update();
 160         PerformFiltering();
 161     }
 162
 163     typedef MemberCaller<ToggleFilterFlag, void(), &ToggleFilterFlag::toggle> ToggleCaller;
 164 };
 165
 166
 167 typedef std::list<ToggleFilterFlag> ToggleFilterFlags;
 168 ToggleFilterFlags g_filter_items;
 169
 170 void add_filter_command(unsigned int flag, const char *command, const Accelerator &accelerator)
 171 {
 172     g_filter_items.push_back(ToggleFilterFlag(flag));
 173     GlobalToggles_insert(command, ToggleFilterFlag::ToggleCaller(g_filter_items.back()),
 174                          ToggleItem::AddCallbackCaller(g_filter_items.back().m_item), accelerator);
 175 }
 176
 177 void InvertFilters()
 178 {
 179     std::list<ToggleFilterFlag>::iterator iter;
 180
 181     for (iter = g_filter_items.begin(); iter != g_filter_items.end(); ++iter) {
 182         iter->toggle();
 183     }
 184 }
 185
 186 void ResetFilters()
 187 {
 188     std::list<ToggleFilterFlag>::iterator iter;
 189
 190     for (iter = g_filter_items.begin(); iter != g_filter_items.end(); ++iter) {
 191         iter->reset();
 192     }
 193 }
 194
 195 void Filters_constructMenu(ui::Menu menu_in_menu)
 196 {
 197     create_check_menu_item_with_mnemonic(menu_in_menu, "World", "FilterWorldBrushes");
 198     create_check_menu_item_with_mnemonic(menu_in_menu, "Entities", "FilterEntities");
 199     if (g_pGameDescription->mGameType == "doom3") {
 200         create_check_menu_item_with_mnemonic(menu_in_menu, "Visportals", "FilterVisportals");
 201     } else {
 202         create_check_menu_item_with_mnemonic(menu_in_menu, "Areaportals", "FilterAreaportals");
 203     }
 204     create_check_menu_item_with_mnemonic(menu_in_menu, "Translucent", "FilterTranslucent");
 205     if (g_pGameDescription->mGameType != "doom3") {
 206         create_check_menu_item_with_mnemonic(menu_in_menu, "Liquids", "FilterLiquids");
 207     }
 208     create_check_menu_item_with_mnemonic(menu_in_menu, "Caulk", "FilterCaulk");
 209     create_check_menu_item_with_mnemonic(menu_in_menu, "Clips", "FilterClips");
 210     create_check_menu_item_with_mnemonic(menu_in_menu, "Paths", "FilterPaths");
 211     if (g_pGameDescription->mGameType != "doom3") {
 212         create_check_menu_item_with_mnemonic(menu_in_menu, "Clusterportals", "FilterClusterportals");
 213     }
 214     create_check_menu_item_with_mnemonic(menu_in_menu, "Lights", "FilterLights");
 215     create_check_menu_item_with_mnemonic(menu_in_menu, "Structural", "FilterStructural");
 216     if (g_pGameDescription->mGameType != "doom3") {
 217         create_check_menu_item_with_mnemonic(menu_in_menu, "Lightgrid", "FilterLightgrid");
 218     }
 219     create_check_menu_item_with_mnemonic(menu_in_menu, "Patches", "FilterPatches");
 220     create_check_menu_item_with_mnemonic(menu_in_menu, "Details", "FilterDetails");
 221     create_check_menu_item_with_mnemonic(menu_in_menu, "Hints", "FilterHintsSkips");
 222     create_check_menu_item_with_mnemonic(menu_in_menu, "Models", "FilterModels");
 223     create_check_menu_item_with_mnemonic(menu_in_menu, "Triggers", "FilterTriggers");
 224     if (g_pGameDescription->mGameType != "doom3") {
 225         create_check_menu_item_with_mnemonic(menu_in_menu, "Botclips", "FilterBotClips");
 226         create_check_menu_item_with_mnemonic(menu_in_menu, "Decals", "FilterDecals");
 227     }
 228     // filter manipulation
 229     menu_separator(menu_in_menu);
 230     create_menu_item_with_mnemonic(menu_in_menu, "Invert filters", "InvertFilters");
 231     create_menu_item_with_mnemonic(menu_in_menu, "Reset filters", "ResetFilters");
 232 }
 233
 234
 235 #include "preferencesystem.h"
 236 #include "stringio.h"
 237
 238 void ConstructFilters()
 239 {
 240     GlobalPreferenceSystem().registerPreference("SI_Exclude", make_property_string(g_filters_globals.exclude));
 241
 242     GlobalCommands_insert("InvertFilters", makeCallbackF(InvertFilters));
 243     GlobalCommands_insert("ResetFilters", makeCallbackF(ResetFilters));
 244
 245     add_filter_command(EXCLUDE_WORLD, "FilterWorldBrushes", Accelerator('1', (GdkModifierType) GDK_MOD1_MASK));
 246     add_filter_command(EXCLUDE_ENT, "FilterEntities", Accelerator('2', (GdkModifierType) GDK_MOD1_MASK));
 247     if (g_pGameDescription->mGameType == "doom3") {
 248         add_filter_command(EXCLUDE_VISPORTALS, "FilterVisportals", Accelerator('3', (GdkModifierType) GDK_MOD1_MASK));
 249     } else {
 250         add_filter_command(EXCLUDE_AREAPORTALS, "FilterAreaportals", Accelerator('3', (GdkModifierType) GDK_MOD1_MASK));
 251     }
 252     add_filter_command(EXCLUDE_TRANSLUCENT, "FilterTranslucent", Accelerator('4', (GdkModifierType) GDK_MOD1_MASK));
 253     add_filter_command(EXCLUDE_LIQUIDS, "FilterLiquids", Accelerator('5', (GdkModifierType) GDK_MOD1_MASK));
 254     add_filter_command(EXCLUDE_CAULK, "FilterCaulk", Accelerator('6', (GdkModifierType) GDK_MOD1_MASK));
 255     add_filter_command(EXCLUDE_CLIP, "FilterClips", Accelerator('7', (GdkModifierType) GDK_MOD1_MASK));
 256     add_filter_command(EXCLUDE_PATHS, "FilterPaths", Accelerator('8', (GdkModifierType) GDK_MOD1_MASK));
 257     if (g_pGameDescription->mGameType != "doom3") {
 258         add_filter_command(EXCLUDE_CLUSTERPORTALS, "FilterClusterportals",
 259                            Accelerator('9', (GdkModifierType) GDK_MOD1_MASK));
 260     }
 261     add_filter_command(EXCLUDE_LIGHTS, "FilterLights", Accelerator('0', (GdkModifierType) GDK_MOD1_MASK));
 262     add_filter_command(EXCLUDE_STRUCTURAL, "FilterStructural",
 263                        Accelerator('D', (GdkModifierType) (GDK_SHIFT_MASK | GDK_CONTROL_MASK)));
 264     if (g_pGameDescription->mGameType != "doom3") {
 265         add_filter_command(EXCLUDE_LIGHTGRID, "FilterLightgrid", accelerator_null());
 266     }
 267     add_filter_command(EXCLUDE_CURVES, "FilterPatches", Accelerator('P', (GdkModifierType) GDK_CONTROL_MASK));
 268     add_filter_command(EXCLUDE_DETAILS, "FilterDetails", Accelerator('D', (GdkModifierType) GDK_CONTROL_MASK));
 269     add_filter_command(EXCLUDE_HINTSSKIPS, "FilterHintsSkips", Accelerator('H', (GdkModifierType) GDK_CONTROL_MASK));
 270     add_filter_command(EXCLUDE_MODELS, "FilterModels", Accelerator('M', (GdkModifierType) GDK_SHIFT_MASK));
 271     add_filter_command(EXCLUDE_TRIGGERS, "FilterTriggers",
 272                        Accelerator('T', (GdkModifierType) (GDK_SHIFT_MASK | GDK_CONTROL_MASK)));
 273     if (g_pGameDescription->mGameType != "doom3") {
 274         add_filter_command(EXCLUDE_BOTCLIP, "FilterBotClips", Accelerator('M', (GdkModifierType) GDK_MOD1_MASK));
 275         add_filter_command(EXCLUDE_DECALS, "FilterDecals", Accelerator('D', (GdkModifierType) GDK_SHIFT_MASK));
 276     }
 277
 278     PerformFiltering();
 279 }
 280
 281 void DestroyFilters()
 282 {
 283     g_filters.clear();
 284 }
 285
 286 #include "modulesystem/singletonmodule.h"
 287 #include "modulesystem/moduleregistry.h"
 288
 289 class FilterAPI {
 290     FilterSystem *m_filter;
 291 public:
 292     typedef FilterSystem Type;
 293
 294     STRING_CONSTANT(Name, "*");
 295
 296     FilterAPI()
 297     {
 298         ConstructFilters();
 299
 300         m_filter = &GetFilterSystem();
 301     }
 302
 303     ~FilterAPI()
 304     {
 305         DestroyFilters();
 306     }
 307
 308     FilterSystem *getTable()
 309     {
 310         return m_filter;
 311     }
 312 };
 313
 314 typedef SingletonModule<FilterAPI> FilterModule;
 315 typedef Static<FilterModule> StaticFilterModule;
 316 StaticRegisterModule staticRegisterFilter(StaticFilterModule::instance());