/
label-component.ts
849 lines (747 loc) · 21 KB
/
label-component.ts
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
/*
Copyright (c) 2013-2016 Chukong Technologies Inc.
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
http://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.
*/
/**
* @category ui
*/
import { BitmapFont, Font, ImageAsset, SpriteFrame, Texture2D } from '../../core/assets';
import { ccclass, help, executionOrder, menu, property } from '../../core/data/class-decorator';
import { ccenum } from '../../core/value-types/enum';
import { UI } from '../../core/renderer/ui/ui';
import { FontAtlas } from '../assembler/label/bmfontUtils';
import { CanvasPool, ISharedLabelData } from '../assembler/label/font-utils';
import { LetterRenderTexture } from '../assembler/label/letter-font';
import { UIRenderComponent } from '../../core/components/ui-base/ui-render-component';
import { warnID } from '../../core/platform/debug';
import { sys } from '../../core/platform/sys';
import { EDITOR } from 'internal:constants';
/**
* @en Enum for horizontal text alignment.
*
* @zh 文本横向对齐类型。
*/
export enum HorizontalTextAlignment {
/**
* @en Alignment left for text.
*
* @zh 左对齐。
*/
LEFT = 0,
/**
* @en Alignment center for text.
*
* @zh 中心对齐。
*/
CENTER = 1,
/**
* @en Alignment right for text.
*
* @zh 右对齐。
*/
RIGHT = 2,
}
ccenum(HorizontalTextAlignment);
/**
* @en Enum for vertical text alignment.
*
* @zh 文本垂直对齐类型。
*/
export enum VerticalTextAlignment {
/**
* @en Alignment top for text.
*
* @zh 上对齐。
*/
TOP = 0,
/**
* @en Alignment center for text.
*
* @zh 中心对齐。
*/
CENTER = 1,
/**
* @en Alignment bottom for text.
*
* @zh 下对齐。
*/
BOTTOM = 2,
}
ccenum(VerticalTextAlignment);
/**
* @en Enum for Overflow.
*
* @zh 文本超载类型。
*/
export enum Overflow {
/**
* @en None.
*
* @zh 不做任何限制。
*/
NONE = 0,
/**
* @en In CLAMP mode, when label content goes out of the bounding box, it will be clipped.
*
* @zh CLAMP 模式中,当文本内容超出边界框时,多余的会被截断。
*/
CLAMP = 1,
/**
* @en In SHRINK mode, the font size will change dynamically to adapt the content size.
* This mode may takes up more CPU resources when the label is refreshed.
*
* @zh SHRINK 模式,字体大小会动态变化,以适应内容大小。
*/
SHRINK = 2,
/**
* @en In RESIZE_HEIGHT mode, you can only change the width of label and the height is changed automatically.
*
* @zh 在 RESIZE_HEIGHT 模式下,只能更改文本的宽度,高度是自动改变的。
*/
RESIZE_HEIGHT = 3,
}
ccenum(Overflow);
/**
* @en Enum for cache mode.
*
* @zh 文本图集缓存类型。
*/
enum CacheMode {
/**
* @en Do not do any caching.
*
* @zh 不做任何缓存。
*/
NONE = 0,
/**
* @en In BITMAP mode, cache the label as a static image and add it to the dynamic atlas for batch rendering,
* and can batching with Sprites using broken images.
*
* @zh BITMAP 模式,将 label 缓存成静态图像并加入到动态图集,以便进行批次合并,可与使用碎图的 Sprite 进行合批。
* (注:动态图集在 Chrome 以及微信小游戏暂时关闭,该功能无效)。
*/
BITMAP = 1,
/**
* @en In CHAR mode, split text into characters and cache characters into a dynamic atlas which the size of 1024 * 1024.
*
* @zh CHAR 模式,将文本拆分为字符,并将字符缓存到一张单独的大小为 1024 * 1024 的图集中进行重复使用,不再使用动态图集。
* (注:当图集满时将不再进行缓存,暂时不支持 SHRINK 自适应文本尺寸(后续完善))。
*/
CHAR = 2,
}
ccenum(CacheMode);
/**
* @zh
* Type 类型。
*/
/**
* @zh
* TTF字体。
*/
/**
* @zh
* 位图字体。
*/
/**
* @zh
* 系统字体。
*/
/**
* @en
* The Label Component.
*
* @zh
* 文字标签组件。
*/
@ccclass('cc.LabelComponent')
@help('i18n:cc.LabelComponent')
@executionOrder(110)
@menu('UI/Render/Label')
export class LabelComponent extends UIRenderComponent {
/**
* @en
* Content string of label.
*
* @zh
* 标签显示的文本内容。
*/
@property({
displayOrder: 4,
multiline: true,
tooltip:'Label 显示的文本内容字符串',
})
get string () {
return this._string;
}
set string (value) {
value = value.toString();
if (this._string === value) {
return;
}
this._string = value;
this.updateRenderData();
}
/**
* @en
* Horizontal Alignment of label.
*
* @zh
* 文本内容的水平对齐方式。
*/
@property({
type: HorizontalTextAlignment,
displayOrder: 5,
tooltip:'文字水平对齐模式',
})
get horizontalAlign () {
return this._horizontalAlign;
}
set horizontalAlign (value) {
if (this._horizontalAlign === value) {
return;
}
this._horizontalAlign = value;
this.updateRenderData();
}
/**
* @en
* Vertical Alignment of label.
*
* @zh
* 文本内容的垂直对齐方式。
*/
@property({
type: VerticalTextAlignment,
displayOrder: 6,
tooltip:'文字垂直对齐模式',
})
get verticalAlign () {
return this._verticalAlign;
}
set verticalAlign (value) {
if (this._verticalAlign === value) {
return;
}
this._verticalAlign = value;
this.updateRenderData();
}
/**
* @en
* The actual rendering font size in shrink mode.
*
* @zh
* SHRINK 模式下面文本实际渲染的字体大小。
*/
@property({
readonly: true,
displayName: 'Actual Font Size',
visible: false,
})
get actualFontSize () {
return this._actualFontSize;
}
set actualFontSize (value) {
this._actualFontSize = value;
}
/**
* @en
* Font size of label.
*
* @zh
* 文本字体大小。
*/
@property({
displayOrder: 7,
tooltip:'文字尺寸,以 point 为单位',
})
get fontSize () {
return this._fontSize;
}
set fontSize (value) {
if (this._fontSize === value) {
return;
}
this._fontSize = value;
this.updateRenderData();
}
/**
* @en
* Font family of label, only take effect when useSystemFont property is true.
*
* @zh
* 文本字体名称, 只在 useSystemFont 属性为 true 的时候生效。
*/
@property({
displayOrder: 8,
tooltip:'文字字体名字',
})
get fontFamily () {
return this._fontFamily;
}
set fontFamily (value) {
if (this._fontFamily === value) {
return;
}
this._fontFamily = value;
this.updateRenderData();
}
/**
* @en
* Line Height of label.
*
* @zh
* 文本行高。
*/
@property({
displayOrder: 8,
tooltip:'文字行高,以 point 为单位',
})
get lineHeight () {
return this._lineHeight;
}
set lineHeight (value) {
if (this._lineHeight === value) {
return;
}
this._lineHeight = value;
this.updateRenderData();
}
/**
* @en
* Overflow of label.
*
* @zh
* 文字显示超出范围时的处理方式。
*/
@property({
type: Overflow,
displayOrder: 9,
tooltip:'文字排版模式,包括以下三种:\n 1. CLAMP: 节点约束框之外的文字会被截断 \n 2. SHRINK: 自动根据节点约束框缩小文字\n 3. RESIZE_HEIGHT: 根据文本内容自动更新节点的 height 属性.',
})
get overflow () {
return this._overflow;
}
set overflow (value) {
if (this._overflow === value) {
return;
}
this._overflow = value;
this.updateRenderData();
}
/**
* @en
* Whether auto wrap label when string width is large than label width.
*
* @zh
* 是否自动换行。
*/
@property({
displayOrder: 10,
tooltip:'自动换行',
})
get enableWrapText () {
return this._enableWrapText;
}
set enableWrapText (value) {
if (this._enableWrapText === value) {
return;
}
this._enableWrapText = value;
this.updateRenderData();
}
/**
* @en
* The font of label.
*
* @zh
* 文本字体。
*/
@property({
type: Font,
displayOrder: 11,
tooltip:'Label 使用的字体资源',
})
get font () {
// return this._N$file;
return this._font;
}
set font (value) {
if (this._font === value) {
return;
}
// if delete the font, we should change isSystemFontUsed to true
this._isSystemFontUsed = !value;
if (EDITOR && value) {
this._userDefinedFont = value;
}
// this._N$file = value;
this._font = value;
// if (value && this._isSystemFontUsed)
// this._isSystemFontUsed = false;
if (typeof value === 'string') {
warnID(4000);
}
if (this._renderData) {
this.destroyRenderData();
this._renderData = null;
}
this._fontAtlas = null;
this.updateRenderData(true);
}
/**
* @en
* Whether use system font name or not.
*
* @zh
* 是否使用系统字体。
*/
@property({
displayOrder: 12,
tooltip:'是否使用系统默认字体',
})
get useSystemFont () {
return this._isSystemFontUsed;
}
set useSystemFont (value) {
if (this._isSystemFontUsed === value) {
return;
}
this.destroyRenderData();
this._renderData = null;
if (EDITOR) {
if (!value && this._isSystemFontUsed && this._userDefinedFont) {
this.font = this._userDefinedFont;
this.spacingX = this._spacingX;
return;
}
}
this._isSystemFontUsed = !!value;
if (value) {
this.font = null;
this._flushAssembler();
this.updateRenderData();
}
// else if (!this._userDefinedFont) {
// this.disableRender();
// }
}
/**
* @en
* The cache mode of label. This mode only supports system fonts.
*
* @zh
* 文本缓存模式, 该模式只支持系统字体。
*/
@property({
type: CacheMode,
displayOrder: 13,
tooltip:'文本缓存模式,包括以下三种:\n 1. NONE: 不做任何缓存,文本内容进行一次绘制 \n 2. BITMAP: 将文本作为静态图像加入动态图集进行批次合并,但是不能频繁动态修改文本内容 \n 3. CHAR: 将文本拆分为字符并且把字符纹理缓存到一张字符图集中进行复用,适用于字符内容重复并且频繁更新的文本内容',
})
get cacheMode () {
return this._cacheMode;
}
set cacheMode (value) {
if (this._cacheMode === value) {
return;
}
// if (this._cacheMode === CacheMode.BITMAP && !(this._font instanceof BitmapFont) && this._frame) {
// this._frame._resetDynamicAtlasFrame();
// }
if (this._cacheMode === CacheMode.CHAR) {
this._ttfSpriteFrame = null;
}
this._cacheMode = value;
this.updateRenderData(true);
}
get spriteFrame () {
return this._texture;
}
/**
* @en
* Whether the font is bold.
*
* @zh
* 字体是否加粗。
*/
@property({
// visible: false,
displayOrder: 15,
tooltip:'字体加粗',
})
get isBold () {
return this._isBold;
}
set isBold (value) {
if (this._isBold === value) {
return;
}
this._isBold = value;
this.updateRenderData();
}
/**
* @en
* Whether the font is italic.
*
* @zh
* 字体是否倾斜。
*/
@property({
// visible: false,
displayOrder: 16,
tooltip:'字体倾斜',
})
get isItalic () {
return this._isItalic;
}
set isItalic (value) {
if (this._isItalic === value) {
return;
}
this._isItalic = value;
this.updateRenderData();
}
/**
* @en
* Whether the font is underline.
*
* @zh
* 字体是否加下划线。
*/
@property({
// visible: false,
displayOrder: 17,
tooltip:'字体加下划线',
})
get isUnderline () {
return this._isUnderline;
}
set isUnderline (value) {
if (this._isUnderline === value) {
return;
}
this._isUnderline = value;
this.updateRenderData();
}
get assemblerData (){
return this._assemblerData;
}
get fontAtlas () {
return this._fontAtlas;
}
set fontAtlas (value) {
this._fontAtlas = value;
}
get spacingX () {
return this._spacingX;
}
set spacingX (value) {
if (this._spacingX === value) {
return;
}
this._spacingX = value;
this.updateRenderData();
}
get _bmFontOriginalSize (){
if (this._font instanceof BitmapFont) {
return this._font.fontSize;
}
else {
return -1;
}
}
public static HorizontalAlign = HorizontalTextAlignment;
public static VerticalAlign = VerticalTextAlignment;
public static Overflow = Overflow;
public static CacheMode = CacheMode;
public static _canvasPool = new CanvasPool();
@property
protected _useOriginalSize = true;
@property
protected _string = 'label';
@property
protected _horizontalAlign = HorizontalTextAlignment.CENTER;
@property
protected _verticalAlign = VerticalTextAlignment.CENTER;
@property
protected _actualFontSize = 0;
@property
protected _fontSize = 40;
@property
protected _fontFamily = 'Arial';
@property
protected _lineHeight = 40;
@property
protected _overflow: Overflow = Overflow.NONE;
@property
protected _enableWrapText = true;
@property
protected _font: Font | null = null;
@property
protected _isSystemFontUsed = true;
protected _spacingX = 0;
@property
protected _isItalic = false;
@property
protected _isBold = false;
@property
protected _isUnderline = false;
@property
protected _cacheMode = CacheMode.NONE;
// don't need serialize
// 这个保存了旧项目的 file 数据
protected _N$file: Font | null = null;
protected _texture: SpriteFrame | LetterRenderTexture | null = null;
protected _ttfSpriteFrame: SpriteFrame | null = null;
protected _userDefinedFont: Font | null = null;
protected _assemblerData: ISharedLabelData | null = null;
protected _fontAtlas: FontAtlas | null = null;
protected _letterTexture: LetterRenderTexture | null = null;
constructor () {
super();
if (EDITOR) {
this._userDefinedFont = null;
}
this._ttfSpriteFrame = null;
}
public onEnable () {
super.onEnable();
// TODO: Hack for barbarians
if (!this._font && !this._isSystemFontUsed) {
this.useSystemFont = true;
}
// Reapply default font family if necessary
if (this._isSystemFontUsed && !this._fontFamily) {
this.fontFamily = 'Arial';
}
this.updateRenderData(true);
}
public onDisable () {
super.onDisable();
}
public onDestroy () {
if (this._assembler && this._assembler.resetAssemblerData) {
this._assembler.resetAssemblerData(this._assemblerData!);
}
this._assemblerData = null;
if (this._ttfSpriteFrame) {
const tex = this._ttfSpriteFrame.texture;
if (tex) {
const tex2d = tex as Texture2D;
if (tex2d.image) {
tex2d.image.destroy();
}
tex.destroy();
}
this._ttfSpriteFrame = null;
}
// texture cannot be destroyed in here, lettertexture image source is public.
this._letterTexture = null;
super.onDestroy();
}
public updateRenderData (force = false) {
this.markForUpdateRenderData();
if (force) {
this._flushAssembler();
this._applyFontTexture();
}
}
protected _render (render: UI) {
render.commitComp(this, this._texture!.getGFXTextureView(), this._assembler!, this._texture!.getGFXSampler());
}
protected _updateColor () {
if (this._font instanceof BitmapFont) {
super._updateColor();
} else {
this.updateRenderData(false);
}
}
protected _canRender () {
if (!super._canRender() || !this._string) {
return false;
}
const font = this._font;
if (font && font instanceof BitmapFont) {
const spriteFrame = font.spriteFrame;
// cannot be activated if texture not loaded yet
if (!spriteFrame || !spriteFrame.textureLoaded()) {
return false;
}
}
return true;
}
protected _flushAssembler () {
const assembler = LabelComponent.Assembler!.getAssembler(this);
if (this._assembler !== assembler) {
this.destroyRenderData();
this._assembler = assembler;
}
if (!this._renderData) {
if (this._assembler && this._assembler.createData){
this._renderData = this._assembler.createData(this);
this._renderData!.material = this._material;
}
}
}
protected _flushMaterial () {
this._updateMaterial(this._material);
}
protected _applyFontTexture () {
const font = this._font;
if (font instanceof BitmapFont) {
const spriteFrame = font.spriteFrame;
const onBMFontTextureLoaded = () => {
// TODO: old texture in material have been released by loader
this._texture = spriteFrame;
this._flushMaterial();
if (this._assembler) {
this._assembler!.updateRenderData(this);
}
};
// cannot be activated if texture not loaded yet
if (spriteFrame) {
if (spriteFrame.loaded || spriteFrame.textureLoaded) {
onBMFontTextureLoaded();
} else {
spriteFrame.once('load', onBMFontTextureLoaded, this);
}
}
} else {
if (this.cacheMode === CacheMode.CHAR) {
this._letterTexture = this._assembler!.getAssemblerData();
this._texture = this._letterTexture;
} else if (!this._ttfSpriteFrame) {
this._ttfSpriteFrame = new SpriteFrame();
this._assemblerData = this._assembler!.getAssemblerData();
const image = new ImageAsset(this._assemblerData!.canvas);
const tex = image._texture;
this._ttfSpriteFrame.texture = tex;
}
if (this.cacheMode !== CacheMode.CHAR) {
// this._frame._refreshTexture(this._texture);
this._texture = this._ttfSpriteFrame;
}
this._flushMaterial();
if (this._assembler) {
this._assembler!.updateRenderData(this);
}
}
}
}
cc.LabelComponent = LabelComponent;