@next2d/display 1.18.12 → 2.0.0

package/src/DisplayObjectContainer/usecase/DisplayObjectContainerSetChildIndexUseCase.js

@@ -0,0 +1,22 @@
+import { execute as displayObjectApplyChangesService } from "../../DisplayObject/service/DisplayObjectApplyChangesService";
+/**
+ * @description 指定されたインデックスに子を移動します
+ *              Moves the child to the specified index
+ *
+ * @param  {DisplayObjectContainer} display_object_container
+ * @param  {DisplayObject} display_object
+ * @param  {number} index
+ * @return {void}
+ * @method
+ * @protected
+ */
+export const execute = (display_object_container, display_object, index) => {
+    const currentIndex = display_object_container.getChildIndex(display_object);
+    if (currentIndex === -1 || currentIndex === index) {
+        return;
+    }
+    const children = display_object_container.children;
+    children.splice(currentIndex, 1);
+    children.splice(index, 0, display_object);
+    displayObjectApplyChangesService(display_object_container);
+};

package/src/DisplayObjectContainer/usecase/DisplayObjectContainerSwapChildrenAtUseCase.d.ts

@@ -0,0 +1,13 @@
+import type { DisplayObjectContainer } from "../../DisplayObjectContainer";
+/**
+ * @description 子リスト内の指定されたインデックス位置に該当する 2 つの子オブジェクトの z 順序（重ね順）を入れ替えます。
+ *              Swaps the z-order (front-to-back order) of the child objects at
+ *              the two specified index positions in the child list.
+ * @param {DisplayObjectContainer} display_object_container
+ * @param {number} index1
+ * @param {number} index2
+ * @return {void}
+ * @method
+ * @protected
+ */
+export declare const execute: <C extends DisplayObjectContainer>(display_object_container: C, index1: number, index2: number) => void;

package/src/DisplayObjectContainer/usecase/DisplayObjectContainerSwapChildrenAtUseCase.js

@@ -0,0 +1,23 @@
+import { execute as displayObjectApplyChangesService } from "../../DisplayObject/service/DisplayObjectApplyChangesService";
+/**
+ * @description 子リスト内の指定されたインデックス位置に該当する 2 つの子オブジェクトの z 順序（重ね順）を入れ替えます。
+ *              Swaps the z-order (front-to-back order) of the child objects at
+ *              the two specified index positions in the child list.
+ * @param {DisplayObjectContainer} display_object_container
+ * @param {number} index1
+ * @param {number} index2
+ * @return {void}
+ * @method
+ * @protected
+ */
+export const execute = (display_object_container, index1, index2) => {
+    const children = display_object_container.children;
+    const displayObject1 = children[index1];
+    const displayObject2 = children[index2];
+    if (!displayObject1 || !displayObject2) {
+        return;
+    }
+    children[index1] = displayObject2;
+    children[index2] = displayObject1;
+    displayObjectApplyChangesService(display_object_container);
+};

package/src/DisplayObjectContainer/usecase/DisplayObjectContainerSwapChildrenUseCase.d.ts

@@ -0,0 +1,14 @@
+import type { DisplayObject } from "../../DisplayObject";
+import type { DisplayObjectContainer } from "../../DisplayObjectContainer";
+/**
+ * @description 指定された2つの子の表示順を入れ替えます
+ *              Swaps the display order of the two specified children
+ *
+ * @param  {DisplayObjectContainer} display_object_container
+ * @param  {DisplayObject} display_object1
+ * @param  {DisplayObject} display_object2
+ * @return {void}
+ * @method
+ * @protected
+ */
+export declare const execute: <C extends DisplayObjectContainer, D extends DisplayObject>(display_object_container: C, display_object1: D, display_object2: D) => void;

package/src/DisplayObjectContainer/usecase/DisplayObjectContainerSwapChildrenUseCase.js

@@ -0,0 +1,23 @@
+import { execute as displayObjectApplyChangesService } from "../../DisplayObject/service/DisplayObjectApplyChangesService";
+/**
+ * @description 指定された2つの子の表示順を入れ替えます
+ *              Swaps the display order of the two specified children
+ *
+ * @param  {DisplayObjectContainer} display_object_container
+ * @param  {DisplayObject} display_object1
+ * @param  {DisplayObject} display_object2
+ * @return {void}
+ * @method
+ * @protected
+ */
+export const execute = (display_object_container, display_object1, display_object2) => {
+    const index1 = display_object_container.getChildIndex(display_object1);
+    const index2 = display_object_container.getChildIndex(display_object2);
+    if (index1 === -1 || index2 === -1) {
+        return;
+    }
+    const children = display_object_container.children;
+    children[index1] = display_object2;
+    children[index2] = display_object1;
+    displayObjectApplyChangesService(display_object_container);
+};

package/src/DisplayObjectContainer.d.ts

@@ -0,0 +1,229 @@
+import type { DisplayObject } from "./DisplayObject";
+import type { IDisplayObject } from "./interface/IDisplayObject";
+import type { IParent } from "./interface/IParent";
+import { InteractiveObject } from "./InteractiveObject";
+/**
+ * @description DisplayObjectContainer クラスは、表示リストで表示オブジェクトコンテナとして機能するすべてのオブジェクトの基本クラスです。
+ *              このクラス自体は、画面上でのコンテンツの描画のための API を含みません。
+ *              そのため、DisplayObject クラスのカスタムサブクラスを作成する場合は、
+ *              Sprite、または MovieClip など、画面上にコンテンツを描画する API を持つサブクラスの 1 つを拡張する必要があります。
+ *
+ *              The DisplayObjectContainer class is the base class for all objects that can serve
+ *              as display object containers on the display list.
+ *              This class itself does not contain any API for drawing content on the screen.
+ *              Therefore, if you want to create a custom subclass of the DisplayObject class,
+ *              you need to extend one of its subclasses that has an API for drawing content on the screen,
+ *              such as Sprite or MovieClip.
+ *
+ * @class
+ * @memberOf next2d.display
+ * @extends  InteractiveObject
+ */
+export declare class DisplayObjectContainer extends InteractiveObject {
+    /**
+     * @description 描画対象となるDisplayObjectの配列です。
+     *              An array of DisplayObjects to be drawn.
+     *
+     * @type {array}
+     * @readonly
+     * @private
+     */
+    protected readonly _$children: IDisplayObject<any>[];
+    /**
+     * @description セットされてるDisplayObjectがマスクとして使用されます。
+     *              The DisplayObject set is used as a mask.
+     *
+     * @type {IDisplayObject<any>|null}
+     * @default null
+     * @private
+     */
+    private _$mask;
+    /**
+     * @description オブジェクトの子がマウスまたはユーザー入力デバイスに対応しているかどうかを判断します。
+     *              Determine if the object's children are compatible with mouse or user input devices.
+     *
+     * @type {boolean}
+     * @default true
+     * @public
+     */
+    mouseChildren: boolean;
+    /**
+     * @description このコンテナ何にセットされているコンテナだけの配列
+     *              An array of containers set in this container
+     *
+     * @type {IParent<any>[] | null}
+     * @public
+     */
+    $container: IParent<any>[] | null;
+    /**
+     * @description コンテナの機能を所持しているかを返却
+     *              Returns whether the display object has container functionality.
+     *
+     * @type {boolean}
+     * @readonly
+     * @public
+     */
+    readonly isContainerEnabled: boolean;
+    /**
+     * @constructor
+     * @public
+     */
+    constructor();
+    /**
+     * @description コンテナのアクティブな子要素を返却
+     *              Returns the active child elements of the container.
+     *
+     * @return {array}
+     * @method
+     * @protected
+     */
+    get children(): IDisplayObject<any>[];
+    /**
+     * @description このオブジェクトの子の数を返します。
+     *              Returns the number of children of this object.
+     *
+     * @member   {number}
+     * @readonly
+     * @public
+     */
+    get numChildren(): number;
+    /**
+     * @description 呼び出し元の表示オブジェクトは、指定された mask オブジェクトによってマスクされます。
+     *              The calling display object is masked by the specified mask object.
+     *
+     * @member {DisplayObject|null}
+     * @public
+     */
+    get mask(): IDisplayObject<any> | null;
+    set mask(mask: IDisplayObject<any> | null);
+    /**
+     * @description この DisplayObjectContainer インスタンスに子 DisplayObject インスタンスを追加します。
+     *              Adds a child DisplayObject instance to this DisplayObjectContainer instance.
+     *
+     * @param  {DisplayObject} display_object
+     * @return {DisplayObject}
+     * @method
+     * @public
+     */
+    addChild<D extends DisplayObject>(display_object: D): D;
+    /**
+     * @description この DisplayObjectContainer インスタンスに子 DisplayObject インスタンスを追加します。
+     *              Adds a child DisplayObject instance to this DisplayObjectContainer instance.
+     *
+     * @param  {DisplayObject} display_object
+     * @param  {number}        index
+     * @return {DisplayObject}
+     * @method
+     * @public
+     */
+    addChildAt<D extends DisplayObject>(display_object: D, index: number): D;
+    /**
+     * @description 指定された DisplayObject が、DisplayObjectContainer インスタンスの子孫であるか
+     *              もしくは、インスタンス自体であるかを指定します。
+     *              Whether the specified DisplayObject is a descendant of a DisplayObjectContainer instance.
+     *              or the instance itself.
+     *
+     * @param  {DisplayObject} display_object
+     * @return {boolean}
+     * @method
+     * @public
+     */
+    contains<D extends DisplayObject>(display_object: D): boolean;
+    /**
+     * @description 指定のインデックス位置にある子表示オブジェクトインスタンスを返します。
+     *              Returns the child display object instance that exists at the specified index.
+     *
+     * @param  {number} index
+     * @return {DisplayObject}
+     * @method
+     * @public
+     */
+    getChildAt<D extends DisplayObject>(index: number): D | null;
+    /**
+     * @description 指定された名前に一致する子表示オブジェクトを返します。
+     *              Returns the child display object that exists with the specified name.
+     *
+     * @param  {string} name
+     * @return {{DisplayObject}|null}
+     * @method
+     * @public
+     */
+    getChildByName<D extends DisplayObject>(name: string): D | null;
+    /**
+     * @description 子 DisplayObject インスタンスのインデックス位置を返します。
+     *              Returns the index position of a child DisplayObject instance.
+     *
+     * @param  {DisplayObject} display_object
+     * @return {number}
+     * @method
+     * @public
+     */
+    getChildIndex<D extends DisplayObject>(display_object: D): number;
+    /**
+     * @description DisplayObjectContainer インスタンスの子リストから指定の
+     *              child DisplayObject インスタンスを削除します。
+     *              Removes the specified child DisplayObject instance from the
+     *              child list of the DisplayObjectContainer instance.
+     *
+     * @param  {DisplayObject} display_object
+     * @return {void}
+     * @method
+     * @public
+     */
+    removeChild<D extends DisplayObject>(display_object: D): void;
+    /**
+     * @description DisplayObjectContainer の子リストの指定された index 位置から子 DisplayObject を削除します。
+     *              Removes a child DisplayObject from the specified index position
+     *              in the child list of the DisplayObjectContainer.
+     *
+     * @param  {number} index
+     * @return {void}
+     * @method
+     * @public
+     */
+    removeChildAt(index: number): void;
+    /**
+     * @description 配列で指定されたインデックスの子をコンテナから削除します
+     *              Removes children of the index specified in the array from the container
+     *
+     * @param  {number[]} indexes
+     * @return {void}
+     * @method
+     * @public
+     */
+    removeChildren(...indexes: number[]): void;
+    /**
+     * @description 表示オブジェクトコンテナの既存の子の位置を変更します。
+     *              Changes the position of an existing child in the display object container.
+     *
+     * @param  {DisplayObject} display_object
+     * @param  {number} index
+     * @return {void}
+     * @method
+     * @public
+     */
+    setChildIndex<D extends DisplayObject>(display_object: D, index: number): void;
+    /**
+     * @description 指定された 2 つの子オブジェクトの z 順序（重ね順）を入れ替えます。
+     *              Swaps the z-order (front-to-back order) of the two specified child objects.
+     *
+     * @param  {DisplayObject} display_object1
+     * @param  {DisplayObject} display_object2
+     * @return {void}
+     * @method
+     * @public
+     */
+    swapChildren<D extends DisplayObject>(display_object1: D, display_object2: D): void;
+    /**
+     * @description 子リスト内の指定されたインデックス位置に該当する 2 つの子オブジェクトの z 順序（重ね順）を入れ替えます。
+     *              Swaps the z-order (front-to-back order) of the child objects at
+     *              the two specified index positions in the child list.
+     *
+     * @param  {number} index1
+     * @param  {number} index2
+     * @return {void}
+     * @method
+     * @public
+     */
+    swapChildrenAt(index1: number, index2: number): void;
+}

package/src/DisplayObjectContainer.js

@@ -0,0 +1,317 @@
+import { execute as displayObjectApplyChangesService } from "./DisplayObject/service/DisplayObjectApplyChangesService";
+import { execute as displayObjectContainerAddChildUseCase } from "./DisplayObjectContainer/usecase/DisplayObjectContainerAddChildUseCase";
+import { execute as displayObjectContainerRemoveChildUseCase } from "./DisplayObjectContainer/usecase/DisplayObjectContainerRemoveChildUseCase";
+import { execute as displayObjectContainerRemoveChildAtUseCase } from "./DisplayObjectContainer/usecase/DisplayObjectContainerRemoveChildAtUseCase";
+import { execute as displayObjectContainerGetChildAtService } from "./DisplayObjectContainer/service/DisplayObjectContainerGetChildAtService";
+import { execute as displayObjectContainerContainsService } from "./DisplayObjectContainer/service/DisplayObjectContainerContainsService";
+import { execute as displayObjectContainerGetChildByNameService } from "./DisplayObjectContainer/service/DisplayObjectContainerGetChildByNameService";
+import { execute as displayObjectContainerRemoveChildrenUseCase } from "./DisplayObjectContainer/usecase/DisplayObjectContainerRemoveChildrenUseCase";
+import { execute as displayObjectContainerSetChildIndexUseCase } from "./DisplayObjectContainer/usecase/DisplayObjectContainerSetChildIndexUseCase";
+import { execute as displayObjectContainerSwapChildrenUseCase } from "./DisplayObjectContainer/usecase/DisplayObjectContainerSwapChildrenUseCase";
+import { execute as displayObjectContainerSwapChildrenAtUseCase } from "./DisplayObjectContainer/usecase/DisplayObjectContainerSwapChildrenAtUseCase";
+import { $getArray } from "./DisplayObjectUtil";
+import { InteractiveObject } from "./InteractiveObject";
+/**
+ * @description DisplayObjectContainer クラスは、表示リストで表示オブジェクトコンテナとして機能するすべてのオブジェクトの基本クラスです。
+ *              このクラス自体は、画面上でのコンテンツの描画のための API を含みません。
+ *              そのため、DisplayObject クラスのカスタムサブクラスを作成する場合は、
+ *              Sprite、または MovieClip など、画面上にコンテンツを描画する API を持つサブクラスの 1 つを拡張する必要があります。
+ *
+ *              The DisplayObjectContainer class is the base class for all objects that can serve
+ *              as display object containers on the display list.
+ *              This class itself does not contain any API for drawing content on the screen.
+ *              Therefore, if you want to create a custom subclass of the DisplayObject class,
+ *              you need to extend one of its subclasses that has an API for drawing content on the screen,
+ *              such as Sprite or MovieClip.
+ *
+ * @class
+ * @memberOf next2d.display
+ * @extends  InteractiveObject
+ */
+export class DisplayObjectContainer extends InteractiveObject {
+    /**
+     * @constructor
+     * @public
+     */
+    constructor() {
+        super();
+        /**
+         * @description 描画対象となるDisplayObjectの配列です。
+         *              An array of DisplayObjects to be drawn.
+         *
+         * @type {array}
+         * @readonly
+         * @private
+         */
+        Object.defineProperty(this, "_$children", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description セットされてるDisplayObjectがマスクとして使用されます。
+         *              The DisplayObject set is used as a mask.
+         *
+         * @type {IDisplayObject<any>|null}
+         * @default null
+         * @private
+         */
+        Object.defineProperty(this, "_$mask", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description オブジェクトの子がマウスまたはユーザー入力デバイスに対応しているかどうかを判断します。
+         *              Determine if the object's children are compatible with mouse or user input devices.
+         *
+         * @type {boolean}
+         * @default true
+         * @public
+         */
+        Object.defineProperty(this, "mouseChildren", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description このコンテナ何にセットされているコンテナだけの配列
+         *              An array of containers set in this container
+         *
+         * @type {IParent<any>[] | null}
+         * @public
+         */
+        Object.defineProperty(this, "$container", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description コンテナの機能を所持しているかを返却
+         *              Returns whether the display object has container functionality.
+         *
+         * @type {boolean}
+         * @readonly
+         * @public
+         */
+        Object.defineProperty(this, "isContainerEnabled", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        // public
+        this.isContainerEnabled = true;
+        this.mouseChildren = true;
+        // private
+        this._$mask = null;
+        this._$children = $getArray();
+        // protected
+        this.$container = null;
+    }
+    /**
+     * @description コンテナのアクティブな子要素を返却
+     *              Returns the active child elements of the container.
+     *
+     * @return {array}
+     * @method
+     * @protected
+     */
+    get children() {
+        return this._$children;
+    }
+    /**
+     * @description このオブジェクトの子の数を返します。
+     *              Returns the number of children of this object.
+     *
+     * @member   {number}
+     * @readonly
+     * @public
+     */
+    get numChildren() {
+        return this.children.length;
+    }
+    /**
+     * @description 呼び出し元の表示オブジェクトは、指定された mask オブジェクトによってマスクされます。
+     *              The calling display object is masked by the specified mask object.
+     *
+     * @member {DisplayObject|null}
+     * @public
+     */
+    get mask() {
+        return this._$mask;
+    }
+    set mask(mask) {
+        if (mask === this._$mask) {
+            return;
+        }
+        // 初期化
+        if (this._$mask) {
+            this._$mask.isMask = false;
+            this._$mask = null;
+        }
+        if (mask) {
+            mask.isMask = true;
+            this._$mask = mask;
+        }
+        displayObjectApplyChangesService(this);
+    }
+    /**
+     * @description この DisplayObjectContainer インスタンスに子 DisplayObject インスタンスを追加します。
+     *              Adds a child DisplayObject instance to this DisplayObjectContainer instance.
+     *
+     * @param  {DisplayObject} display_object
+     * @return {DisplayObject}
+     * @method
+     * @public
+     */
+    addChild(display_object) {
+        return displayObjectContainerAddChildUseCase(this, display_object);
+    }
+    /**
+     * @description この DisplayObjectContainer インスタンスに子 DisplayObject インスタンスを追加します。
+     *              Adds a child DisplayObject instance to this DisplayObjectContainer instance.
+     *
+     * @param  {DisplayObject} display_object
+     * @param  {number}        index
+     * @return {DisplayObject}
+     * @method
+     * @public
+     */
+    addChildAt(display_object, index) {
+        return displayObjectContainerAddChildUseCase(this, display_object, index);
+    }
+    /**
+     * @description 指定された DisplayObject が、DisplayObjectContainer インスタンスの子孫であるか
+     *              もしくは、インスタンス自体であるかを指定します。
+     *              Whether the specified DisplayObject is a descendant of a DisplayObjectContainer instance.
+     *              or the instance itself.
+     *
+     * @param  {DisplayObject} display_object
+     * @return {boolean}
+     * @method
+     * @public
+     */
+    contains(display_object) {
+        return displayObjectContainerContainsService(this, display_object);
+    }
+    /**
+     * @description 指定のインデックス位置にある子表示オブジェクトインスタンスを返します。
+     *              Returns the child display object instance that exists at the specified index.
+     *
+     * @param  {number} index
+     * @return {DisplayObject}
+     * @method
+     * @public
+     */
+    getChildAt(index) {
+        return displayObjectContainerGetChildAtService(this, index);
+    }
+    /**
+     * @description 指定された名前に一致する子表示オブジェクトを返します。
+     *              Returns the child display object that exists with the specified name.
+     *
+     * @param  {string} name
+     * @return {{DisplayObject}|null}
+     * @method
+     * @public
+     */
+    getChildByName(name) {
+        return displayObjectContainerGetChildByNameService(this, name);
+    }
+    /**
+     * @description 子 DisplayObject インスタンスのインデックス位置を返します。
+     *              Returns the index position of a child DisplayObject instance.
+     *
+     * @param  {DisplayObject} display_object
+     * @return {number}
+     * @method
+     * @public
+     */
+    getChildIndex(display_object) {
+        return this.children.indexOf(display_object);
+    }
+    /**
+     * @description DisplayObjectContainer インスタンスの子リストから指定の
+     *              child DisplayObject インスタンスを削除します。
+     *              Removes the specified child DisplayObject instance from the
+     *              child list of the DisplayObjectContainer instance.
+     *
+     * @param  {DisplayObject} display_object
+     * @return {void}
+     * @method
+     * @public
+     */
+    removeChild(display_object) {
+        displayObjectContainerRemoveChildUseCase(this, display_object);
+    }
+    /**
+     * @description DisplayObjectContainer の子リストの指定された index 位置から子 DisplayObject を削除します。
+     *              Removes a child DisplayObject from the specified index position
+     *              in the child list of the DisplayObjectContainer.
+     *
+     * @param  {number} index
+     * @return {void}
+     * @method
+     * @public
+     */
+    removeChildAt(index) {
+        displayObjectContainerRemoveChildAtUseCase(this, index);
+    }
+    /**
+     * @description 配列で指定されたインデックスの子をコンテナから削除します
+     *              Removes children of the index specified in the array from the container
+     *
+     * @param  {number[]} indexes
+     * @return {void}
+     * @method
+     * @public
+     */
+    removeChildren(...indexes) {
+        displayObjectContainerRemoveChildrenUseCase(this, indexes);
+    }
+    /**
+     * @description 表示オブジェクトコンテナの既存の子の位置を変更します。
+     *              Changes the position of an existing child in the display object container.
+     *
+     * @param  {DisplayObject} display_object
+     * @param  {number} index
+     * @return {void}
+     * @method
+     * @public
+     */
+    setChildIndex(display_object, index) {
+        displayObjectContainerSetChildIndexUseCase(this, display_object, index);
+    }
+    /**
+     * @description 指定された 2 つの子オブジェクトの z 順序（重ね順）を入れ替えます。
+     *              Swaps the z-order (front-to-back order) of the two specified child objects.
+     *
+     * @param  {DisplayObject} display_object1
+     * @param  {DisplayObject} display_object2
+     * @return {void}
+     * @method
+     * @public
+     */
+    swapChildren(display_object1, display_object2) {
+        displayObjectContainerSwapChildrenUseCase(this, display_object1, display_object2);
+    }
+    /**
+     * @description 子リスト内の指定されたインデックス位置に該当する 2 つの子オブジェクトの z 順序（重ね順）を入れ替えます。
+     *              Swaps the z-order (front-to-back order) of the child objects at
+     *              the two specified index positions in the child list.
+     *
+     * @param  {number} index1
+     * @param  {number} index2
+     * @return {void}
+     * @method
+     * @public
+     */
+    swapChildrenAt(index1, index2) {
+        displayObjectContainerSwapChildrenAtUseCase(this, index1, index2);
+    }
+}