@next2d/display 1.18.12 → 2.0.0

package/src/Loader.d.ts

@@ -0,0 +1,82 @@
+import type { IParent } from "./interface/IParent";
+import type { Sprite } from "./Sprite";
+import type { IAnimationToolData } from "./interface/IAnimationToolData";
+import type { IAnimationToolDataZlib } from "./interface/IAnimationToolDataZlib";
+import type { MovieClip } from "./MovieClip";
+import type { URLRequest } from "@next2d/net";
+import { LoaderInfo } from "./LoaderInfo";
+/**
+ * @description Loader クラスは、JSON ファイルを読み込むために使用します。
+ *              外部からの読み込みを開始するには load() メソッドを使用し、ローカルのJSONを読み込むには loadJSON() メソッドを使用します。
+ *
+ *              The Loader class is used to load JSON files.
+ *              To start loading from an external source, use the load() method, and to load local JSON, use the loadJSON() method.
+ *
+ * @class
+ * @memberOf next2d.display
+ */
+export declare class Loader {
+    /**
+     * @description 読み込まれているオブジェクトに対応する LoaderInfo オブジェクトを返します。
+     *              Returns a LoaderInfo object corresponding to the object being loaded.
+     *
+     * @type {LoaderInfo}
+     * @readonly
+     * @public
+     */
+    readonly contentLoaderInfo: LoaderInfo;
+    /**
+     * @type {null}
+     * @readonly
+     * @public
+     */
+    readonly root: null;
+    /**
+     * @constructor
+     * @public
+     */
+    constructor();
+    /**
+     * @description load メソッドを使用して読み込まれた JSON のルート表示オブジェクトが含まれます。
+     *              It contains a JSON root display object loaded using the load method.
+     *
+     * @member {MovieClip | Sprite | null}
+     * @readonly
+     * @public
+     */
+    get content(): IParent<MovieClip | Sprite> | null;
+    /**
+     * @description この表示オブジェクトが属するファイルの読み込み情報を含む LoaderInfo オブジェクトを返します。
+     *              Returns a LoaderInfo object containing information
+     *              about loading the file to which this display object belongs.
+     *
+     * @member  {LoaderInfo}
+     * @default null
+     * @readonly
+     * @public
+     */
+    get loaderInfo(): LoaderInfo;
+    /**
+     * @description JSONファイルを、この Loader オブジェクトの子であるcontentプロパティにロードします。
+     *              JPEG、GIF、PNGなどの画像データは loadImage で同様にcontentプロパティにロードします。
+     *              Load the JSON file into the content property, which is a child of this Loader object.
+     *              Image data such as JPEG, GIF, PNG, etc.
+     *              are loaded into the content property in the same way with loadImage.
+     *
+     * @param   {URLRequest} request
+     * @returns {Promise}
+     * @method
+     * @public
+     */
+    load(request: URLRequest): Promise<void>;
+    /**
+     * @description AnimationToolで書き出したJSONオブジェクトを直接読み込む
+     *              Load the JSON object exported with AnimationTool directly.
+     *
+     * @param  {object} json
+     * @return {void}
+     * @method
+     * @public
+     */
+    loadJSON(json: IAnimationToolData | IAnimationToolDataZlib): Promise<void>;
+}

package/src/Loader.js

@@ -0,0 +1,104 @@
+import { LoaderInfo } from "./LoaderInfo";
+import { execute as loaderLoadJsonUseCase } from "./Loader/usecase/LoaderLoadJsonUseCase";
+import { execute as loaderLoadUseCase } from "./Loader/usecase/LoaderLoadUseCase";
+/**
+ * @description Loader クラスは、JSON ファイルを読み込むために使用します。
+ *              外部からの読み込みを開始するには load() メソッドを使用し、ローカルのJSONを読み込むには loadJSON() メソッドを使用します。
+ *
+ *              The Loader class is used to load JSON files.
+ *              To start loading from an external source, use the load() method, and to load local JSON, use the loadJSON() method.
+ *
+ * @class
+ * @memberOf next2d.display
+ */
+export class Loader {
+    /**
+     * @constructor
+     * @public
+     */
+    constructor() {
+        /**
+         * @description 読み込まれているオブジェクトに対応する LoaderInfo オブジェクトを返します。
+         *              Returns a LoaderInfo object corresponding to the object being loaded.
+         *
+         * @type {LoaderInfo}
+         * @readonly
+         * @public
+         */
+        Object.defineProperty(this, "contentLoaderInfo", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @type {null}
+         * @readonly
+         * @public
+         */
+        Object.defineProperty(this, "root", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.root = null;
+        this.contentLoaderInfo = new LoaderInfo();
+    }
+    /**
+     * @description load メソッドを使用して読み込まれた JSON のルート表示オブジェクトが含まれます。
+     *              It contains a JSON root display object loaded using the load method.
+     *
+     * @member {MovieClip | Sprite | null}
+     * @readonly
+     * @public
+     */
+    get content() {
+        return this.contentLoaderInfo.content;
+    }
+    /**
+     * @description この表示オブジェクトが属するファイルの読み込み情報を含む LoaderInfo オブジェクトを返します。
+     *              Returns a LoaderInfo object containing information
+     *              about loading the file to which this display object belongs.
+     *
+     * @member  {LoaderInfo}
+     * @default null
+     * @readonly
+     * @public
+     */
+    get loaderInfo() {
+        return this.contentLoaderInfo;
+    }
+    /**
+     * @description JSONファイルを、この Loader オブジェクトの子であるcontentプロパティにロードします。
+     *              JPEG、GIF、PNGなどの画像データは loadImage で同様にcontentプロパティにロードします。
+     *              Load the JSON file into the content property, which is a child of this Loader object.
+     *              Image data such as JPEG, GIF, PNG, etc.
+     *              are loaded into the content property in the same way with loadImage.
+     *
+     * @param   {URLRequest} request
+     * @returns {Promise}
+     * @method
+     * @public
+     */
+    async load(request) {
+        if (request.responseDataFormat !== "json") {
+            throw new Error("The only format that can be loaded by this function is `json` format.");
+        }
+        this.contentLoaderInfo.url = request.url;
+        this.contentLoaderInfo.format = request.responseDataFormat;
+        await loaderLoadUseCase(this, request);
+    }
+    /**
+     * @description AnimationToolで書き出したJSONオブジェクトを直接読み込む
+     *              Load the JSON object exported with AnimationTool directly.
+     *
+     * @param  {object} json
+     * @return {void}
+     * @method
+     * @public
+     */
+    async loadJSON(json) {
+        await loaderLoadJsonUseCase(this, json);
+    }
+}

package/src/LoaderInfo.d.ts

@@ -0,0 +1,68 @@
+import type { MovieClip } from "./MovieClip";
+import type { Sprite } from "./Sprite";
+import type { IParent } from "./interface/IParent";
+import type { IURLLoaderDataFormat } from "./interface/IURLLoaderDataFormat";
+import type { ILoaderInfoData } from "./interface/ILoaderInfoData";
+import { EventDispatcher } from "@next2d/events";
+/**
+ * @description LoaderInfo クラスは、読み込まれる JSON ファイルに関する情報を提供します。
+ *              LoaderInfo オブジェクトは、すべての表示オブジェクトで使用できます。
+ *
+ *              The LoaderInfo class provides information about the JSON file to be loaded.
+ *              The LoaderInfo object can be used with all display objects.
+ *
+ * @class
+ * @memberOf next2d.display
+ * @extends  EventDispatcher
+ */
+export declare class LoaderInfo extends EventDispatcher {
+    /**
+     * @description LoaderInfoのユニークIDを返却
+     *              Returns the unique ID of LoaderInfo
+     *
+     * @type {number}
+     * @readonly
+     * @public
+     */
+    readonly id: number;
+    /**
+     * @description LoaderInfo オブジェクトに関係したロードされたオブジェクトです。
+     *              The loaded object associated with this LoaderInfo object.
+     *
+     * @type {MovieClip | Sprite | null}
+     * @public
+     */
+    content: IParent<MovieClip | Sprite> | null;
+    /**
+     * @description Loaderで読み込まれたデータオブジェクトを返却
+     *              Returns the data object loaded by the Loader
+     *
+     * @type {object}
+     * @public
+     */
+    data: ILoaderInfoData | null;
+    /**
+     * @description 読み込まれるメディアの URL です。
+     *              The URL of the media being loaded.
+     *
+     * @type {string}
+     * @default ""
+     * @readonly
+     * @public
+     */
+    url: string;
+    /**
+     * @description 読み込まれるメディアの データフォーマット です。
+     *              The data format of the media being loaded.
+     *
+     * @type {string}
+     * @default "json"
+     * @public
+     */
+    format: IURLLoaderDataFormat;
+    /**
+     * @constructor
+     * @public
+     */
+    constructor();
+}

package/src/LoaderInfo.js

@@ -0,0 +1,96 @@
+import { EventDispatcher } from "@next2d/events";
+import { $getInstanceId } from "./DisplayObjectUtil";
+/**
+ * @description LoaderInfo クラスは、読み込まれる JSON ファイルに関する情報を提供します。
+ *              LoaderInfo オブジェクトは、すべての表示オブジェクトで使用できます。
+ *
+ *              The LoaderInfo class provides information about the JSON file to be loaded.
+ *              The LoaderInfo object can be used with all display objects.
+ *
+ * @class
+ * @memberOf next2d.display
+ * @extends  EventDispatcher
+ */
+export class LoaderInfo extends EventDispatcher {
+    /**
+     * @constructor
+     * @public
+     */
+    constructor() {
+        super();
+        /**
+         * @description LoaderInfoのユニークIDを返却
+         *              Returns the unique ID of LoaderInfo
+         *
+         * @type {number}
+         * @readonly
+         * @public
+         */
+        Object.defineProperty(this, "id", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description LoaderInfo オブジェクトに関係したロードされたオブジェクトです。
+         *              The loaded object associated with this LoaderInfo object.
+         *
+         * @type {MovieClip | Sprite | null}
+         * @public
+         */
+        Object.defineProperty(this, "content", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description Loaderで読み込まれたデータオブジェクトを返却
+         *              Returns the data object loaded by the Loader
+         *
+         * @type {object}
+         * @public
+         */
+        Object.defineProperty(this, "data", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description 読み込まれるメディアの URL です。
+         *              The URL of the media being loaded.
+         *
+         * @type {string}
+         * @default ""
+         * @readonly
+         * @public
+         */
+        Object.defineProperty(this, "url", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description 読み込まれるメディアの データフォーマット です。
+         *              The data format of the media being loaded.
+         *
+         * @type {string}
+         * @default "json"
+         * @public
+         */
+        Object.defineProperty(this, "format", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.id = $getInstanceId();
+        this.url = "";
+        this.content = null;
+        this.data = null;
+        this.format = "json";
+    }
+}

package/src/LoopConfig.d.ts

@@ -0,0 +1,61 @@
+/**
+ * @description LoopConfig クラスで、MovieClipのフレームヘッダーの移動方法を指定できます。
+ *              一度限りの再生や逆再生、フレーム固定などのアニメーションのループバリエーションを設定できます。
+ *
+ *              The LoopConfig class allows you to specify how the frame headers of a MovieClip are moved.
+ *              You can set up looping variations of the animation, such as one-time playback,
+ *              reverse playback, or fixed frame.
+ *
+ * @class
+ * @memberOf next2d.display
+ */
+export declare class LoopConfig {
+    /**
+     * @description LoopTypeクラスの固定値を利用して、ループのタイプを設定できます。
+     *              You can set the type of loop by using a fixed value in the LoopType class.
+     *
+     * @return  {number}
+     * @default 0
+     * @public
+     */
+    type: 0 | 1 | 2 | 3 | 4;
+    /**
+     * @description フレーム移動の開始値を設定します。逆再生時はここで設定した値が終了フレームとなります。
+     *              Sets the start value for frame shift. For reverse playback,
+     *              the value set here is the end frame.
+     *
+     * @return  {number}
+     * @default 1
+     * @public
+     */
+    start: number;
+    /**
+     * @description フレーム移動の終了値を設定します。逆再生時はここで設定した値が開始フレームとなります。
+     *              Sets the end value of frame shift. For reverse playback,
+     *              the value set here is the start frame.
+     *
+     * @return  {number}
+     * @default 0
+     * @public
+     */
+    end: number;
+    /**
+     * @description ループ設定の適用を開始するフレームの値、自動で設定されます。
+     *              The value of the frame at which to start applying the loop setting, set automatically.
+     *
+     * @return  {number}
+     * @default 1
+     * @readonly
+     * @public
+     */
+    frame: number;
+    /**
+     * @param {number} [type=0]
+     * @param {number} [start=1]
+     * @param {number} [end=0]
+     *
+     * @constructor
+     * @public
+     */
+    constructor(type?: 0 | 1 | 2 | 3 | 4, start?: number, end?: number);
+}

package/src/LoopConfig.js

@@ -0,0 +1,86 @@
+/**
+ * @description LoopConfig クラスで、MovieClipのフレームヘッダーの移動方法を指定できます。
+ *              一度限りの再生や逆再生、フレーム固定などのアニメーションのループバリエーションを設定できます。
+ *
+ *              The LoopConfig class allows you to specify how the frame headers of a MovieClip are moved.
+ *              You can set up looping variations of the animation, such as one-time playback,
+ *              reverse playback, or fixed frame.
+ *
+ * @class
+ * @memberOf next2d.display
+ */
+export class LoopConfig {
+    /**
+     * @param {number} [type=0]
+     * @param {number} [start=1]
+     * @param {number} [end=0]
+     *
+     * @constructor
+     * @public
+     */
+    constructor(type = 0, start = 1, end = 0) {
+        /**
+         * @description LoopTypeクラスの固定値を利用して、ループのタイプを設定できます。
+         *              You can set the type of loop by using a fixed value in the LoopType class.
+         *
+         * @return  {number}
+         * @default 0
+         * @public
+         */
+        Object.defineProperty(this, "type", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description フレーム移動の開始値を設定します。逆再生時はここで設定した値が終了フレームとなります。
+         *              Sets the start value for frame shift. For reverse playback,
+         *              the value set here is the end frame.
+         *
+         * @return  {number}
+         * @default 1
+         * @public
+         */
+        Object.defineProperty(this, "start", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description フレーム移動の終了値を設定します。逆再生時はここで設定した値が開始フレームとなります。
+         *              Sets the end value of frame shift. For reverse playback,
+         *              the value set here is the start frame.
+         *
+         * @return  {number}
+         * @default 0
+         * @public
+         */
+        Object.defineProperty(this, "end", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description ループ設定の適用を開始するフレームの値、自動で設定されます。
+         *              The value of the frame at which to start applying the loop setting, set automatically.
+         *
+         * @return  {number}
+         * @default 1
+         * @readonly
+         * @public
+         */
+        Object.defineProperty(this, "frame", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.type = type;
+        this.start = start;
+        this.end = end;
+        this.frame = 1;
+    }
+}

package/src/LoopType.d.ts

@@ -0,0 +1,59 @@
+/**
+ * @description LoopType クラスは、MovieClipのフレームヘッダーの移動方法を指定する定数値の列挙です。
+ *              これらの定数は、LoopConfigで利用されます。
+ *
+ *              The LoopType class is an enumeration of constant values
+ *              that specify how to move the frame header of a MovieClip,
+ *              These constants are used by LoopConfig.
+ *
+ * @class
+ * @memberOf next2d.display
+ */
+export declare class LoopType {
+    /**
+     * @description ループ設定でリピート再生を使用することを指定します。
+     *              Specifies that repeat playback should be used in the loop settings.
+     *
+     * @return {number}
+     * @const
+     * @static
+     */
+    static get REPEAT(): number;
+    /**
+     * @description ループ設定で再生ヘッダーが指定した最終フレームに到達するとフレームを固定する設定を指定します。
+     *              Specifies the setting to fix frames when the playback header reaches the specified final frame in the loop settings.
+     *
+     * @return {number}
+     * @const
+     * @static
+     */
+    static get NO_REPEAT(): number;
+    /**
+     * @description ループ設定でフレームを固定する設定を指定します。
+     *              Specifies the setting for fixing frames in the loop setting.
+     *
+     * @return {number}
+     * @const
+     * @static
+     */
+    static get FIXED(): number;
+    /**
+     * @description ループ設定で再生ヘッダーが逆再生し、指定した開始フレームに到達するとフレームを固定する設定を指定します。
+     *              Specifies the setting where the playback header plays backwards in the loop setting
+     *              and fixes the frame when the specified start frame is reached.
+     *
+     * @return {number}
+     * @const
+     * @static
+     */
+    static get NO_REPEAT_REVERSAL(): number;
+    /**
+     * @description ループ設定でリピート逆再生を使用することを指定します。
+     *              Specifies the use of repeat reverse playback in the loop settings.
+     *
+     * @return {number}
+     * @const
+     * @static
+     */
+    static get REPEAT_REVERSAL(): number;
+}

package/src/LoopType.js

@@ -0,0 +1,69 @@
+/**
+ * @description LoopType クラスは、MovieClipのフレームヘッダーの移動方法を指定する定数値の列挙です。
+ *              これらの定数は、LoopConfigで利用されます。
+ *
+ *              The LoopType class is an enumeration of constant values
+ *              that specify how to move the frame header of a MovieClip,
+ *              These constants are used by LoopConfig.
+ *
+ * @class
+ * @memberOf next2d.display
+ */
+export class LoopType {
+    /**
+     * @description ループ設定でリピート再生を使用することを指定します。
+     *              Specifies that repeat playback should be used in the loop settings.
+     *
+     * @return {number}
+     * @const
+     * @static
+     */
+    static get REPEAT() {
+        return 0;
+    }
+    /**
+     * @description ループ設定で再生ヘッダーが指定した最終フレームに到達するとフレームを固定する設定を指定します。
+     *              Specifies the setting to fix frames when the playback header reaches the specified final frame in the loop settings.
+     *
+     * @return {number}
+     * @const
+     * @static
+     */
+    static get NO_REPEAT() {
+        return 1;
+    }
+    /**
+     * @description ループ設定でフレームを固定する設定を指定します。
+     *              Specifies the setting for fixing frames in the loop setting.
+     *
+     * @return {number}
+     * @const
+     * @static
+     */
+    static get FIXED() {
+        return 2;
+    }
+    /**
+     * @description ループ設定で再生ヘッダーが逆再生し、指定した開始フレームに到達するとフレームを固定する設定を指定します。
+     *              Specifies the setting where the playback header plays backwards in the loop setting
+     *              and fixes the frame when the specified start frame is reached.
+     *
+     * @return {number}
+     * @const
+     * @static
+     */
+    static get NO_REPEAT_REVERSAL() {
+        return 3;
+    }
+    /**
+     * @description ループ設定でリピート逆再生を使用することを指定します。
+     *              Specifies the use of repeat reverse playback in the loop settings.
+     *
+     * @return {number}
+     * @const
+     * @static
+     */
+    static get REPEAT_REVERSAL() {
+        return 4;
+    }
+}

package/src/MovieClip/service/MovieClipAddActionsService.d.ts

@@ -0,0 +1,12 @@
+import type { IMovieClipActionObject } from "../../interface/IMovieClipActionObject";
+/**
+ * @description 指定フレームに関数を追加
+ *              Add a function to the specified frame
+ *
+ * @param  {Map} actions
+ * @param  {array} objects
+ * @return {void}
+ * @method
+ * @public
+ */
+export declare const execute: (actions: Map<number, Function[]>, objects: IMovieClipActionObject[]) => void;

package/src/MovieClip/service/MovieClipAddActionsService.js

@@ -0,0 +1,27 @@
+import { $getArray } from "../../DisplayObjectUtil";
+/**
+ * @description 指定フレームに関数を追加
+ *              Add a function to the specified frame
+ *
+ * @param  {Map} actions
+ * @param  {array} objects
+ * @return {void}
+ * @method
+ * @public
+ */
+export const execute = (actions, objects) => {
+    for (let idx = 0; idx < objects.length; ++idx) {
+        const object = objects[idx];
+        if (!object) {
+            continue;
+        }
+        if (!object.script) {
+            object.script = Function(object.action);
+        }
+        const frame = object.frame;
+        if (!actions.has(frame)) {
+            actions.set(frame, $getArray());
+        }
+        actions.get(frame)?.push(object.script);
+    }
+};

package/src/MovieClip/service/MovieClipAddFrameLabelService.d.ts

@@ -0,0 +1,13 @@
+import type { FrameLabel } from "../../FrameLabel";
+import type { MovieClip } from "../../MovieClip";
+/**
+ * @description ラベル情報をマップに追加
+ *              Add label information to map
+ *
+ * @param  {MovieClip} movei_clip
+ * @param  {FrameLabel} frame_label
+ * @return {void}
+ * @method
+ * @protected
+ */
+export declare const execute: (movei_clip: MovieClip, frame_label: FrameLabel) => void;