@next2d/player 1.14.7 → 1.14.8

package/dist/player/next2d/display/DisplayObject.d.ts

@@ -0,0 +1,571 @@
+import { EventDispatcher } from "../events/EventDispatcher";
+import { Transform } from "../geom/Transform";
+import { Rectangle } from "../geom/Rectangle";
+import { Point } from "../geom/Point";
+import type { Stage } from "./Stage";
+import type { LoaderInfo } from "./LoaderInfo";
+import type { Sprite } from "./Sprite";
+import type { FilterArrayImpl } from "../../../interface/FilterArrayImpl";
+import type { BlendModeImpl } from "../../../interface/BlendModeImpl";
+import type { ParentImpl } from "../../../interface/ParentImpl";
+import type { PlaceObjectImpl } from "../../../interface/PlaceObjectImpl";
+import type { BoundsImpl } from "../../../interface/BoundsImpl";
+import type { DictionaryTagImpl } from "../../../interface/DictionaryTagImpl";
+import type { PropertyMessageMapImpl } from "../../../interface/PropertyMessageMapImpl";
+import type { CanvasToWebGLContext } from "../../../webgl/CanvasToWebGLContext";
+import type { DisplayObjectImpl } from "../../../interface/DisplayObjectImpl";
+/**
+ * DisplayObject クラスは、表示リストに含めることのできるすべてのオブジェクトに関する基本クラスです。
+ * DisplayObject クラス自体は、画面上でのコンテンツの描画のための API を含みません。
+ * そのため、DisplayObject クラスのカスタムサブクラスを作成する場合は、
+ * Shape、Sprite、Bitmap、TextField または MovieClip など、
+ * 画面上にコンテンツを描画する API を持つサブクラスの 1 つを拡張する必要があります。
+ *
+ * The DisplayObject class is the base class for all objects that can be placed on the display list.
+ * The DisplayObject class itself does not include any APIs for rendering content onscreen.
+ * For that reason, if you want create a custom subclass of the DisplayObject class,
+ * you will want to extend one of its subclasses that do have APIs for rendering content onscreen,
+ * such as the Shape, Sprite, Bitmap, TextField, or MovieClip class.
+ *
+ * @class
+ * @memberOf next2d.display
+ * @extends  EventDispatcher
+ */
+export declare class DisplayObject extends EventDispatcher {
+    readonly _$instanceId: number;
+    protected _$id: number;
+    protected _$stage: Stage | null;
+    protected _$parent: ParentImpl<any> | null;
+    protected _$scale9Grid: Rectangle | null;
+    protected _$characterId: number;
+    protected _$active: boolean;
+    protected _$isMask: boolean;
+    _$updated: boolean;
+    protected _$added: boolean;
+    protected _$addedStage: boolean;
+    protected _$filters: FilterArrayImpl | null;
+    protected _$blendMode: BlendModeImpl | null;
+    protected _$transform: Transform;
+    _$hitObject: Sprite | null;
+    protected _$isNext: boolean;
+    protected _$created: boolean;
+    protected _$posted: boolean;
+    protected _$clipDepth: number;
+    protected _$name: string;
+    protected _$mask: DisplayObjectImpl<any> | null;
+    protected _$visible: boolean;
+    protected _$root: ParentImpl<any> | null;
+    _$loaderInfo: LoaderInfo | null;
+    protected _$scaleX: number | null;
+    protected _$scaleY: number | null;
+    protected _$variables: Map<any, any> | null;
+    protected _$placeObject: PlaceObjectImpl | null;
+    protected _$rotation: number | null;
+    protected _$changePlace: boolean;
+    protected _$currentPlaceId: number;
+    protected _$placeId: number;
+    protected _$startFrame: number;
+    protected _$endFrame: number;
+    /**
+     * @constructor
+     * @public
+     */
+    constructor();
+    /**
+     * @description 指定されたオブジェクトのアルファ透明度値を示します。
+     *              有効な値は 0.0（完全な透明）～ 1.0（完全な不透明）です。
+     *              デフォルト値は 1.0 です。alpha が 0.0 に設定されている表示オブジェクトは、
+     *              表示されない場合でも、アクティブです。
+     *              Indicates the alpha transparency value of the object specified.
+     *              Valid values are 0.0 (fully transparent) to 1.0 (fully opaque).
+     *              The default value is 1.0. Display objects with alpha set to 0.0 are active,
+     *              even though they are invisible.
+     *
+     * @member  {number}
+     * @default 1
+     * @public
+     */
+    get alpha(): number;
+    set alpha(alpha: number);
+    /**
+     * @description 使用するブレンドモードを指定する BlendMode クラスの値です。
+     *              A value from the BlendMode class that specifies which blend mode to use.
+     *
+     * @member  {string}
+     * @default BlendMode.NORMAL
+     * @public
+     */
+    get blendMode(): BlendModeImpl;
+    set blendMode(blend_mode: BlendModeImpl);
+    /**
+     * @description 表示オブジェクトに現在関連付けられている各フィルターオブジェクトが
+     *              格納されているインデックス付きの配列です。
+     *              An indexed array that contains each filter object
+     *              currently associated with the display object.
+     *
+     * @member  {array}
+     * @default {array}
+     * @public
+     */
+    get filters(): FilterArrayImpl;
+    set filters(filters: FilterArrayImpl | null);
+    /**
+     * @description 表示オブジェクトの高さを示します（ピクセル単位）。
+     *              Indicates the height of the display object, in pixels.
+     *
+     * @member {number}
+     * @public
+     */
+    get height(): number;
+    set height(height: number);
+    /**
+     * @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 | null;
+    /**
+     * @description 呼び出し元の表示オブジェクトは、指定された mask オブジェクトによってマスクされます。
+     *              The calling display object is masked by the specified mask object.
+     *
+     * @member {DisplayObject|null}
+     * @public
+     */
+    get mask(): DisplayObjectImpl<any> | null;
+    set mask(mask: DisplayObjectImpl<any> | null);
+    /**
+     * @description マウスまたはユーザー入力デバイスの x 軸の位置をピクセルで示します。
+     *              Indicates the x coordinate of the mouse or user input device position, in pixels.
+     *
+     * @member  {number}
+     * @default 0
+     * @readonly
+     * @public
+     */
+    get mouseX(): number;
+    /**
+     * @description マウスまたはユーザー入力デバイスの y 軸の位置をピクセルで示します。
+     *              Indicates the y coordinate of the mouse or user input device position, in pixels.
+     *
+     * @member  {number}
+     * @default 0
+     * @readonly
+     * @public
+     */
+    get mouseY(): number;
+    /**
+     * @description DisplayObject のインスタンス名を示します。
+     *              Indicates the instance name of the DisplayObject.
+     *
+     * @member {string}
+     * @public
+     */
+    get name(): string;
+    set name(name: string);
+    /**
+     * @description この表示オブジェクトを含む DisplayObjectContainer オブジェクトを示します。
+     *              Indicates the DisplayObjectContainer object that contains this display object.
+     *
+     * @member  {DisplayObjectContainer | null}
+     * @readonly
+     * @public
+     */
+    get parent(): ParentImpl<any> | null;
+    /**
+     * @description 読み込まれた SWF ファイル内の表示オブジェクトの場合、
+     *              root プロパティはその SWF ファイルが表す表示リストのツリー構造部分の一番上にある表示オブジェクトとなります。
+     *              For a display object in a loaded SWF file,
+     *              the root property is the top-most display object
+     *              in the portion of the display list's tree structure represented by that SWF file.
+     *
+     * @member   {DisplayObject|null}
+     * @readonly
+     * @public
+     */
+    get root(): ParentImpl<any>;
+    /**
+     * @description DisplayObject インスタンスの元の位置からの回転角を度単位で示します。
+     *              Indicates the rotation of the DisplayObject instance,
+     *              in degrees, from its original orientation.
+     *
+     * @member {number}
+     * @public
+     */
+    get rotation(): number;
+    set rotation(rotation: number);
+    /**
+     * @description 現在有効な拡大 / 縮小グリッドです。
+     *              The current scaling grid that is in effect.
+     *
+     * @member {Rectangle}
+     * @public
+     */
+    get scale9Grid(): Rectangle | null;
+    set scale9Grid(scale_9_grid: Rectangle | null);
+    /**
+     * @description 基準点から適用されるオブジェクトの水平スケール（パーセンテージ）を示します。
+     *              Indicates the horizontal scale (percentage)
+     *              of the object as applied from the registration point.
+     *
+     * @member {number}
+     * @public
+     */
+    get scaleX(): number;
+    set scaleX(scale_x: number);
+    /**
+     * @description 基準点から適用されるオブジェクトの垂直スケール（パーセンテージ）を示します。
+     *              IIndicates the vertical scale (percentage)
+     *              of an object as applied from the registration point.
+     *
+     * @member {number}
+     * @public
+     */
+    get scaleY(): number;
+    set scaleY(scale_y: number);
+    /**
+     * @description 表示オブジェクトのステージです。
+     *              The Stage of the display object.
+     *
+     * @member   {Stage}
+     * @readonly
+     * @public
+     */
+    get stage(): Stage | null;
+    /**
+     * @description 表示オブジェクトのマトリックス、カラー変換、
+     *              ピクセル境界に関係するプロパティを持つオブジェクトです。
+     *              An object with properties pertaining
+     *              to a display object's matrix, color transform, and pixel bounds.
+     *
+     * @member {Transform}
+     * @public
+     */
+    get transform(): Transform;
+    set transform(transform: Transform);
+    /**
+     * @description 表示オブジェクトが可視かどうかを示します。
+     *              Whether or not the display object is visible.
+     *
+     * @member {boolean}
+     * @public
+     */
+    get visible(): boolean;
+    set visible(visible: boolean);
+    /**
+     * @description 表示オブジェクトの幅を示します（ピクセル単位）。
+     *              Indicates the width of the display object, in pixels.
+     *
+     * @member {number}
+     * @public
+     */
+    get width(): number;
+    set width(width: number);
+    /**
+     * @description 親 DisplayObjectContainer のローカル座標を基準にした
+     *              DisplayObject インスタンスの x 座標を示します。
+     *              Indicates the x coordinate
+     *              of the DisplayObject instance relative to the local coordinates
+     *              of the parent DisplayObjectContainer.
+     *
+     * @member {number}
+     * @public
+     */
+    get x(): number;
+    set x(x: number);
+    /**
+     * @description 親 DisplayObjectContainer のローカル座標を基準にした
+     *              DisplayObject インスタンスの y 座標を示します。
+     *              Indicates the y coordinate
+     *              of the DisplayObject instance relative to the local coordinates
+     *              of the parent DisplayObjectContainer.
+     *
+     * @member {number}
+     * @public
+     */
+    get y(): number;
+    set y(y: number);
+    /**
+     * @description targetCoordinateSpace オブジェクトの座標系を基準にして、
+     *              表示オブジェクトの領域を定義する矩形を返します。
+     *              Returns a rectangle that defines the area
+     *              of the display object relative to the coordinate system
+     *              of the targetCoordinateSpace object.
+     *
+     * @param  {DisplayObject} [target=null]
+     * @return {Rectangle}
+     */
+    getBounds(target?: DisplayObjectImpl<any> | null): Rectangle;
+    /**
+     * @description point オブジェクトをステージ（グローバル）座標から
+     *              表示オブジェクトの（ローカル）座標に変換します。
+     *              Converts the point object from the Stage (global) coordinates
+     *              to the display object's (local) coordinates.
+     *
+     * @param  {Point} point
+     * @return {Point}
+     * @public
+     */
+    globalToLocal(point: Point): Point;
+    /**
+     * @description 表示オブジェクトの境界ボックスを評価して、
+     *              obj 表示オブジェクトの境界ボックスと重複または交差するかどうかを調べます。
+     *              Evaluates the bounding box of the display object to see
+     *              if it overlaps or intersects with the bounding box of the obj display object.
+     *
+     * @param   {DisplayObject} object
+     * @returns {boolean}
+     * @public
+     */
+    hitTestObject(object: DisplayObjectImpl<any>): boolean;
+    /**
+     * @description 表示オブジェクトを評価して、x および y パラメーターで指定された
+     *              ポイントと重複または交差するかどうかを調べます。
+     *              Evaluates the display object to see if it overlaps
+     *              or intersects with the point specified by the x and y parameters.
+     *
+     * @param   {number}  x
+     * @param   {number}  y
+     * @param   {boolean} [shape_flag=false]
+     * @returns {boolean}
+     * @public
+     */
+    hitTestPoint(x: number, y: number, shape_flag?: boolean): boolean;
+    /**
+     * @description point オブジェクトを表示オブジェクトの（ローカル）座標から
+     *              ステージ（グローバル）座標に変換します。
+     *              Converts the point object from the display object's (local) coordinates
+     *              to the Stage (global) coordinates.
+     *
+     *
+     * @param   {Point} point
+     * @returns {Point}
+     * @public
+     */
+    localToGlobal(point: Point): Point;
+    /**
+     * @description クラスのローカル変数空間から値を取得
+     *              Get a value from the local variable space of the class
+     *
+     * @param  {*} key
+     * @return {*}
+     * @method
+     * @public
+     */
+    getLocalVariable(key: any): any;
+    /**
+     * @description クラスのローカル変数空間へ値を保存
+     *              Store values in the local variable space of the class
+     *
+     * @param  {*} key
+     * @param  {*} value
+     * @return {void}
+     * @method
+     * @public
+     */
+    setLocalVariable(key: any, value: any): void;
+    /**
+     * @description クラスのローカル変数空間に値があるかどうかを判断します。
+     *              Determines if there is a value in the local variable space of the class.
+     *
+     * @param  {*} key
+     * @return {boolean}
+     * @method
+     * @public
+     */
+    hasLocalVariable(key: any): boolean;
+    /**
+     * @description クラスのローカル変数空間の値を削除
+     *              Remove values from the local variable space of a class
+     *
+     * @param  {*} key
+     * @return {void}
+     * @method
+     * @public
+     */
+    deleteLocalVariable(key: any): void;
+    /**
+     * @description グローバル変数空間から値を取得
+     *              Get a value from the global variable space
+     *
+     * @param  {*} key
+     * @return {*}
+     * @method
+     * @public
+     */
+    getGlobalVariable(key: any): any;
+    /**
+     * @description グローバル変数空間へ値を保存
+     *              Save values to global variable space
+     *
+     * @param  {*} key
+     * @param  {*} value
+     * @return {void}
+     * @method
+     * @public
+     */
+    setGlobalVariable(key: any, value: any): void;
+    /**
+     * @description グローバル変数空間に値があるかどうかを判断します。
+     *              Determines if there is a value in the global variable space.
+     *
+     * @param  {*} key
+     * @return {boolean}
+     * @method
+     * @public
+     */
+    hasGlobalVariable(key: any): boolean;
+    /**
+     * @description グローバル変数空間の値を削除
+     *              Remove values from global variable space.
+     *
+     * @param  {*} key
+     * @return {void}
+     * @method
+     * @public
+     */
+    deleteGlobalVariable(key: any): void;
+    /**
+     * @description グローバル変数空間に値を全てクリアします。
+     *              Clear all values in the global variable space.
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    clearGlobalVariable(): void;
+    /**
+     * @return {object}
+     * @method
+     * @private
+     */
+    _$getPlaceObject(): PlaceObjectImpl | null;
+    /**
+     * @return {object}
+     * @method
+     * @private
+     */
+    _$sync(): any;
+    /**
+     * @param  {object} tag
+     * @param  {DisplayObjectContainer} parent
+     * @return {object}
+     * @method
+     * @private
+     */
+    _$baseBuild<T>(tag: DictionaryTagImpl, parent: ParentImpl<any>): T;
+    /**
+     * @return {boolean}
+     * @method
+     * @private
+     */
+    _$isUpdated(): boolean;
+    /**
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$updateState(): void;
+    /**
+     * @return {object}
+     * @method
+     * @private
+     */
+    _$doChanged(): void;
+    /**
+     * @param  {CanvasToWebGLContext} context
+     * @param  {WebGLTexture}         target_texture
+     * @param  {Float32Array}         matrix
+     * @param  {array}                filters
+     * @param  {number}               width
+     * @param  {number}               height
+     * @return {WebGLTexture}
+     * @method
+     * @private
+     */
+    _$drawFilter(context: CanvasToWebGLContext, target_texture: WebGLTexture, matrix: Float32Array, filters: FilterArrayImpl, width: number, height: number): WebGLTexture;
+    /**
+     * @param   {array}  [matrix=null]
+     * @returns {object}
+     * @private
+     */
+    _$getLayerBounds(matrix?: Float32Array | null): BoundsImpl;
+    /**
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$executeAddedEvent(): void;
+    /**
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$prepareActions(): void;
+    /**
+     * @return {boolean}
+     * @method
+     * @private
+     */
+    _$nextFrame(): boolean;
+    /**
+     * @param  {array} [filters=null]
+     * @return {boolean}
+     * @private
+     */
+    _$canApply(filters?: FilterArrayImpl | null): boolean;
+    /**
+     * @param  {number}       width
+     * @param  {number}       height
+     * @param  {Float32Array} matrix
+     * @param  {array}        [filters=null]
+     * @param  {boolean}      [can_apply=false]
+     * @param  {number}       [position_x=0]
+     * @param  {number}       [position_y=0]
+     * @return {boolean}
+     * @private
+     */
+    _$isFilterUpdated(width: number, height: number, matrix: Float32Array, filters?: FilterArrayImpl | null, can_apply?: boolean, position_x?: number, position_y?: number): boolean;
+    /**
+     * @param  {CanvasToWebGLContext} context
+     * @param  {array} filters
+     * @param  {WebGLTexture} target_texture
+     * @param  {Float32Array} matrix
+     * @param  {number} width
+     * @param  {number} height
+     * @return {WebGLTexture}
+     * @private
+     */
+    _$applyFilter(context: CanvasToWebGLContext, filters: FilterArrayImpl, target_texture: WebGLTexture, matrix: Float32Array, width: number, height: number): WebGLTexture;
+    /**
+     * @param  {Float32Array} matrix
+     * @return {boolean}
+     * @method
+     * @private
+     */
+    _$shouldClip(matrix: Float32Array): boolean;
+    /**
+     * @param  {CanvasToWebGLContext} context
+     * @param  {Float32Array} matrix
+     * @return {Float32Array|boolean|null}
+     * @method
+     * @private
+     */
+    _$startClip(context: CanvasToWebGLContext, matrix: Float32Array): Float32Array | boolean | null;
+    /**
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$removeWorkerInstance(): void;
+    /**
+     * @return {object}
+     * @method
+     * @private
+     */
+    _$createMessage(): PropertyMessageMapImpl<any>;
+}