forked from MonoGame/MonoGame
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Game.cs
1040 lines (861 loc) · 36 KB
/
Game.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// MonoGame - Copyright (C) The MonoGame Team
// This file is subject to the terms and conditions defined in
// file 'LICENSE.txt', which is part of this source code package.
using System;
using System.Collections.Generic;
using System.Diagnostics;
#if WINRT
using System.Threading.Tasks;
using Windows.ApplicationModel.Activation;
#endif
using Microsoft.Xna.Framework.Audio;
using Microsoft.Xna.Framework.Content;
using Microsoft.Xna.Framework.Graphics;
using Microsoft.Xna.Framework.Input.Touch;
namespace Microsoft.Xna.Framework
{
public class Game : IDisposable
{
private GameComponentCollection _components;
private GameServiceContainer _services;
private ContentManager _content;
internal GamePlatform Platform;
private SortingFilteringCollection<IDrawable> _drawables =
new SortingFilteringCollection<IDrawable>(
d => d.Visible,
(d, handler) => d.VisibleChanged += handler,
(d, handler) => d.VisibleChanged -= handler,
(d1 ,d2) => Comparer<int>.Default.Compare(d1.DrawOrder, d2.DrawOrder),
(d, handler) => d.DrawOrderChanged += handler,
(d, handler) => d.DrawOrderChanged -= handler);
private SortingFilteringCollection<IUpdateable> _updateables =
new SortingFilteringCollection<IUpdateable>(
u => u.Enabled,
(u, handler) => u.EnabledChanged += handler,
(u, handler) => u.EnabledChanged -= handler,
(u1, u2) => Comparer<int>.Default.Compare(u1.UpdateOrder, u2.UpdateOrder),
(u, handler) => u.UpdateOrderChanged += handler,
(u, handler) => u.UpdateOrderChanged -= handler);
private IGraphicsDeviceManager _graphicsDeviceManager;
private IGraphicsDeviceService _graphicsDeviceService;
private bool _initialized = false;
private bool _isFixedTimeStep = true;
private TimeSpan _targetElapsedTime = TimeSpan.FromTicks(166667); // 60fps
private TimeSpan _inactiveSleepTime = TimeSpan.FromSeconds(0.02);
private TimeSpan _maxElapsedTime = TimeSpan.FromMilliseconds(500);
private bool _shouldExit;
private bool _suppressDraw;
public Game()
{
_instance = this;
LaunchParameters = new LaunchParameters();
_services = new GameServiceContainer();
_components = new GameComponentCollection();
_content = new ContentManager(_services);
Platform = GamePlatform.PlatformCreate(this);
Platform.Activated += OnActivated;
Platform.Deactivated += OnDeactivated;
_services.AddService(typeof(GamePlatform), Platform);
// Calling Update() for first time initializes some systems
FrameworkDispatcher.Update();
#if WINDOWS_STOREAPP && !WINDOWS_PHONE81
Platform.ViewStateChanged += Platform_ApplicationViewChanged;
#endif
}
~Game()
{
Dispose(false);
}
[System.Diagnostics.Conditional("DEBUG")]
internal void Log(string Message)
{
if (Platform != null) Platform.Log(Message);
}
#region IDisposable Implementation
private bool _isDisposed;
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
EventHelpers.Raise(this, Disposed, EventArgs.Empty);
}
protected virtual void Dispose(bool disposing)
{
if (!_isDisposed)
{
if (disposing)
{
// Dispose loaded game components
for (int i = 0; i < _components.Count; i++)
{
var disposable = _components[i] as IDisposable;
if (disposable != null)
disposable.Dispose();
}
_components = null;
if (_content != null)
{
_content.Dispose();
_content = null;
}
if (_graphicsDeviceManager != null)
{
(_graphicsDeviceManager as GraphicsDeviceManager).Dispose();
_graphicsDeviceManager = null;
}
if (Platform != null)
{
Platform.Activated -= OnActivated;
Platform.Deactivated -= OnDeactivated;
_services.RemoveService(typeof(GamePlatform));
#if WINDOWS_STOREAPP && !WINDOWS_PHONE81
Platform.ViewStateChanged -= Platform_ApplicationViewChanged;
#endif
Platform.Dispose();
Platform = null;
}
ContentTypeReaderManager.ClearTypeCreators();
SoundEffect.PlatformShutdown();
}
#if ANDROID
Activity = null;
#endif
_isDisposed = true;
_instance = null;
}
}
[System.Diagnostics.DebuggerNonUserCode]
private void AssertNotDisposed()
{
if (_isDisposed)
{
string name = GetType().Name;
throw new ObjectDisposedException(
name, string.Format("The {0} object was used after being Disposed.", name));
}
}
#endregion IDisposable Implementation
#region Properties
#if ANDROID
[CLSCompliant(false)]
public static AndroidGameActivity Activity { get; internal set; }
#endif
private static Game _instance = null;
internal static Game Instance { get { return Game._instance; } }
public LaunchParameters LaunchParameters { get; private set; }
public GameComponentCollection Components
{
get { return _components; }
}
public TimeSpan InactiveSleepTime
{
get { return _inactiveSleepTime; }
set
{
if (value < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("The time must be positive.", default(Exception));
_inactiveSleepTime = value;
}
}
/// <summary>
/// The maximum amount of time we will frameskip over and only perform Update calls with no Draw calls.
/// MonoGame extension.
/// </summary>
public TimeSpan MaxElapsedTime
{
get { return _maxElapsedTime; }
set
{
if (value < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("The time must be positive.", default(Exception));
if (value < _targetElapsedTime)
throw new ArgumentOutOfRangeException("The time must be at least TargetElapsedTime", default(Exception));
_maxElapsedTime = value;
}
}
public bool IsActive
{
get { return Platform.IsActive; }
}
public bool IsMouseVisible
{
get { return Platform.IsMouseVisible; }
set { Platform.IsMouseVisible = value; }
}
public TimeSpan TargetElapsedTime
{
get { return _targetElapsedTime; }
set
{
// Give GamePlatform implementations an opportunity to override
// the new value.
value = Platform.TargetElapsedTimeChanging(value);
if (value <= TimeSpan.Zero)
throw new ArgumentOutOfRangeException(
"The time must be positive and non-zero.", default(Exception));
if (value != _targetElapsedTime)
{
_targetElapsedTime = value;
Platform.TargetElapsedTimeChanged();
}
}
}
public bool IsFixedTimeStep
{
get { return _isFixedTimeStep; }
set { _isFixedTimeStep = value; }
}
public GameServiceContainer Services {
get { return _services; }
}
public ContentManager Content
{
get { return _content; }
set
{
if (value == null)
throw new ArgumentNullException();
_content = value;
}
}
public GraphicsDevice GraphicsDevice
{
get
{
if (_graphicsDeviceService == null)
{
_graphicsDeviceService = (IGraphicsDeviceService)
Services.GetService(typeof(IGraphicsDeviceService));
if (_graphicsDeviceService == null)
throw new InvalidOperationException("No Graphics Device Service");
}
return _graphicsDeviceService.GraphicsDevice;
}
}
[CLSCompliant(false)]
public GameWindow Window
{
get { return Platform.Window; }
}
#endregion Properties
#region Internal Properties
// FIXME: Internal members should be eliminated.
// Currently Game.Initialized is used by the Mac game window class to
// determine whether to raise DeviceResetting and DeviceReset on
// GraphicsDeviceManager.
internal bool Initialized
{
get { return _initialized; }
}
#endregion Internal Properties
#region Events
public event EventHandler<EventArgs> Activated;
public event EventHandler<EventArgs> Deactivated;
public event EventHandler<EventArgs> Disposed;
public event EventHandler<EventArgs> Exiting;
#if WINDOWS_STOREAPP && !WINDOWS_PHONE81
[CLSCompliant(false)]
public event EventHandler<ViewStateChangedEventArgs> ApplicationViewChanged;
#endif
#if WINRT
[CLSCompliant(false)]
public ApplicationExecutionState PreviousExecutionState { get; internal set; }
#endif
#endregion
#region Public Methods
#if IOS || WINDOWS_STOREAPP && !WINDOWS_PHONE81
[Obsolete("This platform's policy does not allow programmatically closing.", true)]
#endif
public void Exit()
{
_shouldExit = true;
_suppressDraw = true;
}
public void ResetElapsedTime()
{
Platform.ResetElapsedTime();
_gameTimer.Reset();
_gameTimer.Start();
_accumulatedElapsedTime = TimeSpan.Zero;
_gameTime.ElapsedGameTime = TimeSpan.Zero;
_previousTicks = 0L;
}
public void SuppressDraw()
{
_suppressDraw = true;
}
public void RunOneFrame()
{
if (Platform == null)
return;
if (!Platform.BeforeRun())
return;
if (!_initialized)
{
DoInitialize ();
_gameTimer = Stopwatch.StartNew();
_initialized = true;
}
BeginRun();
//Not quite right..
Tick ();
EndRun ();
}
public void Run()
{
Run(Platform.DefaultRunBehavior);
}
public void Run(GameRunBehavior runBehavior)
{
AssertNotDisposed();
if (!Platform.BeforeRun())
{
BeginRun();
_gameTimer = Stopwatch.StartNew();
return;
}
if (!_initialized) {
DoInitialize ();
_initialized = true;
}
BeginRun();
_gameTimer = Stopwatch.StartNew();
switch (runBehavior)
{
case GameRunBehavior.Asynchronous:
Platform.AsyncRunLoopEnded += Platform_AsyncRunLoopEnded;
Platform.StartRunLoop();
break;
case GameRunBehavior.Synchronous:
// XNA runs one Update even before showing the window
DoUpdate(new GameTime());
Platform.RunLoop();
EndRun();
DoExiting();
break;
default:
throw new ArgumentException(string.Format(
"Handling for the run behavior {0} is not implemented.", runBehavior));
}
}
private TimeSpan _accumulatedElapsedTime;
private readonly GameTime _gameTime = new GameTime();
private Stopwatch _gameTimer;
private long _previousTicks = 0;
private int _updateFrameLag;
public void Tick()
{
// NOTE: This code is very sensitive and can break very badly
// with even what looks like a safe change. Be sure to test
// any change fully in both the fixed and variable timestep
// modes across multiple devices and platforms.
RetryTick:
// Advance the accumulated elapsed time.
var currentTicks = _gameTimer.Elapsed.Ticks;
_accumulatedElapsedTime += TimeSpan.FromTicks(currentTicks - _previousTicks);
_previousTicks = currentTicks;
// If we're in the fixed timestep mode and not enough time has elapsed
// to perform an update we sleep off the the remaining time to save battery
// life and/or release CPU time to other threads and processes.
if (IsFixedTimeStep && _accumulatedElapsedTime < TargetElapsedTime)
{
var sleepTime = (int)(TargetElapsedTime - _accumulatedElapsedTime).TotalMilliseconds;
// NOTE: While sleep can be inaccurate in general it is
// accurate enough for frame limiting purposes if some
// fluctuation is an acceptable result.
#if WINRT
Task.Delay(sleepTime).Wait();
#else
System.Threading.Thread.Sleep(sleepTime);
#endif
goto RetryTick;
}
// Do not allow any update to take longer than our maximum.
if (_accumulatedElapsedTime > _maxElapsedTime)
_accumulatedElapsedTime = _maxElapsedTime;
if (IsFixedTimeStep)
{
_gameTime.ElapsedGameTime = TargetElapsedTime;
var stepCount = 0;
// Perform as many full fixed length time steps as we can.
while (_accumulatedElapsedTime >= TargetElapsedTime && !_shouldExit)
{
_gameTime.TotalGameTime += TargetElapsedTime;
_accumulatedElapsedTime -= TargetElapsedTime;
++stepCount;
DoUpdate(_gameTime);
}
//Every update after the first accumulates lag
_updateFrameLag += Math.Max(0, stepCount - 1);
//If we think we are running slowly, wait until the lag clears before resetting it
if (_gameTime.IsRunningSlowly)
{
if (_updateFrameLag == 0)
_gameTime.IsRunningSlowly = false;
}
else if (_updateFrameLag >= 5)
{
//If we lag more than 5 frames, start thinking we are running slowly
_gameTime.IsRunningSlowly = true;
}
//Every time we just do one update and one draw, then we are not running slowly, so decrease the lag
if (stepCount == 1 && _updateFrameLag > 0)
_updateFrameLag--;
// Draw needs to know the total elapsed time
// that occured for the fixed length updates.
_gameTime.ElapsedGameTime = TimeSpan.FromTicks(TargetElapsedTime.Ticks * stepCount);
}
else
{
// Perform a single variable length update.
_gameTime.ElapsedGameTime = _accumulatedElapsedTime;
_gameTime.TotalGameTime += _accumulatedElapsedTime;
_accumulatedElapsedTime = TimeSpan.Zero;
DoUpdate(_gameTime);
}
// Draw unless the update suppressed it.
if (_suppressDraw)
_suppressDraw = false;
else
{
DoDraw(_gameTime);
}
if (_shouldExit)
Platform.Exit();
}
#endregion
#region Protected Methods
protected virtual bool BeginDraw() { return true; }
protected virtual void EndDraw()
{
Platform.Present();
}
protected virtual void BeginRun() { }
protected virtual void EndRun() { }
protected virtual void LoadContent() { }
protected virtual void UnloadContent() { }
protected virtual void Initialize()
{
// TODO: This should be removed once all platforms use the new GraphicsDeviceManager
applyChanges(graphicsDeviceManager);
// According to the information given on MSDN (see link below), all
// GameComponents in Components at the time Initialize() is called
// are initialized.
// http://msdn.microsoft.com/en-us/library/microsoft.xna.framework.game.initialize.aspx
// Initialize all existing components
InitializeExistingComponents();
_graphicsDeviceService = (IGraphicsDeviceService)
Services.GetService(typeof(IGraphicsDeviceService));
if (_graphicsDeviceService != null &&
_graphicsDeviceService.GraphicsDevice != null)
{
LoadContent();
}
}
private static readonly Action<IDrawable, GameTime> DrawAction =
(drawable, gameTime) => drawable.Draw(gameTime);
protected virtual void Draw(GameTime gameTime)
{
_drawables.ForEachFilteredItem(DrawAction, gameTime);
}
private static readonly Action<IUpdateable, GameTime> UpdateAction =
(updateable, gameTime) => updateable.Update(gameTime);
protected virtual void Update(GameTime gameTime)
{
_updateables.ForEachFilteredItem(UpdateAction, gameTime);
}
protected virtual void OnExiting(object sender, EventArgs args)
{
EventHelpers.Raise(this, Exiting, args);
}
protected virtual void OnActivated (object sender, EventArgs args)
{
AssertNotDisposed();
EventHelpers.Raise(this, Activated, args);
}
protected virtual void OnDeactivated (object sender, EventArgs args)
{
AssertNotDisposed();
EventHelpers.Raise(this, Deactivated, args);
}
#endregion Protected Methods
#region Event Handlers
private void Components_ComponentAdded(
object sender, GameComponentCollectionEventArgs e)
{
// Since we only subscribe to ComponentAdded after the graphics
// devices are set up, it is safe to just blindly call Initialize.
e.GameComponent.Initialize();
CategorizeComponent(e.GameComponent);
}
private void Components_ComponentRemoved(
object sender, GameComponentCollectionEventArgs e)
{
DecategorizeComponent(e.GameComponent);
}
private void Platform_AsyncRunLoopEnded(object sender, EventArgs e)
{
AssertNotDisposed();
var platform = (GamePlatform)sender;
platform.AsyncRunLoopEnded -= Platform_AsyncRunLoopEnded;
EndRun();
DoExiting();
}
#if WINDOWS_STOREAPP && !WINDOWS_PHONE81
private void Platform_ApplicationViewChanged(object sender, ViewStateChangedEventArgs e)
{
AssertNotDisposed();
EventHelpers.Raise(this, ApplicationViewChanged, e);
}
#endif
#endregion Event Handlers
#region Internal Methods
// FIXME: We should work toward eliminating internal methods. They
// break entirely the possibility that additional platforms could
// be added by third parties without changing MonoGame itself.
internal void applyChanges(GraphicsDeviceManager manager)
{
Platform.BeginScreenDeviceChange(GraphicsDevice.PresentationParameters.IsFullScreen);
#if !(WINDOWS && DIRECTX)
if (GraphicsDevice.PresentationParameters.IsFullScreen)
Platform.EnterFullScreen();
else
Platform.ExitFullScreen();
#endif
var viewport = new Viewport(0, 0,
GraphicsDevice.PresentationParameters.BackBufferWidth,
GraphicsDevice.PresentationParameters.BackBufferHeight);
GraphicsDevice.Viewport = viewport;
Platform.EndScreenDeviceChange(string.Empty, viewport.Width, viewport.Height);
}
internal void DoUpdate(GameTime gameTime)
{
AssertNotDisposed();
if (Platform.BeforeUpdate(gameTime))
{
FrameworkDispatcher.Update();
Update(gameTime);
//The TouchPanel needs to know the time for when touches arrive
TouchPanelState.CurrentTimestamp = gameTime.TotalGameTime;
}
}
internal void DoDraw(GameTime gameTime)
{
AssertNotDisposed();
// Draw and EndDraw should not be called if BeginDraw returns false.
// http://stackoverflow.com/questions/4054936/manual-control-over-when-to-redraw-the-screen/4057180#4057180
// http://stackoverflow.com/questions/4235439/xna-3-1-to-4-0-requires-constant-redraw-or-will-display-a-purple-screen
if (Platform.BeforeDraw(gameTime) && BeginDraw())
{
Draw(gameTime);
EndDraw();
}
}
internal void DoInitialize()
{
AssertNotDisposed();
if (GraphicsDevice == null && graphicsDeviceManager != null)
_graphicsDeviceManager.CreateDevice();
Platform.BeforeInitialize();
Initialize();
// We need to do this after virtual Initialize(...) is called.
// 1. Categorize components into IUpdateable and IDrawable lists.
// 2. Subscribe to Added/Removed events to keep the categorized
// lists synced and to Initialize future components as they are
// added.
CategorizeComponents();
_components.ComponentAdded += Components_ComponentAdded;
_components.ComponentRemoved += Components_ComponentRemoved;
}
internal void DoExiting()
{
OnExiting(this, EventArgs.Empty);
UnloadContent();
}
#endregion Internal Methods
internal GraphicsDeviceManager graphicsDeviceManager
{
get
{
if (_graphicsDeviceManager == null)
{
_graphicsDeviceManager = (IGraphicsDeviceManager)
Services.GetService(typeof(IGraphicsDeviceManager));
}
return (GraphicsDeviceManager)_graphicsDeviceManager;
}
set
{
if (_graphicsDeviceManager != null)
throw new InvalidOperationException("GraphicsDeviceManager already registered for this Game object");
_graphicsDeviceManager = value;
}
}
// NOTE: InitializeExistingComponents really should only be called once.
// Game.Initialize is the only method in a position to guarantee
// that no component will get a duplicate Initialize call.
// Further calls to Initialize occur immediately in response to
// Components.ComponentAdded.
private void InitializeExistingComponents()
{
for(int i = 0; i < Components.Count; ++i)
Components[i].Initialize();
}
private void CategorizeComponents()
{
DecategorizeComponents();
for (int i = 0; i < Components.Count; ++i)
CategorizeComponent(Components[i]);
}
// FIXME: I am open to a better name for this method. It does the
// opposite of CategorizeComponents.
private void DecategorizeComponents()
{
_updateables.Clear();
_drawables.Clear();
}
private void CategorizeComponent(IGameComponent component)
{
if (component is IUpdateable)
_updateables.Add((IUpdateable)component);
if (component is IDrawable)
_drawables.Add((IDrawable)component);
}
// FIXME: I am open to a better name for this method. It does the
// opposite of CategorizeComponent.
private void DecategorizeComponent(IGameComponent component)
{
if (component is IUpdateable)
_updateables.Remove((IUpdateable)component);
if (component is IDrawable)
_drawables.Remove((IDrawable)component);
}
/// <summary>
/// The SortingFilteringCollection class provides efficient, reusable
/// sorting and filtering based on a configurable sort comparer, filter
/// predicate, and associate change events.
/// </summary>
class SortingFilteringCollection<T> : ICollection<T>
{
private readonly List<T> _items;
private readonly List<AddJournalEntry<T>> _addJournal;
private readonly Comparison<AddJournalEntry<T>> _addJournalSortComparison;
private readonly List<int> _removeJournal;
private readonly List<T> _cachedFilteredItems;
private bool _shouldRebuildCache;
private readonly Predicate<T> _filter;
private readonly Comparison<T> _sort;
private readonly Action<T, EventHandler<EventArgs>> _filterChangedSubscriber;
private readonly Action<T, EventHandler<EventArgs>> _filterChangedUnsubscriber;
private readonly Action<T, EventHandler<EventArgs>> _sortChangedSubscriber;
private readonly Action<T, EventHandler<EventArgs>> _sortChangedUnsubscriber;
public SortingFilteringCollection(
Predicate<T> filter,
Action<T, EventHandler<EventArgs>> filterChangedSubscriber,
Action<T, EventHandler<EventArgs>> filterChangedUnsubscriber,
Comparison<T> sort,
Action<T, EventHandler<EventArgs>> sortChangedSubscriber,
Action<T, EventHandler<EventArgs>> sortChangedUnsubscriber)
{
_items = new List<T>();
_addJournal = new List<AddJournalEntry<T>>();
_removeJournal = new List<int>();
_cachedFilteredItems = new List<T>();
_shouldRebuildCache = true;
_filter = filter;
_filterChangedSubscriber = filterChangedSubscriber;
_filterChangedUnsubscriber = filterChangedUnsubscriber;
_sort = sort;
_sortChangedSubscriber = sortChangedSubscriber;
_sortChangedUnsubscriber = sortChangedUnsubscriber;
_addJournalSortComparison = CompareAddJournalEntry;
}
private int CompareAddJournalEntry(AddJournalEntry<T> x, AddJournalEntry<T> y)
{
int result = _sort(x.Item, y.Item);
if (result != 0)
return result;
return x.Order - y.Order;
}
public void ForEachFilteredItem<TUserData>(Action<T, TUserData> action, TUserData userData)
{
if (_shouldRebuildCache)
{
ProcessRemoveJournal();
ProcessAddJournal();
// Rebuild the cache
_cachedFilteredItems.Clear();
for (int i = 0; i < _items.Count; ++i)
if (_filter(_items[i]))
_cachedFilteredItems.Add(_items[i]);
_shouldRebuildCache = false;
}
for (int i = 0; i < _cachedFilteredItems.Count; ++i)
action(_cachedFilteredItems[i], userData);
// If the cache was invalidated as a result of processing items,
// now is a good time to clear it and give the GC (more of) a
// chance to do its thing.
if (_shouldRebuildCache)
_cachedFilteredItems.Clear();
}
public void Add(T item)
{
// NOTE: We subscribe to item events after items in _addJournal
// have been merged.
_addJournal.Add(new AddJournalEntry<T>(_addJournal.Count, item));
InvalidateCache();
}
public bool Remove(T item)
{
if (_addJournal.Remove(AddJournalEntry<T>.CreateKey(item)))
return true;
var index = _items.IndexOf(item);
if (index >= 0)
{
UnsubscribeFromItemEvents(item);
_removeJournal.Add(index);
InvalidateCache();
return true;
}
return false;
}
public void Clear()
{
for (int i = 0; i < _items.Count; ++i)
{
_filterChangedUnsubscriber(_items[i], Item_FilterPropertyChanged);
_sortChangedUnsubscriber(_items[i], Item_SortPropertyChanged);
}
_addJournal.Clear();
_removeJournal.Clear();
_items.Clear();
InvalidateCache();
}
public bool Contains(T item)
{
return _items.Contains(item);
}
public void CopyTo(T[] array, int arrayIndex)
{
_items.CopyTo(array, arrayIndex);
}
public int Count
{
get { return _items.Count; }
}
public bool IsReadOnly
{
get { return false; }
}
public IEnumerator<T> GetEnumerator()
{
return _items.GetEnumerator();
}
System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator()
{
return ((System.Collections.IEnumerable)_items).GetEnumerator();
}
private static readonly Comparison<int> RemoveJournalSortComparison =
(x, y) => Comparer<int>.Default.Compare(y, x); // Sort high to low
private void ProcessRemoveJournal()
{
if (_removeJournal.Count == 0)
return;
// Remove items in reverse. (Technically there exist faster
// ways to bulk-remove from a variable-length array, but List<T>
// does not provide such a method.)
_removeJournal.Sort(RemoveJournalSortComparison);
for (int i = 0; i < _removeJournal.Count; ++i)
_items.RemoveAt(_removeJournal[i]);
_removeJournal.Clear();
}
private void ProcessAddJournal()
{
if (_addJournal.Count == 0)
return;
// Prepare the _addJournal to be merge-sorted with _items.
// _items is already sorted (because it is always sorted).
_addJournal.Sort(_addJournalSortComparison);
int iAddJournal = 0;
int iItems = 0;
while (iItems < _items.Count && iAddJournal < _addJournal.Count)
{
var addJournalItem = _addJournal[iAddJournal].Item;
// If addJournalItem is less than (belongs before)
// _items[iItems], insert it.
if (_sort(addJournalItem, _items[iItems]) < 0)
{
SubscribeToItemEvents(addJournalItem);
_items.Insert(iItems, addJournalItem);
++iAddJournal;
}
// Always increment iItems, either because we inserted and
// need to move past the insertion, or because we didn't
// insert and need to consider the next element.
++iItems;
}
// If _addJournal had any "tail" items, append them all now.
for (; iAddJournal < _addJournal.Count; ++iAddJournal)
{
var addJournalItem = _addJournal[iAddJournal].Item;
SubscribeToItemEvents(addJournalItem);
_items.Add(addJournalItem);
}
_addJournal.Clear();
}
private void SubscribeToItemEvents(T item)
{
_filterChangedSubscriber(item, Item_FilterPropertyChanged);
_sortChangedSubscriber(item, Item_SortPropertyChanged);
}
private void UnsubscribeFromItemEvents(T item)
{
_filterChangedUnsubscriber(item, Item_FilterPropertyChanged);
_sortChangedUnsubscriber(item, Item_SortPropertyChanged);
}
private void InvalidateCache()
{
_shouldRebuildCache = true;
}
private void Item_FilterPropertyChanged(object sender, EventArgs e)
{
InvalidateCache();
}
private void Item_SortPropertyChanged(object sender, EventArgs e)
{
var item = (T)sender;
var index = _items.IndexOf(item);
_addJournal.Add(new AddJournalEntry<T>(_addJournal.Count, item));