-
Notifications
You must be signed in to change notification settings - Fork 193
/
Copy pathsrc_input_Mouse.ts.html
899 lines (678 loc) · 32.2 KB
/
src_input_Mouse.ts.html
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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>src\input\Mouse.ts - Kiwi.js</title>
<link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
<script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="../assets/css/logo.png" title="Kiwi.js"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 1.4.0</em>
</div>
</div>
<div id="bd" class="yui3-g">
<div class="yui3-u-1-4">
<div id="docs-sidebar" class="sidebar apidocs">
<div id="api-list">
<h2 class="off-left">APIs</h2>
<div id="api-tabview" class="tabview">
<ul class="tabs">
<li><a href="#api-classes">Classes</a></li>
<li><a href="#api-modules">Modules</a></li>
</ul>
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
</div>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="../classes/Kiwi.Animations.Animation.html">Kiwi.Animations.Animation</a></li>
<li><a href="../classes/Kiwi.Animations.Sequence.html">Kiwi.Animations.Sequence</a></li>
<li><a href="../classes/Kiwi.Animations.Tween.html">Kiwi.Animations.Tween</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Back.html">Kiwi.Animations.Tweens.Easing.Back</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Bounce.html">Kiwi.Animations.Tweens.Easing.Bounce</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Circular.html">Kiwi.Animations.Tweens.Easing.Circular</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Cubic.html">Kiwi.Animations.Tweens.Easing.Cubic</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Elastic.html">Kiwi.Animations.Tweens.Easing.Elastic</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Exponential.html">Kiwi.Animations.Tweens.Easing.Exponential</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Linear.html">Kiwi.Animations.Tweens.Easing.Linear</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Quadratic.html">Kiwi.Animations.Tweens.Easing.Quadratic</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Quartic.html">Kiwi.Animations.Tweens.Easing.Quartic</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Quintic.html">Kiwi.Animations.Tweens.Easing.Quintic</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Sinusoidal.html">Kiwi.Animations.Tweens.Easing.Sinusoidal</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.TweenManager.html">Kiwi.Animations.Tweens.TweenManager</a></li>
<li><a href="../classes/Kiwi.Camera.html">Kiwi.Camera</a></li>
<li><a href="../classes/Kiwi.CameraManager.html">Kiwi.CameraManager</a></li>
<li><a href="../classes/Kiwi.Component.html">Kiwi.Component</a></li>
<li><a href="../classes/Kiwi.ComponentManager.html">Kiwi.ComponentManager</a></li>
<li><a href="../classes/Kiwi.Components.AnimationManager.html">Kiwi.Components.AnimationManager</a></li>
<li><a href="../classes/Kiwi.Components.ArcadePhysics.html">Kiwi.Components.ArcadePhysics</a></li>
<li><a href="../classes/Kiwi.Components.Box.html">Kiwi.Components.Box</a></li>
<li><a href="../classes/Kiwi.Components.Input.html">Kiwi.Components.Input</a></li>
<li><a href="../classes/Kiwi.Components.Sound.html">Kiwi.Components.Sound</a></li>
<li><a href="../classes/Kiwi.Entity.html">Kiwi.Entity</a></li>
<li><a href="../classes/Kiwi.Files.AudioFile.html">Kiwi.Files.AudioFile</a></li>
<li><a href="../classes/Kiwi.Files.DataFile.html">Kiwi.Files.DataFile</a></li>
<li><a href="../classes/Kiwi.Files.DataLibrary.html">Kiwi.Files.DataLibrary</a></li>
<li><a href="../classes/Kiwi.Files.File.html">Kiwi.Files.File</a></li>
<li><a href="../classes/Kiwi.Files.FileStore.html">Kiwi.Files.FileStore</a></li>
<li><a href="../classes/Kiwi.Files.Loader.html">Kiwi.Files.Loader</a></li>
<li><a href="../classes/Kiwi.Files.TextureFile.html">Kiwi.Files.TextureFile</a></li>
<li><a href="../classes/Kiwi.Game.html">Kiwi.Game</a></li>
<li><a href="../classes/Kiwi.GameManager.html">Kiwi.GameManager</a></li>
<li><a href="../classes/Kiwi.GameObjects.Sprite.html">Kiwi.GameObjects.Sprite</a></li>
<li><a href="../classes/Kiwi.GameObjects.StaticImage.html">Kiwi.GameObjects.StaticImage</a></li>
<li><a href="../classes/Kiwi.GameObjects.TextField.html">Kiwi.GameObjects.TextField</a></li>
<li><a href="../classes/Kiwi.GameObjects.Tilemap.TileMap.html">Kiwi.GameObjects.Tilemap.TileMap</a></li>
<li><a href="../classes/Kiwi.GameObjects.Tilemap.TileMapLayer.html">Kiwi.GameObjects.Tilemap.TileMapLayer</a></li>
<li><a href="../classes/Kiwi.GameObjects.Tilemap.TileMapLayerIsometric.html">Kiwi.GameObjects.Tilemap.TileMapLayerIsometric</a></li>
<li><a href="../classes/Kiwi.GameObjects.Tilemap.TileMapLayerOrthogonal.html">Kiwi.GameObjects.Tilemap.TileMapLayerOrthogonal</a></li>
<li><a href="../classes/Kiwi.GameObjects.Tilemap.TileType.html">Kiwi.GameObjects.Tilemap.TileType</a></li>
<li><a href="../classes/Kiwi.Geom.AABB.html">Kiwi.Geom.AABB</a></li>
<li><a href="../classes/Kiwi.Geom.Circle.html">Kiwi.Geom.Circle</a></li>
<li><a href="../classes/Kiwi.Geom.Intersect.html">Kiwi.Geom.Intersect</a></li>
<li><a href="../classes/Kiwi.Geom.IntersectResult.html">Kiwi.Geom.IntersectResult</a></li>
<li><a href="../classes/Kiwi.Geom.Line.html">Kiwi.Geom.Line</a></li>
<li><a href="../classes/Kiwi.Geom.Matrix.html">Kiwi.Geom.Matrix</a></li>
<li><a href="../classes/Kiwi.Geom.Point.html">Kiwi.Geom.Point</a></li>
<li><a href="../classes/Kiwi.Geom.Ray.html">Kiwi.Geom.Ray</a></li>
<li><a href="../classes/Kiwi.Geom.Rectangle.html">Kiwi.Geom.Rectangle</a></li>
<li><a href="../classes/Kiwi.Geom.Transform.html">Kiwi.Geom.Transform</a></li>
<li><a href="../classes/Kiwi.Geom.Vector2.html">Kiwi.Geom.Vector2</a></li>
<li><a href="../classes/Kiwi.Group.html">Kiwi.Group</a></li>
<li><a href="../classes/Kiwi.HUD.HUDComponents.Counter.html">Kiwi.HUD.HUDComponents.Counter</a></li>
<li><a href="../classes/Kiwi.HUD.HUDComponents.Time.html">Kiwi.HUD.HUDComponents.Time</a></li>
<li><a href="../classes/Kiwi.HUD.HUDComponents.WidgetInput.html">Kiwi.HUD.HUDComponents.WidgetInput</a></li>
<li><a href="../classes/Kiwi.HUD.HUDDisplay.html">Kiwi.HUD.HUDDisplay</a></li>
<li><a href="../classes/Kiwi.HUD.HUDManager.html">Kiwi.HUD.HUDManager</a></li>
<li><a href="../classes/Kiwi.HUD.HUDWidget.html">Kiwi.HUD.HUDWidget</a></li>
<li><a href="../classes/Kiwi.HUD.Widget.Bar.html">Kiwi.HUD.Widget.Bar</a></li>
<li><a href="../classes/Kiwi.HUD.Widget.BasicScore.html">Kiwi.HUD.Widget.BasicScore</a></li>
<li><a href="../classes/Kiwi.HUD.Widget.Button.html">Kiwi.HUD.Widget.Button</a></li>
<li><a href="../classes/Kiwi.HUD.Widget.Icon.html">Kiwi.HUD.Widget.Icon</a></li>
<li><a href="../classes/Kiwi.HUD.Widget.IconBar.html">Kiwi.HUD.Widget.IconBar</a></li>
<li><a href="../classes/Kiwi.HUD.Widget.Menu.html">Kiwi.HUD.Widget.Menu</a></li>
<li><a href="../classes/Kiwi.HUD.Widget.MenuItem.html">Kiwi.HUD.Widget.MenuItem</a></li>
<li><a href="../classes/Kiwi.HUD.Widget.TextField.html">Kiwi.HUD.Widget.TextField</a></li>
<li><a href="../classes/Kiwi.HUD.Widget.Time.html">Kiwi.HUD.Widget.Time</a></li>
<li><a href="../classes/Kiwi.IChild.html">Kiwi.IChild</a></li>
<li><a href="../classes/Kiwi.Input.Finger.html">Kiwi.Input.Finger</a></li>
<li><a href="../classes/Kiwi.Input.InputManager.html">Kiwi.Input.InputManager</a></li>
<li><a href="../classes/Kiwi.Input.Key.html">Kiwi.Input.Key</a></li>
<li><a href="../classes/Kiwi.Input.Keyboard.html">Kiwi.Input.Keyboard</a></li>
<li><a href="../classes/Kiwi.Input.Keycodes.html">Kiwi.Input.Keycodes</a></li>
<li><a href="../classes/Kiwi.Input.Mouse.html">Kiwi.Input.Mouse</a></li>
<li><a href="../classes/Kiwi.Input.MouseCursor.html">Kiwi.Input.MouseCursor</a></li>
<li><a href="../classes/Kiwi.Input.Pointer.html">Kiwi.Input.Pointer</a></li>
<li><a href="../classes/Kiwi.Input.Touch.html">Kiwi.Input.Touch</a></li>
<li><a href="../classes/Kiwi.PluginManager.html">Kiwi.PluginManager</a></li>
<li><a href="../classes/Kiwi.Renderers.CanvasRenderer.html">Kiwi.Renderers.CanvasRenderer</a></li>
<li><a href="../classes/Kiwi.Renderers.GLArrayBuffer.html">Kiwi.Renderers.GLArrayBuffer</a></li>
<li><a href="../classes/Kiwi.Renderers.GLBlendMode.html">Kiwi.Renderers.GLBlendMode</a></li>
<li><a href="../classes/Kiwi.Renderers.GLElementArrayBuffer.html">Kiwi.Renderers.GLElementArrayBuffer</a></li>
<li><a href="../classes/Kiwi.Renderers.GLRenderManager.html">Kiwi.Renderers.GLRenderManager</a></li>
<li><a href="../classes/Kiwi.Renderers.GLTextureManager.html">Kiwi.Renderers.GLTextureManager</a></li>
<li><a href="../classes/Kiwi.Renderers.GLTextureWrapper.html">Kiwi.Renderers.GLTextureWrapper</a></li>
<li><a href="../classes/Kiwi.Renderers.Renderer.html">Kiwi.Renderers.Renderer</a></li>
<li><a href="../classes/Kiwi.Renderers.TextureAtlasRenderer.html">Kiwi.Renderers.TextureAtlasRenderer</a></li>
<li><a href="../classes/Kiwi.Shaders.ShaderManager.html">Kiwi.Shaders.ShaderManager</a></li>
<li><a href="../classes/Kiwi.Shaders.ShaderPair.html">Kiwi.Shaders.ShaderPair</a></li>
<li><a href="../classes/Kiwi.Shaders.TextureAtlasShader.html">Kiwi.Shaders.TextureAtlasShader</a></li>
<li><a href="../classes/Kiwi.Signal.html">Kiwi.Signal</a></li>
<li><a href="../classes/Kiwi.SignalBinding.html">Kiwi.SignalBinding</a></li>
<li><a href="../classes/Kiwi.Sound.Audio.html">Kiwi.Sound.Audio</a></li>
<li><a href="../classes/Kiwi.Sound.AudioLibrary.html">Kiwi.Sound.AudioLibrary</a></li>
<li><a href="../classes/Kiwi.Sound.AudioManager.html">Kiwi.Sound.AudioManager</a></li>
<li><a href="../classes/Kiwi.Stage.html">Kiwi.Stage</a></li>
<li><a href="../classes/Kiwi.State.html">Kiwi.State</a></li>
<li><a href="../classes/Kiwi.StateConfig.html">Kiwi.StateConfig</a></li>
<li><a href="../classes/Kiwi.StateManager.html">Kiwi.StateManager</a></li>
<li><a href="../classes/Kiwi.System.Bootstrap.html">Kiwi.System.Bootstrap</a></li>
<li><a href="../classes/Kiwi.System.Device.html">Kiwi.System.Device</a></li>
<li><a href="../classes/Kiwi.Textures.SingleImage.html">Kiwi.Textures.SingleImage</a></li>
<li><a href="../classes/Kiwi.Textures.SpriteSheet.html">Kiwi.Textures.SpriteSheet</a></li>
<li><a href="../classes/Kiwi.Textures.TextureAtlas.html">Kiwi.Textures.TextureAtlas</a></li>
<li><a href="../classes/Kiwi.Textures.TextureLibrary.html">Kiwi.Textures.TextureLibrary</a></li>
<li><a href="../classes/Kiwi.Time.Clock.html">Kiwi.Time.Clock</a></li>
<li><a href="../classes/Kiwi.Time.ClockManager.html">Kiwi.Time.ClockManager</a></li>
<li><a href="../classes/Kiwi.Time.MasterClock.html">Kiwi.Time.MasterClock</a></li>
<li><a href="../classes/Kiwi.Time.Timer.html">Kiwi.Time.Timer</a></li>
<li><a href="../classes/Kiwi.Time.TimerEvent.html">Kiwi.Time.TimerEvent</a></li>
<li><a href="../classes/Kiwi.Utils.Canvas.html">Kiwi.Utils.Canvas</a></li>
<li><a href="../classes/Kiwi.Utils.Color.html">Kiwi.Utils.Color</a></li>
<li><a href="../classes/Kiwi.Utils.Common.html">Kiwi.Utils.Common</a></li>
<li><a href="../classes/Kiwi.Utils.GameMath.html">Kiwi.Utils.GameMath</a></li>
<li><a href="../classes/Kiwi.Utils.Log.html">Kiwi.Utils.Log</a></li>
<li><a href="../classes/Kiwi.Utils.RandomDataGenerator.html">Kiwi.Utils.RandomDataGenerator</a></li>
<li><a href="../classes/Kiwi.Utils.RequestAnimationFrame.html">Kiwi.Utils.RequestAnimationFrame</a></li>
<li><a href="../classes/Kiwi.Utils.Version.html">Kiwi.Utils.Version</a></li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a href="../modules/Animations.html">Animations</a></li>
<li><a href="../modules/Components.html">Components</a></li>
<li><a href="../modules/Easing.html">Easing</a></li>
<li><a href="../modules/Files.html">Files</a></li>
<li><a href="../modules/GameObjects.html">GameObjects</a></li>
<li><a href="../modules/Geom.html">Geom</a></li>
<li><a href="../modules/HUD.html">HUD</a></li>
<li><a href="../modules/HUDComponents.html">HUDComponents</a></li>
<li><a href="../modules/Input.html">Input</a></li>
<li><a href="../modules/Kiwi.html">Kiwi</a></li>
<li><a href="../modules/Renderers.html">Renderers</a></li>
<li><a href="../modules/Shaders.html">Shaders</a></li>
<li><a href="../modules/Sound.html">Sound</a></li>
<li><a href="../modules/System.html">System</a></li>
<li><a href="../modules/Textures.html">Textures</a></li>
<li><a href="../modules/Tilemap.html">Tilemap</a></li>
<li><a href="../modules/Time.html">Time</a></li>
<li><a href="../modules/Tweens.html">Tweens</a></li>
<li><a href="../modules/Utils.html">Utils</a></li>
<li><a href="../modules/Utils..html">Utils.</a></li>
<li><a href="../modules/Widget.html">Widget</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui3-u-3-4">
<div id="api-options">
Show:
<label for="api-show-inherited">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</div>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1 class="file-heading">File: src\input\Mouse.ts</h1>
<div class="file">
<pre class="code prettyprint linenums">
/**
*
* @module Kiwi
* @submodule Input
*
*/
module Kiwi.Input {
/**
* Handles the dispatching/management of Mouse Events on a game. When this class is instantiated a MouseCursor object is also created (on this object) which holds the information that is unique to the mouse cursor, although majority of that information is still accessible inside this object.
*
* @class Mouse
* @constructor
* @namespace Kiwi.Input
* @param game {Kiwi.Game} The game that this mouse manager belongs to.
* @return {Kiwi.Input.Mouse}
*
*/
export class Mouse {
constructor (game: Kiwi.Game) {
this._game = game;
}
/**
* The type of object that this is.
* @method objType
* @return {String} "Mouse"
* @public
*/
public objType() {
return "Mouse";
}
/**
* The game that this mouse manager belongs to.
* @property _game
* @type Kiwi.Game
* @private
*/
private _game: Kiwi.Game;
/**
* The HTMLElement that is being used to apply the mouse events to.
* @property _domElement
* @type HTMLDivElement
* @private
*/
private _domElement:HTMLDivElement = null;
/**
* The numeric value for the LEFT button.
* @property LEFT_BUTTON
* @type Number
* @static
* @public
* @final
* @default 0
*/
public static LEFT_BUTTON: number = 0;
/**
* The numeric value for the MIDDLE button.
* @property MIDDLE_BUTTON
* @type Number
* @static
* @public
* @final
* @default 1
*/
public static MIDDLE_BUTTON: number = 1;
/**
* The numeric value for the RIGHT button.
* @property RIGHT_BUTTON
* @type Number
* @static
* @public
* @final
* @default 2
*/
public static RIGHT_BUTTON: number = 2;
/**
* A Signal that dispatches events when the mouse is pressed down on the stage.
* @property onDown
* @type Kiwi.Signal
* @public
*/
public onDown: Kiwi.Signal;
/**
* A Signal that dispatches events when the mouse is released from being down on the stage.
* @property onUp
* @type Kiwi.Signal
* @public
*/
public onUp: Kiwi.Signal;
/**
* A Signal that dispatches events mouse wheel moves.
* @property onWheel
* @type Kiwi.Signal
* @public
*/
public onWheel: Kiwi.Signal;
/**
* The MouseCursor that is on the stage. This contains the coordinates and information about the cursor.
* @property _cursor
* @type Kiwi.Input.MouseCursor
* @private
*/
private _cursor: Kiwi.Input.MouseCursor;
/**
* Returns the MouseCursor that is being used on the stage. This is READ ONLY.
* @property cursor
* @type Kiwi.Input.MouseCursor
* @private
*/
public get cursor(): Kiwi.Input.MouseCursor {
return this._cursor;
}
/**
* This method is executed when the DOM has finished loading and thus the MouseManager can start listening for events.
* @method boot
* @public
*/
public boot() {
this._domElement = this._game.stage.container;
this._cursor = new Kiwi.Input.MouseCursor(this._game);
this._cursor.active = true;
this._cursor.id = 1;
this.onDown = new Kiwi.Signal();
this.onUp = new Kiwi.Signal();
this.onWheel = new Kiwi.Signal();
this.onContext = new Kiwi.Signal();
this.start();
}
/**
* Indicates whether or not the cursor is currently down. This is READ ONLY.
* @property isDown
* @type boolean
* @default false
* @public
*/
public get isDown(): boolean {
return this._cursor.isDown;
}
/**
* Indicates whether or not the cursor is currently up. This is READ ONLY.
* @property isUp
* @type boolean
* @default true
* @public
*/
public get isUp(): boolean {
return this._cursor.isUp;
}
/**
* Gets the duration in Milliseconds that the mouse cursor has either been up or down for.
* @property duration
* @type number
* @public
*/
public get duration(): number {
return this._cursor.duration;
}
/**
* Gets the x coordinate of the mouse cursor.
* @property x
* @type number
* @public
*/
public get x(): number {
return this._cursor.x;
}
/**
* Gets the y coordinate of the mouse cursor.
* @property y
* @type number
* @public
*/
public get y(): number {
return this._cursor.y;
}
/**
* Gets the wheelDeltaX coordinate of the mouse cursors wheel.
* @property wheelDeltaX
* @type number
* @public
*/
public get wheelDeltaX(): number {
return this._cursor.wheelDeltaX;
}
/**
* Gets the wheelDeltaY coordinate of the mouse cursors wheel.
* @property wheelDeltaY
* @type number
* @public
*/
public get wheelDeltaY(): number {
return this._cursor.wheelDeltaY;
}
/**
* Indicates if the ctrl key is down.
* @property ctrlKey
* @type boolean
* @default false
* @public
*/
public get ctrlKey(): boolean {
return this._cursor.ctrlKey;
}
/**
* Indicates if the shift key is down.
* @property shiftKey
* @type boolean
* @default false
* @public
*/
public get shiftKey(): boolean {
return this._cursor.shiftKey;
}
/**
* Indicates if the alt key is down.
* @property altKey
* @type boolean
* @default false
* @public
*/
public get altKey(): boolean {
return this._cursor.altKey;
}
/**
* Returns a number indicating the button that was used. This can be used with the STATIC button properties.
* @property button
* @type number
* @public
*/
public get button(): number {
return this._cursor.button;
}
/**
* The update loop for the cursor.
* @method update
* @public
*/
public update() {
this._cursor.update();
}
/**
* Start the mouse event listeners on the game. Automatically called by the boot.
* @method start
* @public
*/
public start() {
this._onMouseDownBind = this.onMouseDown.bind(this);
this._onMouseMoveBind = this.onMouseMove.bind(this);
this._onMouseUpBind = this.onMouseUp.bind(this);
this._onMouseWheelBind = this.onMouseWheel.bind(this);
this._onContextMenuBind = this.onContextMenu.bind(this);
if (this._game.deviceTargetOption === Kiwi.TARGET_BROWSER) {
this._domElement.addEventListener('mousedown', this._onMouseDownBind, true);
this._domElement.addEventListener('mousemove', this._onMouseMoveBind, true);
this._domElement.addEventListener('mouseup', this._onMouseUpBind, true);
this._domElement.addEventListener('mousewheel', this._onMouseWheelBind, true);
this._domElement.addEventListener('DOMMouseScroll', this._onMouseWheelBind, true);
this._domElement.addEventListener('contextmenu', this._onContextMenuBind, true);
} else if (this._game.deviceTargetOption === Kiwi.TARGET_COCOON) {
this._game.stage.canvas.addEventListener('mousedown', this._onMouseDownBind, true);
this._game.stage.canvas.addEventListener('mousemove', this._onMouseMoveBind, true);
this._game.stage.canvas.addEventListener('mouseup', this._onMouseUpBind, true);
this._game.stage.canvas.addEventListener('mousewheel', this._onMouseWheelBind, true);
this._game.stage.canvas.addEventListener('DOMMouseScroll', this._onMouseWheelBind, true);
}
}
/**
* Stops the mouse event listeners from working. Useful if you no longer want the mouse to 'work'/be listened to.
* @method stop
* @public
*/
public stop() {
if (this._game.deviceTargetOption === Kiwi.TARGET_BROWSER) {
this._domElement.removeEventListener('mousedown', this._onMouseDownBind, true);
this._domElement.removeEventListener('mousemove', this._onMouseMoveBind, true);
this._domElement.removeEventListener('mouseup', this._onMouseUpBind, true);
this._domElement.removeEventListener('mousewheel', this._onMouseWheelBind, true);
this._domElement.removeEventListener('DOMMouseScroll', this._onMouseWheelBind, true);
this._domElement.removeEventListener('contextmenu', this._onContextMenuBind, true);
} else if (this._game.deviceTargetOption === Kiwi.TARGET_COCOON) {
this._game.stage.canvas.removeEventListener('mousedown', this._onMouseDownBind, true);
this._game.stage.canvas.removeEventListener('mousemove', this._onMouseMoveBind, true);
this._game.stage.canvas.removeEventListener('mouseup', this._onMouseUpBind, true);
this._game.stage.canvas.removeEventListener('mousewheel', this._onMouseWheelBind, true);
this._game.stage.canvas.removeEventListener('DOMMouseScroll', this._onMouseWheelBind, true);
}
delete this._onMouseDownBind;
delete this._onMouseMoveBind;
delete this._onMouseUpBind;
delete this._onMouseWheelBind;
delete this._onContextMenuBind;
}
/**
* Method that gets fired when the mouse is pressed on the stage.
* @method onMouseDown
* @param {MouseEvent} event.
* @private
*/
private onMouseDown(event: MouseEvent) {
this._cursor.start(event);
this.onDown.dispatch(this._cursor.x, this._cursor.y, this._cursor.timeDown, this._cursor.timeUp, this.duration, this._cursor);
}
/**
* Method that gets fired when the mouse moves anywhere on the stage.
* @method onMouseMove
* @param {MouseEvent} event.
* @private
*/
private onMouseMove(event: MouseEvent) {
event.preventDefault();
this._cursor.move(event);
}
/**
* Method that gets fired when the mouse is released on the stage.
* @method onMouseUp
* @param {MouseEvent} event.
* @private
*/
private onMouseUp(event: MouseEvent) {
this._cursor.stop(event);
this.onUp.dispatch(this._cursor.x, this._cursor.y, this._cursor.timeDown, this._cursor.timeUp, this.duration, this._cursor);
}
/**
* Method that gets fired when the mousewheel is moved.
* @method onMouseWheel
* @param {MouseEvent} event.
* @private
*/
private onMouseWheel(event: WheelEvent) {
this._cursor.wheel(event);
this.onWheel.dispatch(this._cursor.wheelDeltaX, this._cursor.wheelDeltaY, this._cursor);
}
/**
* Returns a boolean indicating if the mouse was 'justPressed' within a certain timeframe. The default timeframe is 200 milliseconds.
* @method justPressed
* @param [duration=200] {Number} The timeframe that it could have occured in.
* @return {boolean}
* @public
*/
public justPressed(duration: number = this._cursor.justPressedRate): boolean {
return this._cursor.justPressed(duration);
}
/**
* Returns a boolean indicating if the mouse was 'justReleased' within a certain timeframe. The default timeframe is 200 milliseconds.
* @method justReleased
* @param [duration=200] {Number} The timeframe that it could have occured in..
* @return {boolean}
* @public
*/
public justReleased(duration: number = this._cursor.justReleasedRate): boolean {
return this._cursor.justReleased(duration);
}
/**
* Runs the Reset method on the MouseCursor.
* @method reset
* @public
*/
public reset() {
this._cursor.reset();
}
/**
* Dispatches events when the context menu is fired.
*
* Functions fired from this Signal will have the a single argument
* being the event of the 'contextmenu' gives.
*
* @property onContext
* @type Kiwi.Signal
* @since 1.3.0
* @public
*/
public onContext: Kiwi.Signal;
/**
* Determines whether or not the context menu should appear
* when the user 'right clicks' on the stage.
*
* Only has an effect on games targetting browsers.
*
* @property preventContextMenu
* @type Boolean
* @default false
* @since 1.3.0
* @public
*/
public preventContextMenu: boolean = false;
/**
* Fired when the context menu event is fired.
* Used to prevent the context menu from appearing when the
* 'preventContextMenu' property is set to true.
*
* This event is currently only used when targetting browsers and will not fire for CocoonJS.
*
* @method onContextMenu
* @param event
* @since 1.3.0
* @private
*/
private onContextMenu(event) {
if (this.preventContextMenu) {
event.preventDefault();
}
this.onContext.dispatch(event);
}
/**
* The binding of the 'onMouseDown' method.
*
* @property _onMouseDownBind
* @type Function
* @since 1.3.0
* @private
*/
private _onMouseDownBind;
/**
* The binding of the 'onMouseMove' method.
*
* @property _onMouseMoveBind
* @type Function
* @since 1.3.0
* @private
*/
private _onMouseMoveBind;
/**
* The binding of the 'onMouseUp' method.
*
* @property _onMouseUpBind
* @type Function
* @since 1.3.0
* @private
*/
private _onMouseUpBind;
/**
* The binding of the 'onMouseWheel' method.
*
* @property onMouseWheel
* @type Function
* @since 1.3.0
* @private
*/
private _onMouseWheelBind;
/**
* The binding of the 'onContextMenu' method.
*
* @property _onContextMenuBind
* @type Function
* @since 1.3.0
* @private
*/
private _onContextMenuBind;
}
}
</pre>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>