@next2d/display 1.14.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,98 @@
1
+ import { EventDispatcher } from "@next2d/events";
2
+ /**
3
+ * FrameLabel オブジェクトには、フレーム番号および対応するラベル名を指定するプロパティがあります。
4
+ * MovieClip クラスには、currentLabels プロパティがあります。
5
+ * これは、現在のシーンの FrameLabel オブジェクトの配列です。
6
+ * MovieClip インスタンスがシーンを使用していない場合、配列には MovieClip インスタンス全体のすべてのフレームラベルが含まれます。
7
+ *
8
+ * The FrameLabel object contains properties that specify a frame number and the corresponding label name.
9
+ * The MovieClip class includes a currentLabels property,
10
+ * which is an Array of FrameLabel objects for the current scene.
11
+ * If the MovieClip instance does not use scenes,
12
+ * the Array includes all frame labels from the entire MovieClip instance.
13
+ *
14
+ * @example <caption>Example usage of FrameLabel.</caption>
15
+ * // static BlendMode
16
+ * const {FrameLabel} = next2d.display;
17
+ * const frameLabel = new FrameLabel();
18
+ * frameLabel.addEventListener(Event.FRAME_LABEL, (event) =>
19
+ * {
20
+ * // more...
21
+ * }
22
+ *
23
+ * @class
24
+ * @memberOf next2d.display
25
+ * @extends EventDispatcher
26
+ */
27
+ export declare class FrameLabel extends EventDispatcher {
28
+ private readonly _$name;
29
+ private readonly _$frame;
30
+ /**
31
+ * @param {string} name
32
+ * @param {number} frame
33
+ *
34
+ * @constructor
35
+ * @public
36
+ */
37
+ constructor(name: string, frame: number);
38
+ /**
39
+ * @description 指定されたクラスのストリングを返します。
40
+ * Returns the string representation of the specified class.
41
+ *
42
+ * @return {string}
43
+ * @default [class FrameLabel]
44
+ * @method
45
+ * @static
46
+ */
47
+ static toString(): string;
48
+ /**
49
+ * @description 指定されたクラスの空間名を返します。
50
+ * Returns the space name of the specified class.
51
+ *
52
+ * @return {string}
53
+ * @default next2d.display.FrameLabel
54
+ * @const
55
+ * @static
56
+ */
57
+ static get namespace(): string;
58
+ /**
59
+ * @description 指定されたオブジェクトのストリングを返します。
60
+ * Returns the string representation of the specified object.
61
+ *
62
+ * @return {string}
63
+ * @default [object FrameLabel]
64
+ * @method
65
+ * @public
66
+ */
67
+ toString(): string;
68
+ /**
69
+ * @description 指定されたオブジェクトの空間名を返します。
70
+ * Returns the space name of the specified object.
71
+ *
72
+ * @return {string}
73
+ * @default next2d.display.FrameLabel
74
+ * @const
75
+ * @public
76
+ */
77
+ get namespace(): string;
78
+ /**
79
+ * @description ラベルを含むフレームの番号。
80
+ * The frame number containing the label.
81
+ *
82
+ * @return {number}
83
+ * @method
84
+ * @readonly
85
+ * @public
86
+ */
87
+ get frame(): number;
88
+ /**
89
+ * @description ラベルの名前。
90
+ * The name of the label.
91
+ *
92
+ * @return {string}
93
+ * @method
94
+ * @readonly
95
+ * @public
96
+ */
97
+ get name(): string;
98
+ }
@@ -0,0 +1,120 @@
1
+ import { EventDispatcher } from "@next2d/events";
2
+ /**
3
+ * FrameLabel オブジェクトには、フレーム番号および対応するラベル名を指定するプロパティがあります。
4
+ * MovieClip クラスには、currentLabels プロパティがあります。
5
+ * これは、現在のシーンの FrameLabel オブジェクトの配列です。
6
+ * MovieClip インスタンスがシーンを使用していない場合、配列には MovieClip インスタンス全体のすべてのフレームラベルが含まれます。
7
+ *
8
+ * The FrameLabel object contains properties that specify a frame number and the corresponding label name.
9
+ * The MovieClip class includes a currentLabels property,
10
+ * which is an Array of FrameLabel objects for the current scene.
11
+ * If the MovieClip instance does not use scenes,
12
+ * the Array includes all frame labels from the entire MovieClip instance.
13
+ *
14
+ * @example <caption>Example usage of FrameLabel.</caption>
15
+ * // static BlendMode
16
+ * const {FrameLabel} = next2d.display;
17
+ * const frameLabel = new FrameLabel();
18
+ * frameLabel.addEventListener(Event.FRAME_LABEL, (event) =>
19
+ * {
20
+ * // more...
21
+ * }
22
+ *
23
+ * @class
24
+ * @memberOf next2d.display
25
+ * @extends EventDispatcher
26
+ */
27
+ export class FrameLabel extends EventDispatcher {
28
+ /**
29
+ * @param {string} name
30
+ * @param {number} frame
31
+ *
32
+ * @constructor
33
+ * @public
34
+ */
35
+ constructor(name, frame) {
36
+ super();
37
+ /**
38
+ * @type {string}
39
+ * @private
40
+ */
41
+ this._$name = `${name}`;
42
+ /**
43
+ * @type {number}
44
+ * @private
45
+ */
46
+ this._$frame = frame | 0;
47
+ }
48
+ /**
49
+ * @description 指定されたクラスのストリングを返します。
50
+ * Returns the string representation of the specified class.
51
+ *
52
+ * @return {string}
53
+ * @default [class FrameLabel]
54
+ * @method
55
+ * @static
56
+ */
57
+ static toString() {
58
+ return "[class FrameLabel]";
59
+ }
60
+ /**
61
+ * @description 指定されたクラスの空間名を返します。
62
+ * Returns the space name of the specified class.
63
+ *
64
+ * @return {string}
65
+ * @default next2d.display.FrameLabel
66
+ * @const
67
+ * @static
68
+ */
69
+ static get namespace() {
70
+ return "next2d.display.FrameLabel";
71
+ }
72
+ /**
73
+ * @description 指定されたオブジェクトのストリングを返します。
74
+ * Returns the string representation of the specified object.
75
+ *
76
+ * @return {string}
77
+ * @default [object FrameLabel]
78
+ * @method
79
+ * @public
80
+ */
81
+ toString() {
82
+ return "[object FrameLabel]";
83
+ }
84
+ /**
85
+ * @description 指定されたオブジェクトの空間名を返します。
86
+ * Returns the space name of the specified object.
87
+ *
88
+ * @return {string}
89
+ * @default next2d.display.FrameLabel
90
+ * @const
91
+ * @public
92
+ */
93
+ get namespace() {
94
+ return "next2d.display.FrameLabel";
95
+ }
96
+ /**
97
+ * @description ラベルを含むフレームの番号。
98
+ * The frame number containing the label.
99
+ *
100
+ * @return {number}
101
+ * @method
102
+ * @readonly
103
+ * @public
104
+ */
105
+ get frame() {
106
+ return this._$frame;
107
+ }
108
+ /**
109
+ * @description ラベルの名前。
110
+ * The name of the label.
111
+ *
112
+ * @return {string}
113
+ * @method
114
+ * @readonly
115
+ * @public
116
+ */
117
+ get name() {
118
+ return this._$name;
119
+ }
120
+ }