/
Skeleton.js
1267 lines (1163 loc) · 41.6 KB
/
Skeleton.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 TrackEntryListeners = require('./track-entry-listeners');
const RenderComponent = require('../../cocos2d/core/components/CCRenderComponent');
const spine = require('./lib/spine');
const SpineMaterial = require('../../cocos2d/core/renderer/render-engine').SpineMaterial;
const Graphics = require('../../cocos2d/core/graphics/graphics');
let SkeletonCache = require('./skeleton-cache');
/**
* @module sp
*/
let DefaultSkinsEnum = cc.Enum({ 'default': -1 });
let DefaultAnimsEnum = cc.Enum({ '<None>': 0 });
/**
* !#en Enum for render mode type.
* !#zh Spine渲染类型
* @enum Skeleton.RenderMode
*/
let RenderMode = cc.Enum({
/**
* !#en The realtime mode.
* !#zh 实时计算模式。
* @property {Number} REALTIME
*/
REALTIME: 0,
/**
* !#en The shared cache mode.
* !#zh 共享缓存模式。
* @property {Number} SHARED_CACHE
*/
SHARED_CACHE: 1,
/**
* !#en The private cache mode.
* !#zh 私有缓存模式。
* @property {Number} PRIVATE_CACHE
*/
PRIVATE_CACHE: 2
});
function setEnumAttr (obj, propName, enumDef) {
cc.Class.attr(obj, propName, {
type: 'Enum',
enumList: cc.Enum.getList(enumDef)
});
}
/**
* !#en
* The skeleton of Spine <br/>
* <br/>
* (Skeleton has a reference to a SkeletonData and stores the state for skeleton instance,
* which consists of the current pose's bone SRT, slot colors, and which slot attachments are visible. <br/>
* Multiple skeletons can use the same SkeletonData which includes all animations, skins, and attachments.) <br/>
* !#zh
* Spine 骨骼动画 <br/>
* <br/>
* (Skeleton 具有对骨骼数据的引用并且存储了骨骼实例的状态，
* 它由当前的骨骼动作，slot 颜色，和可见的 slot attachments 组成。<br/>
* 多个 Skeleton 可以使用相同的骨骼数据，其中包括所有的动画，皮肤和 attachments。
*
* @class Skeleton
* @extends RenderComponent
*/
sp.Skeleton = cc.Class({
name: 'sp.Skeleton',
extends: RenderComponent,
editor: CC_EDITOR && {
menu: 'i18n:MAIN_MENU.component.renderers/Spine Skeleton',
help: 'app://docs/html/components/spine.html',
//playOnFocus: true
},
statics: {
RenderMode: RenderMode,
},
properties: {
/**
* !#en The skeletal animation is paused?
* !#zh 该骨骼动画是否暂停。
* @property paused
* @type {Boolean}
* @readOnly
* @default false
*/
paused: {
default: false,
visible: false
},
/**
* !#en
* The skeleton data contains the skeleton information (bind pose bones, slots, draw order,
* attachments, skins, etc) and animations but does not hold any state.<br/>
* Multiple skeletons can share the same skeleton data.
* !#zh
* 骨骼数据包含了骨骼信息（绑定骨骼动作，slots，渲染顺序，
* attachments，皮肤等等）和动画但不持有任何状态。<br/>
* 多个 Skeleton 可以共用相同的骨骼数据。
* @property {SkeletonData} skeletonData
*/
skeletonData: {
default: null,
type: sp.SkeletonData,
notify () {
this.defaultSkin = '';
this.defaultAnimation = '';
if (CC_EDITOR) {
this._refreshInspector();
}
this._updateSkeletonData();
},
tooltip: CC_DEV && 'i18n:COMPONENT.skeleton.skeleton_data'
},
// 由于 spine 的 skin 是无法二次替换的，所以只能设置默认的 skin
/**
* !#en The name of default skin.
* !#zh 默认的皮肤名称。
* @property {String} defaultSkin
*/
defaultSkin: {
default: '',
visible: false
},
/**
* !#en The name of default animation.
* !#zh 默认的动画名称。
* @property {String} defaultAnimation
*/
defaultAnimation: {
default: '',
visible: false
},
/**
* !#en The name of current playing animation.
* !#zh 当前播放的动画名称。
* @property {String} animation
*/
animation: {
get () {
if (this.isCachedMode()) {
return this._animationName;
} else {
var entry = this.getCurrent(0);
return (entry && entry.animation.name) || "";
}
},
set (value) {
this.defaultAnimation = value;
if (value) {
this.setAnimation(0, value, this.loop);
}
else {
this.clearTrack(0);
this.setToSetupPose();
}
},
visible: false
},
/**
* @property {Number} _defaultSkinIndex
*/
_defaultSkinIndex: {
get () {
if (this.skeletonData && this.defaultSkin) {
var skinsEnum = this.skeletonData.getSkinsEnum();
if (skinsEnum) {
var skinIndex = skinsEnum[this.defaultSkin];
if (skinIndex !== undefined) {
return skinIndex;
}
}
}
return 0;
},
set (value) {
var skinsEnum;
if (this.skeletonData) {
skinsEnum = this.skeletonData.getSkinsEnum();
}
if ( !skinsEnum ) {
return cc.errorID('',
this.name);
}
var skinName = skinsEnum[value];
if (skinName !== undefined) {
this.defaultSkin = skinName;
if (CC_EDITOR && !cc.engine.isPlaying) {
this._refreshInspector();
}
}
else {
cc.errorID(7501, this.name);
}
},
type: DefaultSkinsEnum,
visible: true,
displayName: "Default Skin",
tooltip: CC_DEV && 'i18n:COMPONENT.skeleton.default_skin'
},
// value of 0 represents no animation
_animationIndex: {
get () {
var animationName = (!CC_EDITOR || cc.engine.isPlaying) ? this.animation : this.defaultAnimation;
if (this.skeletonData && animationName) {
var animsEnum = this.skeletonData.getAnimsEnum();
if (animsEnum) {
var animIndex = animsEnum[animationName];
if (animIndex !== undefined) {
return animIndex;
}
}
}
return 0;
},
set (value) {
if (value === 0) {
this.animation = '';
return;
}
var animsEnum;
if (this.skeletonData) {
animsEnum = this.skeletonData.getAnimsEnum();
}
if ( !animsEnum ) {
return cc.errorID(7502, this.name);
}
var animName = animsEnum[value];
if (animName !== undefined) {
this.animation = animName;
}
else {
cc.errorID(7503, this.name);
}
},
type: DefaultAnimsEnum,
visible: true,
displayName: 'Animation',
tooltip: CC_DEV && 'i18n:COMPONENT.skeleton.animation'
},
// Record pre render mode.
_preRenderMode: -1,
_renderMode: RenderMode.REALTIME,
_defaultRenderMode: {
default: 0,
type: RenderMode,
notify () {
this.setRenderMode(this._defaultRenderMode);
},
editorOnly: true,
visible: true,
animatable: false,
displayName: "Render Mode",
tooltip: CC_DEV && 'i18n:COMPONENT.skeleton.render_mode'
},
/**
* !#en TODO
* !#zh 是否循环播放当前骨骼动画。
* @property {Boolean} loop
* @default true
*/
loop: {
default: true,
tooltip: CC_DEV && 'i18n:COMPONENT.skeleton.loop'
},
/**
* !#en Indicates whether to enable premultiplied alpha.
* You should disable this option when image's transparent area appears to have opaque pixels,
* or enable this option when image's half transparent area appears to be darken.
* !#zh 是否启用贴图预乘。
* 当图片的透明区域出现色块时需要关闭该选项，当图片的半透明区域颜色变黑时需要启用该选项。
* @property {Boolean} premultipliedAlpha
* @default true
*/
premultipliedAlpha: {
default: true,
tooltip: CC_DEV && 'i18n:COMPONENT.skeleton.premultipliedAlpha'
},
/**
* !#en The time scale of this skeleton.
* !#zh 当前骨骼中所有动画的时间缩放率。
* @property {Number} timeScale
* @default 1
*/
timeScale: {
default: 1,
tooltip: CC_DEV && 'i18n:COMPONENT.skeleton.time_scale'
},
/**
* !#en Indicates whether open debug slots.
* !#zh 是否显示 slot 的 debug 信息。
* @property {Boolean} debugSlots
* @default false
*/
debugSlots: {
default: false,
editorOnly: true,
tooltip: CC_DEV && 'i18n:COMPONENT.skeleton.debug_slots',
notify () {
this._updateDebugDraw();
}
},
/**
* !#en Indicates whether open debug bones.
* !#zh 是否显示 bone 的 debug 信息。
* @property {Boolean} debugBones
* @default false
*/
debugBones: {
default: false,
editorOnly: true,
tooltip: CC_DEV && 'i18n:COMPONENT.skeleton.debug_bones',
notify () {
this._updateDebugDraw();
}
},
/**
* !#en Enabled two color tint.
* !#zh 是否启用染色效果。
* @property {Boolean} useTint
* @default false
*/
useTint: {
default: false,
tooltip: CC_DEV && 'i18n:COMPONENT.skeleton.use_tint',
notify () {
this._updateUseTint();
}
},
/**
* !#en Enabled batch model, if skeleton is complex, do not enable batch, or will lower performance.
* !#zh 开启合批，如果渲染大量相同纹理，且结构简单的骨骼动画，开启合批可以降低drawcall，否则请不要开启，cpu消耗会上升。
* @property {Boolean} enableBatch
* @default false
*/
enableBatch: {
default: false,
notify () {
this._updateBatch();
},
tooltip: CC_DEV && 'i18n:COMPONENT.skeleton.enabled_batch'
},
// Below properties will effect when render mode is SHARED_CACHE or PRIVATE_CACHE.
// accumulate time
_accTime: 0,
// Play times counter
_playCount: 0,
// Frame cache
_frameCache: null,
// Cur frame
_curFrame: null,
// Skeleton cache
_skeletonCache : null,
// Aimation name
_animationName : null,
// Animation queue
_animationQueue : [],
// Head animation info of
_headAniInfo : null,
// Play times
_playTimes : 0,
// Is animation complete.
_isAniComplete : true,
},
// CONSTRUCTOR
ctor () {
this._skeleton = null;
this._rootBone = null;
this._listener = null;
this._boundingBox = cc.rect();
this._material = new SpineMaterial();
this._materialCache = {};
this._debugRenderer = null;
this._startSlotIndex = -1;
this._endSlotIndex = -1;
this._startEntry = {animation : {name : ""}, trackIndex : 0};
this._endEntry = {animation : {name : ""}, trackIndex : 0};
},
// override
_updateMaterial (material) {
this._super(material);
this._materialCache = {};
},
_updateUseTint () {
var cache = this._materialCache;
for (var mKey in cache) {
var material = cache[mKey];
if (material) {
material.useTint = this.useTint;
}
}
},
_updateBatch () {
let cache = this._materialCache;
for (let mKey in cache) {
let material = cache[mKey];
if (material) {
material.useModel = !this.enableBatch;
}
}
},
/**
* !#en
* Sets runtime skeleton data to sp.Skeleton.<br>
* This method is different from the `skeletonData` property. This method is passed in the raw data provided by the Spine runtime, and the skeletonData type is the asset type provided by Creator.
* !#zh
* 设置底层运行时用到的 SkeletonData。<br>
* 这个接口有别于 `skeletonData` 属性，这个接口传入的是 Spine runtime 提供的原始数据，而 skeletonData 的类型是 Creator 提供的资源类型。
* @method setSkeletonData
* @param {sp.spine.SkeletonData} skeletonData
*/
setSkeletonData (skeletonData) {
if (skeletonData.width != null && skeletonData.height != null) {
this.node.setContentSize(skeletonData.width, skeletonData.height);
}
if (this.isCachedMode()) {
let skeletonInfo = this._skeletonCache.getSkeletonCache(this.skeletonData._uuid, skeletonData);
this._skeleton = skeletonInfo.skeleton;
this._clipper = skeletonInfo.clipper;
this._rootBone = this._skeleton.getRootBone();
} else {
this._skeleton = new spine.Skeleton(skeletonData);
this._clipper = new spine.SkeletonClipping();
this._rootBone = this._skeleton.getRootBone();
}
},
/**
* !#en Sets slots visible range.
* !#zh 设置骨骼插槽可视范围。
* @method setSlotsRange
* @param {sp.spine.SkeletonData} skeletonData
*/
setSlotsRange (startSlotIndex, endSlotIndex) {
if (this.isCachedMode()) {
console.warn("Slots visible range can not be modified in cached mode.");
} else {
this._startSlotIndex = startSlotIndex;
this._endSlotIndex = endSlotIndex;
}
},
/**
* !#en Sets animation state data.<br>
* The parameter type is {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.AnimationStateData.
* !#zh 设置动画状态数据。<br>
* 参数是 {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.AnimationStateData。
* @method setAnimationStateData
* @param {sp.spine.AnimationStateData} stateData
*/
setAnimationStateData (stateData) {
if (this.isCachedMode()) {
console.warn("'setAnimationStateData' interface can not be invoked in cached mode.");
} else {
var state = new spine.AnimationState(stateData);
if (this._listener) {
if (this._state) {
this._state.removeListener(this._listener);
}
state.addListener(this._listener);
}
this._state = state;
}
},
// IMPLEMENT
__preload () {
if (CC_EDITOR) {
var Flags = cc.Object.Flags;
this._objFlags |= (Flags.IsAnchorLocked | Flags.IsSizeLocked);
this._refreshInspector();
}
var children = this.node.children;
for (var i = 0, n = children.length; i < n; i++) {
var child = children[i];
if (child && child._name === "DEBUG_DRAW_NODE" ) {
child.destroy();
}
}
if (CC_JSB) {
this._renderMode = RenderMode.REALTIME;
}
this._updateSkeletonData();
this._updateDebugDraw();
this._updateUseTint();
this._updateBatch();
},
/**
* !#en
* It's best to set render mode before set property 'dragonAsset', or will waste some cpu time.
* If set the mode in editor, then no need to worry about order problem.
* !#zh
* 若想切换渲染模式，最好在设置'dragonAsset'之前，先设置好渲染模式，否则有运行时开销。
* 若在编辑中设置渲染模式，则无需担心设置次序的问题。
*
* @method setRenderMode
* @param {RenderMode} renderMode
* * @example
* armatureDisplay.setRenderMode(sp.Skeleton.RenderMode.SHARED_CACHE);
*/
setRenderMode (renderMode) {
if (CC_JSB) return;
if (this._preRenderMode !== renderMode) {
this._renderMode = renderMode;
this._updateSkeletonData();
}
},
/**
* !#en Whether in cached mode.
* !#zh 当前是否处于缓存模式。
* @method isCachedMode
*/
isCachedMode () {
if (CC_EDITOR) return false;
return this._renderMode !== RenderMode.REALTIME;
},
update (dt) {
if (CC_EDITOR) return;
if (this.paused) return;
if (this.isCachedMode()) {
// Cache mode and has animation queue.
if (this._isAniComplete) {
if (this._animationQueue.length === 0 && !this._headAniInfo) return;
if (!this._headAniInfo) {
this._headAniInfo = this._animationQueue.shift();
}
this._accTime += dt;
if (this._accTime > this._headAniInfo.delay) {
let aniInfo = this._headAniInfo;
this._headAniInfo = null;
this.setAnimation (0, aniInfo.animationName, aniInfo.loop);
}
return;
}
this._updateCache(dt);
} else {
this._updateRealtime(dt);
}
},
_updateCache (dt) {
let frames = this._frameCache.frames;
let totalTime = this._frameCache.totalTime;
let frameCount = frames.length;
// Animation Start, the event diffrent from dragonbones inner event,
// It has no event object.
if (this._accTime == 0 && this._playCount == 0) {
this._startEntry.animation.name = this._animationName;
this._listener && this._listener.start && this._listener.start(this._startEntry);
}
this._accTime += dt * this.timeScale;
let frameIdx = Math.floor(this._accTime / totalTime * frameCount);
if (frameIdx >= frameCount) {
// Animation complete, the event diffrent from dragonbones inner event,
// It has no event object.
this._endEntry.animation.name = this._animationName;
this._listener && this._listener.complete && this._listener.complete(this._endEntry);
this._listener && this._listener.end && this._listener.end(this._endEntry);
this._playCount ++;
if (this._playTimes > 0 && this._playCount >= this._playTimes) {
this._accTime = 0;
this._playCount = 0;
this._isAniComplete = true;
return;
}
this._accTime = 0;
frameIdx = 0;
}
this._curFrame = frames[frameIdx];
},
_updateRealtime (dt) {
let skeleton = this._skeleton;
let state = this._state;
if (skeleton) {
skeleton.update(dt);
if (state) {
dt *= this.timeScale;
state.update(dt);
state.apply(skeleton);
}
}
},
onRestore () {
// Destroyed and restored in Editor
if (!this._material) {
this._boundingBox = cc.rect();
this._material = new SpineMaterial();
this._materialCache = {};
}
},
// RENDERER
/**
* !#en Computes the world SRT from the local SRT for each bone.
* !#zh 重新更新所有骨骼的世界 Transform，
* 当获取 bone 的数值未更新时，即可使用该函数进行更新数值。
* @method updateWorldTransform
* @example
* var bone = spine.findBone('head');
* cc.log(bone.worldX); // return 0;
* spine.updateWorldTransform();
* bone = spine.findBone('head');
* cc.log(bone.worldX); // return -23.12;
*/
updateWorldTransform () {
if (!this.isCachedMode()) return;
if (this._skeleton) {
this._skeleton.updateWorldTransform();
}
},
/**
* !#en Sets the bones and slots to the setup pose.
* !#zh 还原到起始动作
* @method setToSetupPose
*/
setToSetupPose () {
if (this.isCachedMode()) {
cc.warn("'SetToSetupPose' interface can not be invoked in cached mode.");
} else {
if (this._skeleton) {
this._skeleton.setToSetupPose();
}
}
},
/**
* !#en
* Sets the bones to the setup pose,
* using the values from the `BoneData` list in the `SkeletonData`.
* !#zh
* 设置 bone 到起始动作
* 使用 SkeletonData 中的 BoneData 列表中的值。
* @method setBonesToSetupPose
*/
setBonesToSetupPose () {
if (this.isCachedMode()) {
cc.warn("'setBonesToSetupPose' interface can not be invoked in cached mode.");
} else {
if (this._skeleton) {
this._skeleton.setBonesToSetupPose();
}
}
},
/**
* !#en
* Sets the slots to the setup pose,
* using the values from the `SlotData` list in the `SkeletonData`.
* !#zh
* 设置 slot 到起始动作。
* 使用 SkeletonData 中的 SlotData 列表中的值。
* @method setSlotsToSetupPose
*/
setSlotsToSetupPose () {
if (this.isCachedMode()) {
cc.warn("'setSlotsToSetupPose' interface can not be invoked in cached mode.");
} else {
if (this._skeleton) {
this._skeleton.setSlotsToSetupPose();
}
}
},
/**
* !#en
* Update an animation cache.
* !#zh
* 更新某个动画缓存。
* @method updateAnimationCache
* @param {String} animName
*/
updateAnimationCache (animName) {
if (!this.isCachedMode()) return;
let cache = this._skeletonCache.updateAnimationCache(this.skeletonData._uuid, animName);
this._frameCache = cache || this._frameCache;
},
/**
* !#en
* Finds a bone by name.
* This does a string comparison for every bone.<br>
* Returns a {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.Bone object.
* !#zh
* 通过名称查找 bone。
* 这里对每个 bone 的名称进行了对比。<br>
* 返回一个 {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.Bone 对象。
*
* @method findBone
* @param {String} boneName
* @return {sp.spine.Bone}
*/
findBone (boneName) {
if (this._skeleton) {
return this._skeleton.findBone(boneName);
}
return null;
},
/**
* !#en
* Finds a slot by name. This does a string comparison for every slot.<br>
* Returns a {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.Slot object.
* !#zh
* 通过名称查找 slot。这里对每个 slot 的名称进行了比较。<br>
* 返回一个 {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.Slot 对象。
*
* @method findSlot
* @param {String} slotName
* @return {sp.spine.Slot}
*/
findSlot (slotName) {
if (this._skeleton) {
return this._skeleton.findSlot(slotName);
}
return null;
},
/**
* !#en
* Finds a skin by name and makes it the active skin.
* This does a string comparison for every skin.<br>
* Note that setting the skin does not change which attachments are visible.<br>
* Returns a {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.Skin object.
* !#zh
* 按名称查找皮肤，激活该皮肤。这里对每个皮肤的名称进行了比较。<br>
* 注意：设置皮肤不会改变 attachment 的可见性。<br>
* 返回一个 {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.Skin 对象。
*
* @method setSkin
* @param {String} skinName
* @return {sp.spine.Skin}
*/
setSkin (skinName) {
if (this.isCachedMode()) {
this._skeletonCache.resetSkeleton();
this._animationName && (this.animation = this._animationName);
} else {
if (this._skeleton) {
return this._skeleton.setSkinByName(skinName);
}
}
return null;
},
/**
* !#en
* Returns the attachment for the slot and attachment name.
* The skeleton looks first in its skin, then in the skeleton data’s default skin.<br>
* Returns a {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.Attachment object.
* !#zh
* 通过 slot 和 attachment 的名称获取 attachment。Skeleton 优先查找它的皮肤，然后才是 Skeleton Data 中默认的皮肤。<br>
* 返回一个 {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.Attachment 对象。
*
* @method getAttachment
* @param {String} slotName
* @param {String} attachmentName
* @return {sp.spine.Attachment}
*/
getAttachment (slotName, attachmentName) {
if (this._skeleton) {
return this._skeleton.getAttachmentByName(slotName, attachmentName);
}
return null;
},
/**
* !#en
* Sets the attachment for the slot and attachment name.
* The skeleton looks first in its skin, then in the skeleton data’s default skin.
* !#zh
* 通过 slot 和 attachment 的名字来设置 attachment。
* Skeleton 优先查找它的皮肤，然后才是 Skeleton Data 中默认的皮肤。
* @method setAttachment
* @param {String} slotName
* @param {String} attachmentName
*/
setAttachment (slotName, attachmentName) {
if (this._skeleton) {
this._skeleton.setAttachment(slotName, attachmentName);
}
},
/**
* Return the renderer of attachment.
* @method getTextureAtlas
* @param {sp.spine.RegionAttachment|spine.BoundingBoxAttachment} regionAttachment
* @return {sp.spine.TextureAtlasRegion}
*/
getTextureAtlas (regionAttachment) {
return regionAttachment.region;
},
// ANIMATION
/**
* !#en
* Mix applies all keyframe values,
* interpolated for the specified time and mixed with the current values.
* !#zh 为所有关键帧设定混合及混合时间（从当前值开始差值）。
* @method setMix
* @param {String} fromAnimation
* @param {String} toAnimation
* @param {Number} duration
*/
setMix (fromAnimation, toAnimation, duration) {
if (this._state) {
this._state.data.setMix(fromAnimation, toAnimation, duration);
}
},
/**
* !#en Set the current animation. Any queued animations are cleared.<br>
* Returns a {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.TrackEntry object.
* !#zh 设置当前动画。队列中的任何的动画将被清除。<br>
* 返回一个 {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.TrackEntry 对象。
* @method setAnimation
* @param {Number} trackIndex
* @param {String} name
* @param {Boolean} loop
* @return {sp.spine.TrackEntry}
*/
setAnimation (trackIndex, name, loop) {
this._playTimes = loop ? 0 : 1;
this._animationName = name;
if (this.isCachedMode()) {
if (trackIndex !== 0) {
cc.warn("Track index can not greater than 0 in cached mode.");
}
let cache = this._skeletonCache.getAnimationCache(this.skeletonData._uuid, name);
if (!cache) {
cache = this._skeletonCache.updateAnimationCache(this.skeletonData._uuid, name);
}
if (cache) {
this._isAniComplete = false;
this._accTime = 0;
this._playCount = 0;
this._frameCache = cache;
this._curFrame = this._frameCache.frames[0];
}
} else {
if (this._skeleton) {
var animation = this._skeleton.data.findAnimation(name);
if (!animation) {
cc.logID(7509, name);
return null;
}
var res = this._state.setAnimationWith(trackIndex, animation, loop);
this._state.apply(this._skeleton);
return res;
}
}
return null;
},
/**
* !#en Adds an animation to be played delay seconds after the current or last queued animation.<br>
* Returns a {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.TrackEntry object.
* !#zh 添加一个动画到动画队列尾部，还可以延迟指定的秒数。<br>
* 返回一个 {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.TrackEntry 对象。
* @method addAnimation
* @param {Number} trackIndex
* @param {String} name
* @param {Boolean} loop
* @param {Number} [delay=0]
* @return {sp.spine.TrackEntry}
*/
addAnimation (trackIndex, name, loop, delay) {
if (this.isCachedMode()) {
if (trackIndex !== 0) {
cc.warn("Track index can not greater than 0 in cached mode.");
}
this._animationQueue.push({animationName : name, loop: loop, delay : delay});
} else {
if (this._skeleton) {
delay = delay || 0;
var animation = this._skeleton.data.findAnimation(name);
if (!animation) {
cc.logID(7510, name);
return null;
}
return this._state.addAnimationWith(trackIndex, animation, loop, delay);
}
}
return null;
},
/**
* !#en Find animation with specified name.
* !#zh 查找指定名称的动画
* @method findAnimation
* @param {String} name
* @returns {sp.spine.Animation}
*/
findAnimation (name) {
if (this._skeleton) {
return this._skeleton.data.findAnimation(name);
}
return null;
},
/**
* !#en Returns track entry by trackIndex.<br>
* Returns a {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.TrackEntry object.
* !#zh 通过 track 索引获取 TrackEntry。<br>
* 返回一个 {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.TrackEntry 对象。
* @method getCurrent
* @param trackIndex
* @return {sp.spine.TrackEntry}
*/
getCurrent (trackIndex) {
if (this.isCachedMode()) {
console.warn("'getCurrent' interface can not be invoked in cached mode.");
} else {
if (this._state) {
return this._state.getCurrent(trackIndex);
}
}
return null;
},
/**
* !#en Clears all tracks of animation state.
* !#zh 清除所有 track 的动画状态。
* @method clearTracks
*/
clearTracks () {
if (this.isCachedMode()) {
console.warn("'clearTracks' interface can not be invoked in cached mode.");
} else {
if (this._state) {