/
CCScrollView.js
1679 lines (1452 loc) · 59 KB
/
CCScrollView.js
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
/****************************************************************************
Copyright (c) 2013-2016 Chukong Technologies Inc.
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
https://www.cocos.com/
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated engine source code (the "Software"), a limited,
worldwide, royalty-free, non-assignable, revocable and non-exclusive license
to use Cocos Creator solely to develop games on your target platforms. You shall
not use Cocos Creator software for developing other software or tools that's
used for developing games. You are not granted to publish, distribute,
sublicense, and/or sell copies of Cocos Creator.
The software or tools in this License Agreement are licensed, not sold.
Xiamen Yaji Software Co., Ltd. reserves all rights not expressly granted to you.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
****************************************************************************/
const NodeEvent = require('../CCNode').EventType;
const NUMBER_OF_GATHERED_TOUCHES_FOR_MOVE_SPEED = 5;
const OUT_OF_BOUNDARY_BREAKING_FACTOR = 0.05;
const EPSILON = 1e-4;
const MOVEMENT_FACTOR = 0.7;
let quintEaseOut = function(time) {
time -= 1;
return (time * time * time * time * time + 1);
};
let getTimeInMilliseconds = function() {
let currentTime = new Date();
return currentTime.getMilliseconds();
};
/**
* !#en Enum for ScrollView event type.
* !#zh 滚动视图事件类型
* @enum ScrollView.EventType
*/
const EventType = cc.Enum({
/**
* !#en The event emmitted when ScrollView scroll to the top boundary of inner container
* !#zh 滚动视图滚动到顶部边界事件
* @property {Number} SCROLL_TO_TOP
*/
SCROLL_TO_TOP : 0,
/**
* !#en The event emmitted when ScrollView scroll to the bottom boundary of inner container
* !#zh 滚动视图滚动到底部边界事件
* @property {Number} SCROLL_TO_BOTTOM
*/
SCROLL_TO_BOTTOM : 1,
/**
* !#en The event emmitted when ScrollView scroll to the left boundary of inner container
* !#zh 滚动视图滚动到左边界事件
* @property {Number} SCROLL_TO_LEFT
*/
SCROLL_TO_LEFT : 2,
/**
* !#en The event emmitted when ScrollView scroll to the right boundary of inner container
* !#zh 滚动视图滚动到右边界事件
* @property {Number} SCROLL_TO_RIGHT
*/
SCROLL_TO_RIGHT : 3,
/**
* !#en The event emmitted when ScrollView is scrolling
* !#zh 滚动视图正在滚动时发出的事件
* @property {Number} SCROLLING
*/
SCROLLING : 4,
/**
* !#en The event emmitted when ScrollView scroll to the top boundary of inner container and start bounce
* !#zh 滚动视图滚动到顶部边界并且开始回弹时发出的事件
* @property {Number} BOUNCE_TOP
*/
BOUNCE_TOP : 5,
/**
* !#en The event emmitted when ScrollView scroll to the bottom boundary of inner container and start bounce
* !#zh 滚动视图滚动到底部边界并且开始回弹时发出的事件
* @property {Number} BOUNCE_BOTTOM
*/
BOUNCE_BOTTOM : 6,
/**
* !#en The event emmitted when ScrollView scroll to the left boundary of inner container and start bounce
* !#zh 滚动视图滚动到左边界并且开始回弹时发出的事件
* @property {Number} BOUNCE_LEFT
*/
BOUNCE_LEFT : 7,
/**
* !#en The event emmitted when ScrollView scroll to the right boundary of inner container and start bounce
* !#zh 滚动视图滚动到右边界并且开始回弹时发出的事件
* @property {Number} BOUNCE_RIGHT
*/
BOUNCE_RIGHT : 8,
/**
* !#en The event emmitted when ScrollView auto scroll ended
* !#zh 滚动视图滚动结束的时候发出的事件
* @property {Number} SCROLL_ENDED
*/
SCROLL_ENDED : 9,
/**
* !#en The event emmitted when user release the touch
* !#zh 当用户松手的时候会发出一个事件
* @property {Number} TOUCH_UP
*/
TOUCH_UP : 10,
/**
* !#en The event emmitted when ScrollView auto scroll ended with a threshold
* !#zh 滚动视图自动滚动快要结束的时候发出的事件
* @property {Number} AUTOSCROLL_ENDED_WITH_THRESHOLD
*/
AUTOSCROLL_ENDED_WITH_THRESHOLD: 11,
/**
* !#en The event emmitted when ScrollView scroll began
* !#zh 滚动视图滚动开始时发出的事件
* @property {Number} SCROLL_BEGAN
*/
SCROLL_BEGAN: 12
});
const eventMap = {
'scroll-to-top' : EventType.SCROLL_TO_TOP,
'scroll-to-bottom': EventType.SCROLL_TO_BOTTOM,
'scroll-to-left' : EventType.SCROLL_TO_LEFT,
'scroll-to-right' : EventType.SCROLL_TO_RIGHT,
'scrolling' : EventType.SCROLLING,
'bounce-bottom' : EventType.BOUNCE_BOTTOM,
'bounce-left' : EventType.BOUNCE_LEFT,
'bounce-right' : EventType.BOUNCE_RIGHT,
'bounce-top' : EventType.BOUNCE_TOP,
'scroll-ended': EventType.SCROLL_ENDED,
'touch-up' : EventType.TOUCH_UP,
'scroll-ended-with-threshold' : EventType.AUTOSCROLL_ENDED_WITH_THRESHOLD,
'scroll-began': EventType.SCROLL_BEGAN
};
/**
* !#en
* Layout container for a view hierarchy that can be scrolled by the user,
* allowing it to be larger than the physical display.
*
* !#zh
* 滚动视图组件
* @class ScrollView
* @extends Component
*/
let ScrollView = cc.Class({
name: 'cc.ScrollView',
extends: require('./CCViewGroup'),
editor: CC_EDITOR && {
menu: 'i18n:MAIN_MENU.component.ui/ScrollView',
help: 'i18n:COMPONENT.help_url.scrollview',
executeInEditMode: false,
},
ctor () {
this._topBoundary = 0;
this._bottomBoundary = 0;
this._leftBoundary = 0;
this._rightBoundary = 0;
this._touchMoveDisplacements = [];
this._touchMoveTimeDeltas = [];
this._touchMovePreviousTimestamp = 0;
this._touchMoved = false;
this._autoScrolling = false;
this._autoScrollAttenuate = false;
this._autoScrollStartPosition = cc.v2(0, 0);
this._autoScrollTargetDelta = cc.v2(0, 0);
this._autoScrollTotalTime = 0;
this._autoScrollAccumulatedTime = 0;
this._autoScrollCurrentlyOutOfBoundary = false;
this._autoScrollBraking = false;
this._autoScrollBrakingStartPosition = cc.v2(0, 0);
this._outOfBoundaryAmount = cc.v2(0, 0);
this._outOfBoundaryAmountDirty = true;
this._stopMouseWheel = false;
this._mouseWheelEventElapsedTime = 0.0;
this._isScrollEndedWithThresholdEventFired = false;
//use bit wise operations to indicate the direction
this._scrollEventEmitMask = 0;
this._isBouncing = false;
this._scrolling = false;
},
properties: {
/**
* !#en This is a reference to the UI element to be scrolled.
* !#zh 可滚动展示内容的节点。
* @property {Node} content
*/
content: {
default: undefined,
type: cc.Node,
tooltip: CC_DEV && 'i18n:COMPONENT.scrollview.content',
formerlySerializedAs: 'content',
notify (oldValue) {
this._calculateBoundary();
}
},
/**
* !#en Enable horizontal scroll.
* !#zh 是否开启水平滚动。
* @property {Boolean} horizontal
*/
horizontal: {
default: true,
animatable: false,
tooltip: CC_DEV && 'i18n:COMPONENT.scrollview.horizontal',
},
/**
* !#en Enable vertical scroll.
* !#zh 是否开启垂直滚动。
* @property {Boolean} vertical
*/
vertical: {
default: true,
animatable: false,
tooltip: CC_DEV && 'i18n:COMPONENT.scrollview.vertical',
},
/**
* !#en When inertia is set, the content will continue to move when touch ended.
* !#zh 是否开启滚动惯性。
* @property {Boolean} inertia
*/
inertia: {
default: true,
tooltip: CC_DEV && 'i18n:COMPONENT.scrollview.inertia',
},
/**
* !#en
* It determines how quickly the content stop moving. A value of 1 will stop the movement immediately.
* A value of 0 will never stop the movement until it reaches to the boundary of scrollview.
* !#zh
* 开启惯性后，在用户停止触摸后滚动多快停止，0表示永不停止，1表示立刻停止。
* @property {Number} brake
*/
brake: {
default: 0.5,
type: 'Float',
range: [0, 1, 0.1],
tooltip: CC_DEV && 'i18n:COMPONENT.scrollview.brake',
},
/**
* !#en When elastic is set, the content will be bounce back when move out of boundary.
* !#zh 是否允许滚动内容超过边界，并在停止触摸后回弹。
* @property {Boolean} elastic
*/
elastic: {
default: true,
animatable: false,
tooltip: CC_DEV && 'i18n:COMPONENT.scrollview.elastic',
},
/**
* !#en The elapse time of bouncing back. A value of 0 will bounce back immediately.
* !#zh 回弹持续的时间，0 表示将立即反弹。
* @property {Number} bounceDuration
*/
bounceDuration: {
default: 1,
range: [0, 10],
tooltip: CC_DEV && 'i18n:COMPONENT.scrollview.bounceDuration',
},
/**
* !#en The horizontal scrollbar reference.
* !#zh 水平滚动的 ScrollBar。
* @property {Scrollbar} horizontalScrollBar
*/
horizontalScrollBar: {
default: undefined,
type: cc.Scrollbar,
tooltip: CC_DEV && 'i18n:COMPONENT.scrollview.horizontal_bar',
notify () {
if (this.horizontalScrollBar) {
this.horizontalScrollBar.setTargetScrollView(this);
this._updateScrollBar(0);
}
},
animatable: false
},
/**
* !#en The vertical scrollbar reference.
* !#zh 垂直滚动的 ScrollBar。
* @property {Scrollbar} verticalScrollBar
*/
verticalScrollBar: {
default: undefined,
type: cc.Scrollbar,
tooltip: CC_DEV && 'i18n:COMPONENT.scrollview.vertical_bar',
notify () {
if (this.verticalScrollBar) {
this.verticalScrollBar.setTargetScrollView(this);
this._updateScrollBar(0);
}
},
animatable: false
},
/**
* !#en Scrollview events callback
* !#zh 滚动视图的事件回调函数
* @property {Component.EventHandler[]} scrollEvents
*/
scrollEvents: {
default: [],
type: cc.Component.EventHandler,
tooltip: CC_DEV && 'i18n:COMPONENT.scrollview.scrollEvents'
},
/**
* !#en If cancelInnerEvents is set to true, the scroll behavior will cancel touch events on inner content nodes
* It's set to true by default.
* !#zh 如果这个属性被设置为 true，那么滚动行为会取消子节点上注册的触摸事件，默认被设置为 true。
* 注意，子节点上的 touchstart 事件仍然会触发，触点移动距离非常短的情况下 touchmove 和 touchend 也不会受影响。
* @property {Boolean} cancelInnerEvents
*/
cancelInnerEvents: {
default: true,
animatable: false,
tooltip: CC_DEV && 'i18n:COMPONENT.scrollview.cancelInnerEvents'
},
// private object
_view: {
get: function () {
if (this.content) {
return this.content.parent;
}
}
}
},
statics: {
EventType: EventType,
},
/**
* !#en Scroll the content to the bottom boundary of ScrollView.
* !#zh 视图内容将在规定时间内滚动到视图底部。
* @method scrollToBottom
* @param {Number} [timeInSecond=0] - Scroll time in second, if you don't pass timeInSecond,
* the content will jump to the bottom boundary immediately.
* @param {Boolean} [attenuated=true] - Whether the scroll acceleration attenuated, default is true.
* @example
* // Scroll to the bottom of the view.
* scrollView.scrollToBottom(0.1);
*/
scrollToBottom (timeInSecond, attenuated) {
let moveDelta = this._calculateMovePercentDelta({
anchor: cc.v2(0, 0),
applyToHorizontal: false,
applyToVertical: true,
});
if (timeInSecond) {
this._startAutoScroll(moveDelta, timeInSecond, attenuated !== false);
} else {
this._moveContent(moveDelta, true);
}
},
/**
* !#en Scroll the content to the top boundary of ScrollView.
* !#zh 视图内容将在规定时间内滚动到视图顶部。
* @method scrollToTop
* @param {Number} [timeInSecond=0] - Scroll time in second, if you don't pass timeInSecond,
* the content will jump to the top boundary immediately.
* @param {Boolean} [attenuated=true] - Whether the scroll acceleration attenuated, default is true.
* @example
* // Scroll to the top of the view.
* scrollView.scrollToTop(0.1);
*/
scrollToTop (timeInSecond, attenuated) {
let moveDelta = this._calculateMovePercentDelta({
anchor: cc.v2(0, 1),
applyToHorizontal: false,
applyToVertical: true,
});
if (timeInSecond) {
this._startAutoScroll(moveDelta, timeInSecond, attenuated !== false);
} else {
this._moveContent(moveDelta);
}
},
/**
* !#en Scroll the content to the left boundary of ScrollView.
* !#zh 视图内容将在规定时间内滚动到视图左边。
* @method scrollToLeft
* @param {Number} [timeInSecond=0] - Scroll time in second, if you don't pass timeInSecond,
* the content will jump to the left boundary immediately.
* @param {Boolean} [attenuated=true] - Whether the scroll acceleration attenuated, default is true.
* @example
* // Scroll to the left of the view.
* scrollView.scrollToLeft(0.1);
*/
scrollToLeft (timeInSecond, attenuated) {
let moveDelta = this._calculateMovePercentDelta({
anchor: cc.v2(0, 0),
applyToHorizontal: true,
applyToVertical: false,
});
if (timeInSecond) {
this._startAutoScroll(moveDelta, timeInSecond, attenuated !== false);
} else {
this._moveContent(moveDelta);
}
},
/**
* !#en Scroll the content to the right boundary of ScrollView.
* !#zh 视图内容将在规定时间内滚动到视图右边。
* @method scrollToRight
* @param {Number} [timeInSecond=0] - Scroll time in second, if you don't pass timeInSecond,
* the content will jump to the right boundary immediately.
* @param {Boolean} [attenuated=true] - Whether the scroll acceleration attenuated, default is true.
* @example
* // Scroll to the right of the view.
* scrollView.scrollToRight(0.1);
*/
scrollToRight (timeInSecond, attenuated) {
let moveDelta = this._calculateMovePercentDelta({
anchor: cc.v2(1, 0),
applyToHorizontal: true,
applyToVertical: false,
});
if (timeInSecond) {
this._startAutoScroll(moveDelta, timeInSecond, attenuated !== false);
} else {
this._moveContent(moveDelta);
}
},
/**
* !#en Scroll the content to the top left boundary of ScrollView.
* !#zh 视图内容将在规定时间内滚动到视图左上角。
* @method scrollToTopLeft
* @param {Number} [timeInSecond=0] - Scroll time in second, if you don't pass timeInSecond,
* the content will jump to the top left boundary immediately.
* @param {Boolean} [attenuated=true] - Whether the scroll acceleration attenuated, default is true.
* @example
* // Scroll to the upper left corner of the view.
* scrollView.scrollToTopLeft(0.1);
*/
scrollToTopLeft (timeInSecond, attenuated) {
let moveDelta = this._calculateMovePercentDelta({
anchor: cc.v2(0, 1),
applyToHorizontal: true,
applyToVertical: true,
});
if (timeInSecond) {
this._startAutoScroll(moveDelta, timeInSecond, attenuated !== false);
} else {
this._moveContent(moveDelta);
}
},
/**
* !#en Scroll the content to the top right boundary of ScrollView.
* !#zh 视图内容将在规定时间内滚动到视图右上角。
* @method scrollToTopRight
* @param {Number} [timeInSecond=0] - Scroll time in second, if you don't pass timeInSecond,
* the content will jump to the top right boundary immediately.
* @param {Boolean} [attenuated=true] - Whether the scroll acceleration attenuated, default is true.
* @example
* // Scroll to the top right corner of the view.
* scrollView.scrollToTopRight(0.1);
*/
scrollToTopRight (timeInSecond, attenuated) {
let moveDelta = this._calculateMovePercentDelta({
anchor: cc.v2(1, 1),
applyToHorizontal: true,
applyToVertical: true,
});
if (timeInSecond) {
this._startAutoScroll(moveDelta, timeInSecond, attenuated !== false);
} else {
this._moveContent(moveDelta);
}
},
/**
* !#en Scroll the content to the bottom left boundary of ScrollView.
* !#zh 视图内容将在规定时间内滚动到视图左下角。
* @method scrollToBottomLeft
* @param {Number} [timeInSecond=0] - Scroll time in second, if you don't pass timeInSecond,
* the content will jump to the bottom left boundary immediately.
* @param {Boolean} [attenuated=true] - Whether the scroll acceleration attenuated, default is true.
* @example
* // Scroll to the lower left corner of the view.
* scrollView.scrollToBottomLeft(0.1);
*/
scrollToBottomLeft (timeInSecond, attenuated) {
let moveDelta = this._calculateMovePercentDelta({
anchor: cc.v2(0, 0),
applyToHorizontal: true,
applyToVertical: true,
});
if (timeInSecond) {
this._startAutoScroll(moveDelta, timeInSecond, attenuated !== false);
} else {
this._moveContent(moveDelta);
}
},
/**
* !#en Scroll the content to the bottom right boundary of ScrollView.
* !#zh 视图内容将在规定时间内滚动到视图右下角。
* @method scrollToBottomRight
* @param {Number} [timeInSecond=0] - Scroll time in second, if you don't pass timeInSecond,
* the content will jump to the bottom right boundary immediately.
* @param {Boolean} [attenuated=true] - Whether the scroll acceleration attenuated, default is true.
* @example
* // Scroll to the lower right corner of the view.
* scrollView.scrollToBottomRight(0.1);
*/
scrollToBottomRight (timeInSecond, attenuated) {
let moveDelta = this._calculateMovePercentDelta({
anchor: cc.v2(1, 0),
applyToHorizontal: true,
applyToVertical: true,
});
if (timeInSecond) {
this._startAutoScroll(moveDelta, timeInSecond, attenuated !== false);
} else {
this._moveContent(moveDelta);
}
},
/**
* !#en Scroll with an offset related to the ScrollView's top left origin, if timeInSecond is omitted, then it will jump to the
* specific offset immediately.
* !#zh 视图内容在规定时间内将滚动到 ScrollView 相对左上角原点的偏移位置, 如果 timeInSecond参数不传，则立即滚动到指定偏移位置。
* @method scrollToOffset
* @param {Vec2} offset - A Vec2, the value of which each axis between 0 and maxScrollOffset
* @param {Number} [timeInSecond=0] - Scroll time in second, if you don't pass timeInSecond,
* the content will jump to the specific offset of ScrollView immediately.
* @param {Boolean} [attenuated=true] - Whether the scroll acceleration attenuated, default is true.
* @example
* // Scroll to middle position in 0.1 second in x-axis
* let maxScrollOffset = this.getMaxScrollOffset();
* scrollView.scrollToOffset(cc.v2(maxScrollOffset.x / 2, 0), 0.1);
*/
scrollToOffset (offset, timeInSecond, attenuated) {
let maxScrollOffset = this.getMaxScrollOffset();
let anchor = cc.v2(0, 0);
//if maxScrollOffset is 0, then always align the content's top left origin to the top left corner of its parent
if (maxScrollOffset.x === 0) {
anchor.x = 0;
} else {
anchor.x = offset.x / maxScrollOffset.x;
}
if (maxScrollOffset.y === 0) {
anchor.y = 1;
} else {
anchor.y = (maxScrollOffset.y - offset.y ) / maxScrollOffset.y;
}
this.scrollTo(anchor, timeInSecond, attenuated);
},
/**
* !#en Get the positive offset value corresponds to the content's top left boundary.
* !#zh 获取滚动视图相对于左上角原点的当前滚动偏移
* @method getScrollOffset
* @return {Vec2} - A Vec2 value indicate the current scroll offset.
*/
getScrollOffset () {
let topDelta = this._getContentTopBoundary() - this._topBoundary;
let leftDeta = this._getContentLeftBoundary() - this._leftBoundary;
return cc.v2(leftDeta, topDelta);
},
/**
* !#en Get the maximize available scroll offset
* !#zh 获取滚动视图最大可以滚动的偏移量
* @method getMaxScrollOffset
* @return {Vec2} - A Vec2 value indicate the maximize scroll offset in x and y axis.
*/
getMaxScrollOffset () {
let viewSize = this._view.getContentSize();
let contentSize = this.content.getContentSize();
let horizontalMaximizeOffset = contentSize.width - viewSize.width;
let verticalMaximizeOffset = contentSize.height - viewSize.height;
horizontalMaximizeOffset = horizontalMaximizeOffset >= 0 ? horizontalMaximizeOffset : 0;
verticalMaximizeOffset = verticalMaximizeOffset >=0 ? verticalMaximizeOffset : 0;
return cc.v2(horizontalMaximizeOffset, verticalMaximizeOffset);
},
/**
* !#en Scroll the content to the horizontal percent position of ScrollView.
* !#zh 视图内容在规定时间内将滚动到 ScrollView 水平方向的百分比位置上。
* @method scrollToPercentHorizontal
* @param {Number} percent - A value between 0 and 1.
* @param {Number} [timeInSecond=0] - Scroll time in second, if you don't pass timeInSecond,
* the content will jump to the horizontal percent position of ScrollView immediately.
* @param {Boolean} [attenuated=true] - Whether the scroll acceleration attenuated, default is true.
* @example
* // Scroll to middle position.
* scrollView.scrollToBottomRight(0.5, 0.1);
*/
scrollToPercentHorizontal (percent, timeInSecond, attenuated) {
let moveDelta = this._calculateMovePercentDelta({
anchor: cc.v2(percent, 0),
applyToHorizontal: true,
applyToVertical: false,
});
if (timeInSecond) {
this._startAutoScroll(moveDelta, timeInSecond, attenuated !== false);
} else {
this._moveContent(moveDelta);
}
},
/**
* !#en Scroll the content to the percent position of ScrollView in any direction.
* !#zh 视图内容在规定时间内进行垂直方向和水平方向的滚动，并且滚动到指定百分比位置上。
* @method scrollTo
* @param {Vec2} anchor - A point which will be clamp between cc.v2(0,0) and cc.v2(1,1).
* @param {Number} [timeInSecond=0] - Scroll time in second, if you don't pass timeInSecond,
* the content will jump to the percent position of ScrollView immediately.
* @param {Boolean} [attenuated=true] - Whether the scroll acceleration attenuated, default is true.
* @example
* // Vertical scroll to the bottom of the view.
* scrollView.scrollTo(cc.v2(0, 1), 0.1);
*
* // Horizontal scroll to view right.
* scrollView.scrollTo(cc.v2(1, 0), 0.1);
*/
scrollTo (anchor, timeInSecond, attenuated) {
let moveDelta = this._calculateMovePercentDelta({
anchor: cc.v2(anchor),
applyToHorizontal: true,
applyToVertical: true,
});
if (timeInSecond) {
this._startAutoScroll(moveDelta, timeInSecond, attenuated !== false);
} else {
this._moveContent(moveDelta);
}
},
/**
* !#en Scroll the content to the vertical percent position of ScrollView.
* !#zh 视图内容在规定时间内滚动到 ScrollView 垂直方向的百分比位置上。
* @method scrollToPercentVertical
* @param {Number} percent - A value between 0 and 1.
* @param {Number} [timeInSecond=0] - Scroll time in second, if you don't pass timeInSecond,
* the content will jump to the vertical percent position of ScrollView immediately.
* @param {Boolean} [attenuated=true] - Whether the scroll acceleration attenuated, default is true.
* // Scroll to middle position.
* scrollView.scrollToPercentVertical(0.5, 0.1);
*/
scrollToPercentVertical (percent, timeInSecond, attenuated) {
let moveDelta = this._calculateMovePercentDelta({
anchor: cc.v2(0, percent),
applyToHorizontal: false,
applyToVertical: true,
});
if (timeInSecond) {
this._startAutoScroll(moveDelta, timeInSecond, attenuated !== false);
} else {
this._moveContent(moveDelta);
}
},
/**
* !#en Stop auto scroll immediately
* !#zh 停止自动滚动, 调用此 API 可以让 Scrollview 立即停止滚动
* @method stopAutoScroll
*/
stopAutoScroll () {
this._autoScrolling = false;
this._autoScrollAccumulatedTime = this._autoScrollTotalTime;
},
/**
* !#en Modify the content position.
* !#zh 设置当前视图内容的坐标点。
* @method setContentPosition
* @param {Vec2} position - The position in content's parent space.
*/
setContentPosition (position) {
if (position.fuzzyEquals(this.getContentPosition(), EPSILON)) {
return;
}
this.content.setPosition(position);
this._outOfBoundaryAmountDirty = true;
},
/**
* !#en Query the content's position in its parent space.
* !#zh 获取当前视图内容的坐标点。
* @method getContentPosition
* @returns {Position} - The content's position in its parent space.
*/
getContentPosition () {
return this.content.getPosition();
},
/**
* !#en Query whether the user is currently dragging the ScrollView to scroll it
* !#zh 用户是否在拖拽当前滚动视图
* @method isScrolling
* @returns {Boolean} - Whether the user is currently dragging the ScrollView to scroll it
*/
isScrolling () {
return this._scrolling;
},
/**
* !#en Query whether the ScrollView is currently scrolling because of a bounceback or inertia slowdown.
* !#zh 当前滚动视图是否在惯性滚动
* @method isAutoScrolling
* @returns {Boolean} - Whether the ScrollView is currently scrolling because of a bounceback or inertia slowdown.
*/
isAutoScrolling () {
return this._autoScrolling;
},
//private methods
_registerEvent () {
this.node.on(cc.Node.EventType.TOUCH_START, this._onTouchBegan, this, true);
this.node.on(cc.Node.EventType.TOUCH_MOVE, this._onTouchMoved, this, true);
this.node.on(cc.Node.EventType.TOUCH_END, this._onTouchEnded, this, true);
this.node.on(cc.Node.EventType.TOUCH_CANCEL, this._onTouchCancelled, this, true);
this.node.on(cc.Node.EventType.MOUSE_WHEEL, this._onMouseWheel, this, true);
},
_unregisterEvent () {
this.node.off(cc.Node.EventType.TOUCH_START, this._onTouchBegan, this, true);
this.node.off(cc.Node.EventType.TOUCH_MOVE, this._onTouchMoved, this, true);
this.node.off(cc.Node.EventType.TOUCH_END, this._onTouchEnded, this, true);
this.node.off(cc.Node.EventType.TOUCH_CANCEL, this._onTouchCancelled, this, true);
this.node.off(cc.Node.EventType.MOUSE_WHEEL, this._onMouseWheel, this, true);
},
_onMouseWheel (event, captureListeners) {
if (!this.enabledInHierarchy) return;
if (this._hasNestedViewGroup(event, captureListeners)) return;
let deltaMove = cc.v2(0, 0);
let wheelPrecision = -0.1;
if(CC_JSB || CC_RUNTIME) {
wheelPrecision = -7;
}
if(this.vertical) {
deltaMove = cc.v2(0, event.getScrollY() * wheelPrecision);
}
else if(this.horizontal) {
deltaMove = cc.v2(event.getScrollY() * wheelPrecision, 0);
}
this._mouseWheelEventElapsedTime = 0;
this._processDeltaMove(deltaMove);
if(!this._stopMouseWheel) {
this._handlePressLogic();
this.schedule(this._checkMouseWheel, 1.0 / 60);
this._stopMouseWheel = true;
}
this._stopPropagationIfTargetIsMe(event);
},
_checkMouseWheel (dt) {
let currentOutOfBoundary = this._getHowMuchOutOfBoundary();
let maxElapsedTime = 0.1;
if (!currentOutOfBoundary.fuzzyEquals(cc.v2(0, 0), EPSILON)) {
this._processInertiaScroll();
this.unschedule(this._checkMouseWheel);
this._stopMouseWheel = false;
return;
}
this._mouseWheelEventElapsedTime += dt;
// mouse wheel event is ended
if (this._mouseWheelEventElapsedTime > maxElapsedTime) {
this._onScrollBarTouchEnded();
this.unschedule(this._checkMouseWheel);
this._stopMouseWheel = false;
}
},
_calculateMovePercentDelta (options) {
let anchor = options.anchor;
let applyToHorizontal = options.applyToHorizontal;
let applyToVertical = options.applyToVertical;
this._calculateBoundary();
anchor = anchor.clampf(cc.v2(0, 0), cc.v2(1, 1));
let scrollSize = this._view.getContentSize();
let contentSize = this.content.getContentSize();
let bottomDeta = this._getContentBottomBoundary() - this._bottomBoundary;
bottomDeta = -bottomDeta;
let leftDeta = this._getContentLeftBoundary() - this._leftBoundary;
leftDeta = -leftDeta;
let moveDelta = cc.v2(0, 0);
let totalScrollDelta = 0;
if (applyToHorizontal) {
totalScrollDelta = contentSize.width - scrollSize.width;
moveDelta.x = leftDeta - totalScrollDelta * anchor.x;
}
if (applyToVertical) {
totalScrollDelta = contentSize.height - scrollSize.height;
moveDelta.y = bottomDeta - totalScrollDelta * anchor.y;
}
return moveDelta;
},
_moveContentToTopLeft (scrollViewSize) {
let contentSize = this.content.getContentSize();
let bottomDeta = this._getContentBottomBoundary() - this._bottomBoundary;
bottomDeta = -bottomDeta;
let moveDelta = cc.v2(0, 0);
let totalScrollDelta = 0;
let leftDeta = this._getContentLeftBoundary() - this._leftBoundary;
leftDeta = -leftDeta;
if (contentSize.height < scrollViewSize.height) {
totalScrollDelta = contentSize.height - scrollViewSize.height;
moveDelta.y = bottomDeta - totalScrollDelta;
if (this.verticalScrollBar) {
this.verticalScrollBar.hide();
}
} else {
if (this.verticalScrollBar) {
this.verticalScrollBar.show();
}
}
if (contentSize.width < scrollViewSize.width) {
totalScrollDelta = contentSize.width - scrollViewSize.width;
moveDelta.x = leftDeta;
if (this.horizontalScrollBar) {
this.horizontalScrollBar.hide();
}
} else {
if (this.horizontalScrollBar) {
this.horizontalScrollBar.show();
}
}
this._moveContent(moveDelta);
this._adjustContentOutOfBoundary();
},
_calculateBoundary () {
if (this.content) {
//refresh content size
let layout = this.content.getComponent(cc.Layout);
if(layout && layout.enabledInHierarchy) {
layout.updateLayout();
}
let viewSize = this._view.getContentSize();
let anchorX = viewSize.width * this._view.anchorX;
let anchorY = viewSize.height * this._view.anchorY;
this._leftBoundary = -anchorX;
this._bottomBoundary = -anchorY;
this._rightBoundary = this._leftBoundary + viewSize.width;
this._topBoundary = this._bottomBoundary + viewSize.height;
this._moveContentToTopLeft(viewSize);
}
},
//this is for nested scrollview
_hasNestedViewGroup (event, captureListeners) {
if (event.eventPhase !== cc.Event.CAPTURING_PHASE) return;
if (captureListeners) {
//captureListeners are arranged from child to parent
for (let i = 0; i < captureListeners.length; ++i){
let item = captureListeners[i];
if (this.node === item) {
if (event.target.getComponent(cc.ViewGroup)) {
return true;
}
return false;
}
if(item.getComponent(cc.ViewGroup)) {
return true;
}
}
}
return false;
},
//This is for Scrollview as children of a Button
_stopPropagationIfTargetIsMe (event) {
if (event.eventPhase === cc.Event.AT_TARGET && event.target === this.node) {
event.stopPropagation();
}
},
// touch event handler
_onTouchBegan (event, captureListeners) {
if (!this.enabledInHierarchy) return;
if (this._hasNestedViewGroup(event, captureListeners)) return;
let touch = event.touch;
if (this.content) {
this._handlePressLogic(touch);
}
this._touchMoved = false;
this._stopPropagationIfTargetIsMe(event);
},
_onTouchMoved (event, captureListeners) {
if (!this.enabledInHierarchy) return;
if (this._hasNestedViewGroup(event, captureListeners)) return;
let touch = event.touch;
if (this.content) {
this._handleMoveLogic(touch);
}
// Do not prevent touch events in inner nodes
if (!this.cancelInnerEvents) {
return;
}
let deltaMove = touch.getLocation().sub(touch.getStartLocation());
//FIXME: touch move delta should be calculated by DPI.
if (deltaMove.mag() > 7) {
if (!this._touchMoved && event.target !== this.node) {
// Simulate touch cancel for target node
let cancelEvent = new cc.Event.EventTouch(event.getTouches(), event.bubbles);
cancelEvent.type = cc.Node.EventType.TOUCH_CANCEL;
cancelEvent.touch = event.touch;
cancelEvent.simulate = true;
event.target.dispatchEvent(cancelEvent);
this._touchMoved = true;
}
}
this._stopPropagationIfTargetIsMe(event);
},
_onTouchEnded (event, captureListeners) {
if (!this.enabledInHierarchy) return;
if (this._hasNestedViewGroup(event, captureListeners)) return;
this._dispatchEvent('touch-up');
let touch = event.touch;
if (this.content) {
this._handleReleaseLogic(touch);
}