@next2d/display 1.14.20

package/dist/DisplayObjectContainer.d.ts

@@ -0,0 +1,346 @@
+import { InteractiveObject } from "./InteractiveObject";
+import { DictionaryTagImpl, PlaceObjectImpl, DisplayObjectImpl, BoundsImpl, PreObjectImpl, PlayerHitObjectImpl } from "@next2d/interface";
+import { CanvasToWebGLContext } from "@next2d/webgl";
+/**
+ * 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 {
+    protected _$placeMap: Array<Array<number>> | null;
+    protected _$placeObjects: PlaceObjectImpl[] | null;
+    protected _$controller: Array<Array<number>> | null;
+    protected _$dictionary: DictionaryTagImpl[] | null;
+    protected readonly _$children: DisplayObjectImpl<any>[];
+    protected _$needsChildren: boolean;
+    protected _$mouseChildren: boolean;
+    protected _$wait: boolean;
+    protected readonly _$names: Map<string, DisplayObjectImpl<any>>;
+    /**
+     * @constructor
+     * @public
+     */
+    constructor();
+    /**
+     * @description オブジェクトの子がマウスまたはユーザー入力デバイスに対応しているかどうかを判断します。
+     *              Determine if the object's children are compatible with mouse or user input devices.
+     *
+     * @member {boolean}
+     * @public
+     */
+    get mouseChildren(): boolean;
+    set mouseChildren(mouse_children: boolean);
+    /**
+     * @description このオブジェクトの子の数を返します。
+     *              Returns the number of children of this object.
+     *
+     * @member   {number}
+     * @readonly
+     * @public
+     */
+    get numChildren(): number;
+    /**
+     * @description この DisplayObjectContainer インスタンスに子 DisplayObject インスタンスを追加します。
+     *              Adds a child DisplayObject instance to this DisplayObjectContainer instance.
+     *
+     * @param  {DisplayObject} child
+     * @return {DisplayObject}
+     * @method
+     * @public
+     */
+    addChild(child: DisplayObjectImpl<any>): DisplayObjectImpl<any>;
+    /**
+     * @description この DisplayObjectContainer インスタンスに子 DisplayObject インスタンスを追加します。
+     *              Adds a child DisplayObject instance to this DisplayObjectContainer instance.
+     *
+     * @param  {DisplayObject} child
+     * @param  {number}        index
+     * @return {DisplayObject}
+     * @method
+     * @public
+     */
+    addChildAt(child: DisplayObjectImpl<any>, index: number): DisplayObjectImpl<any>;
+    /**
+     * @description 指定された表示オブジェクトが、DisplayObjectContainer インスタンスの子であるか
+     *              インスタンス自体であるかを指定します。
+     *              Determines whether the specified display object is a child
+     *              of the DisplayObjectContainer instance or the instance itself.
+     *
+     * @param  {DisplayObject} child
+     * @return {boolean}
+     * @method
+     * @public
+     */
+    contains(child: DisplayObjectImpl<any>): boolean;
+    /**
+     * @description 指定のインデックス位置にある子表示オブジェクトインスタンスを返します。
+     *              Returns the child display object instance that exists at the specified index.
+     *
+     * @param  {number} index
+     * @return {DisplayObject}
+     * @method
+     * @public
+     */
+    getChildAt(index: number): DisplayObjectImpl<any>;
+    /**
+     * @description 指定された名前に一致する子表示オブジェクトを返します。
+     *              Returns the child display object that exists with the specified name.
+     *
+     * @param  {string} name
+     * @return {{DisplayObject}|null}
+     * @method
+     * @public
+     */
+    getChildByName(name: string): DisplayObjectImpl<any> | null;
+    /**
+     * @description 子 DisplayObject インスタンスのインデックス位置を返します。
+     *              Returns the index position of a child DisplayObject instance.
+     *
+     * @param  {DisplayObject} child
+     * @return {number}
+     * @method
+     * @public
+     */
+    getChildIndex(child: DisplayObjectImpl<any>): number;
+    /**
+     * @description DisplayObjectContainer インスタンスの子リストから指定の
+     *              child DisplayObject インスタンスを削除します。
+     *              Removes the specified child DisplayObject instance from the
+     *              child list of the DisplayObjectContainer instance.
+     *
+     * @param  {DisplayObject} child
+     * @return {DisplayObject}
+     * @method
+     * @public
+     */
+    removeChild(child: DisplayObjectImpl<any>): DisplayObjectImpl<any>;
+    /**
+     * @description DisplayObjectContainer の子リストの指定された index 位置から子 DisplayObject を削除します。
+     *              Removes a child DisplayObject from the specified index position
+     *              in the child list of the DisplayObjectContainer.
+     *
+     * @param  {number} index
+     * @return {DisplayObject}
+     * @method
+     * @public
+     */
+    removeChildAt(index: number): DisplayObjectImpl<any>;
+    /**
+     * @description DisplayObjectContainer インスタンスの子リストから
+     *              すべての child DisplayObject インスタンスを削除します。
+     *              Removes all child DisplayObject instances from
+     *              the child list of the DisplayObjectContainer instance.
+     *
+     * @param  {number} [begin_index=0]
+     * @param  {number} [end_index=0x7fffffff]
+     * @return {void}
+     * @method
+     * @public
+     */
+    removeChildren(begin_index?: number, end_index?: number): void;
+    /**
+     * @description 表示オブジェクトコンテナの既存の子の位置を変更します。
+     *              Changes the position of an existing child in the display object container.
+     *
+     * @param  {DisplayObject} child
+     * @param  {number} index
+     * @return {void}
+     * @method
+     * @public
+     */
+    setChildIndex(child: DisplayObjectImpl<any>, index: number): void;
+    /**
+     * @description 指定された 2 つの子オブジェクトの z 順序（重ね順）を入れ替えます。
+     *              Swaps the z-order (front-to-back order) of the two specified child objects.
+     *
+     * @param  {DisplayObject} child1
+     * @param  {DisplayObject} child2
+     * @return {void}
+     * @method
+     * @public
+     */
+    swapChildren(child1: DisplayObjectImpl<any>, child2: DisplayObjectImpl<any>): 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;
+    /**
+     * @param  {array} [matrix=null]
+     * @return {object}
+     * @private
+     */
+    _$getBounds(matrix?: Float32Array | null): BoundsImpl;
+    /**
+     * @param  {array} [matrix=null]
+     * @return {object}
+     * @private
+     */
+    _$getLayerBounds(matrix?: Float32Array | null): BoundsImpl;
+    /**
+     * @return {array}
+     * @private
+     */
+    _$getChildren(): DisplayObjectImpl<any>[];
+    /**
+     * @return void
+     * @private
+     */
+    _$clearChildren(): void;
+    /**
+     * @param   {DisplayObject} child
+     * @returns {DisplayObject}
+     * @private
+     */
+    _$addChild(child: DisplayObjectImpl<any>): DisplayObjectImpl<any>;
+    /**
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$setParentAndStage(): void;
+    /**
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$executeAddedToStage(): void;
+    /**
+     * @param  {DisplayObject} child
+     * @param  {boolean} do_event
+     * @return {DisplayObject}
+     * @private
+     */
+    _$remove(child: DisplayObjectImpl<any>, do_event?: boolean): DisplayObjectImpl<any>;
+    /**
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$executeRemovedFromStage(): void;
+    /**
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$removeParentAndStage(): void;
+    /**
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$prepareActions(): void;
+    /**
+     * @return {boolean}
+     * @method
+     * @private
+     */
+    _$nextFrame(): boolean;
+    /**
+     * @param  {CanvasToWebGLContext} context
+     * @param  {Float32Array} matrix
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$clip(context: CanvasToWebGLContext, matrix: Float32Array): void;
+    /**
+     * @param  {CanvasToWebGLContext} context
+     * @param  {Float32Array} matrix
+     * @return {object}
+     * @private
+     */
+    _$preDraw(context: CanvasToWebGLContext, matrix: Float32Array): PreObjectImpl | null;
+    /**
+     * @param  {CanvasToWebGLContext} context
+     * @param  {Float32Array} matrix
+     * @param  {Float32Array} color_transform
+     * @param  {object} object
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$postDraw(context: CanvasToWebGLContext, matrix: Float32Array, color_transform: Float32Array, object: PreObjectImpl): void;
+    /**
+     * @param  {CanvasToWebGLContext} context
+     * @param  {Float32Array} matrix
+     * @param  {Float32Array} color_transform
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$draw(context: CanvasToWebGLContext, matrix: Float32Array, color_transform: Float32Array): void;
+    /**
+     * @param  {CanvasRenderingContext2D} context
+     * @param  {Float32Array} matrix
+     * @param  {object} options
+     * @param  {boolean} [mouse_children=true]
+     * @return {boolean}
+     * @method
+     * @private
+     */
+    _$mouseHit(context: CanvasRenderingContext2D, matrix: Float32Array, options: PlayerHitObjectImpl, mouse_children?: boolean): boolean;
+    /**
+     * @param  {CanvasRenderingContext2D} context
+     * @param  {Float32Array} matrix
+     * @param  {object}  options
+     * @param  {boolean} [is_clip=false]
+     * @return {boolean}
+     * @method
+     * @private
+     */
+    _$hit(context: CanvasRenderingContext2D, matrix: Float32Array, options: PlayerHitObjectImpl, is_clip?: boolean): boolean;
+    /**
+     * @param  {number} index
+     * @return {DisplayObject}
+     * @method
+     * @private
+     */
+    _$createInstance(index: number): DisplayObjectImpl<any>;
+    /**
+     * @param  {number} x
+     * @param  {number} y
+     * @return {boolean}
+     * @method
+     * @private
+     */
+    _$outCheck(x: number, y: number): boolean;
+    /**
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$createWorkerInstance(): void;
+    /**
+     * @return {object}
+     * @method
+     * @private
+     */
+    _$postProperty(): void;
+    /**
+     * @param  {array} [childrenIds=null]
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$postChildrenIds(childrenIds?: number[] | null): void;
+}