@next2d/display 1.18.12 → 2.0.0

package/src/DisplayObject.d.ts

@@ -0,0 +1,706 @@
+import type { LoaderInfo } from "./LoaderInfo";
+import type { Sprite } from "./Sprite";
+import type { IParent } from "./interface/IParent";
+import type { IPlaceObject } from "./interface/IPlaceObject";
+import type { IBlendMode } from "./interface/IBlendMode";
+import type { IFilterArray } from "./interface/IFilterArray";
+import type { MovieClip } from "./MovieClip";
+import type { ISprite } from "./interface/ISprite";
+import type { ColorTransform, Matrix, Rectangle, Point } from "@next2d/geom";
+import { EventDispatcher } from "@next2d/events";
+/**
+ * @description DisplayObject クラスは、表示リストに含めることのできるすべてのオブジェクトに関する基本クラスです。
+ *              DisplayObject クラス自体は、画面上でのコンテンツの描画のための API を含みません。
+ *              そのため、DisplayObject クラスのカスタムサブクラスを作成する場合は、
+ *              Shape、Sprite、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, TextField, or MovieClip class.
+ *
+ * @class
+ * @memberOf next2d.display
+ * @extends  EventDispatcher
+ */
+export declare class DisplayObject extends EventDispatcher {
+    /**
+     * @description DisplayObject のユニークなインスタンスID
+     *              Unique instance ID of DisplayObject
+     *
+     * @type {number}
+     * @readonly
+     * @public
+     */
+    readonly instanceId: number;
+    /**
+     * @description DisplayObject の生成元ID
+     *              Source ID of DisplayObject
+     *
+     * @type {number}
+     * @default -1
+     * @public
+     */
+    dictionaryId: number;
+    /**
+     * @description Spriteの機能を所持しているかを返却
+     *              Returns whether Sprite functions are possessed.
+     *
+     * @type {boolean}
+     * @readonly
+     * @public
+     */
+    readonly isSprite: boolean;
+    /**
+     * @description InteractiveObject の機能を所持しているかを返却
+     *              Returns whether InteractiveObject functions are possessed.
+     *
+     * @type {boolean}
+     * @readonly
+     * @public
+     */
+    readonly isInteractive: boolean;
+    /**
+     * @description コンテナの機能を所持しているかを返却
+     *              Returns whether the display object has container functionality.
+     *
+     * @type {boolean}
+     * @readonly
+     * @public
+     */
+    readonly isContainerEnabled: boolean;
+    /**
+     * @description MovieClipの機能を所持しているかを返却
+     *              Returns whether the display object has MovieClip functionality.
+     *
+     * @type {boolean}
+     * @readonly
+     * @public
+     */
+    readonly isTimelineEnabled: boolean;
+    /**
+     * @description Shapeの機能を所持しているかを返却
+     *              Returns whether the display object has Shape functionality.
+     *
+     * @type {boolean}
+     * @readonly
+     * @public
+     */
+    readonly isShape: boolean;
+    /**
+     * @description Videoの機能を所持しているかを返却
+     *              Returns whether the display object has Video functionality.
+     *
+     * @type {boolean}
+     * @readonly
+     * @public
+     */
+    readonly isVideo: boolean;
+    /**
+     * @description Textの機能を所持しているかを返却
+     *              Returns whether the display object has Text functionality.
+     *
+     * @type {boolean}
+     * @readonly
+     * @public
+     */
+    readonly isText: boolean;
+    /**
+     * @description 表示オブジェクトのPlaceObjectのIDを返却します。
+     *              Returns the ID of the PlaceObject of the display object.
+     *
+     * @type {number}
+     * @default -1
+     * @public
+     */
+    placeId: number;
+    /**
+     * @description 現在のフレームの表示オブジェクトのPlaceObjectを返却します。
+     *             Returns the PlaceObject of the current frame of the display object.
+     *
+     * @type {IPlaceObject|null}
+     * @default null
+     * @public
+     */
+    placeObject: IPlaceObject | null;
+    /**
+     * @description 構築に利用したキャラクターIDを返却します。
+     *              Returns the character ID used for construction.
+     *
+     * @type {number}
+     * @default -1
+     * @public
+     */
+    characterId: number;
+    /**
+     * @description マスク対象の深度を返却します。
+     *              Returns the depth of the mask target.
+     *
+     * @type {number}
+     * @default 0
+     * @public
+     */
+    clipDepth: number;
+    /**
+     * @description 名前を返却します。 getChildByName() で使用されます。
+     *              Returns the name. Used by getChildByName().
+     *
+     * @see {DisplayObjectContainer.getChildByName}
+     * @type {string}
+     * @default ""
+     * @public
+     */
+    name: string;
+    /**
+     * @description 開始フレームを返却します。
+     *              Returns the start frame.
+     *
+     * @type {number}
+     * @default 1
+     * @public
+     */
+    startFrame: number;
+    /**
+     * @description 終了フレームを返却します。
+     *              Returns the end frame.
+     *
+     * @type {number}
+     * @default 0
+     * @public
+     */
+    endFrame: number;
+    /**
+     * @description 描画に関連する何らかの変更が加えられたかを示します。
+     *              Indicates whether any changes related to drawing have been made.
+     *
+     * @type {boolean}
+     * @default true
+     * @public
+     */
+    changed: boolean;
+    /**
+     * @description DisplayObjectの追加イベントが発火したかを示します。
+     *              Indicates whether the DisplayObject addition event has been fired.
+     *
+     * @type {boolean}
+     * @default false
+     * @public
+     */
+    $added: boolean;
+    /**
+     * @description DisplayObjectのステージ追加イベントが発火したかを示します。
+     *              Indicates whether the DisplayObject stage addition event has been fired.
+     *
+     * @type {boolean}
+     * @default false
+     * @public
+     */
+    $addedToStage: boolean;
+    /**
+     * @description キャッシュで利用するユニークキー
+     *              Unique key used for caching
+     *
+     * @type {string}
+     * @public
+     */
+    uniqueKey: string;
+    /**
+     * @description 固定された変換行列、nullの場合はPlaceObjectの変換行列を検索します。
+     *              Fixed transformation matrix, if null, search for PlaceObject transformation matrix.
+     *
+     * @type {Matrix}
+     * @default null
+     * @protected
+     */
+    $matrix: Matrix | null;
+    /**
+     * @description 固定されたカラートランスフォーム、nullの場合はPlaceObjectのカラートランスフォームを検索します。
+     *              Fixed color transform, if null, search for PlaceObject color transform.
+     *
+     * @type {ColorTransform}
+     * @default null
+     * @protected
+     */
+    $colorTransform: ColorTransform | null;
+    /**
+     * @description 表示オブジェクトに現在関連付けられている各フィルターオブジェクトの配列です。
+     *              An array of filter objects currently associated with the display object.
+     *
+     * @type {array}
+     * @default null
+     * @protected
+     */
+    $filters: IFilterArray | null;
+    /**
+     * @description 使用するブレンドモードを指定する BlendMode クラスの値です。
+     *              A value from the BlendMode class that specifies which blend mode to use.
+     *
+     * @type {string}
+     * @default BlendMode.NORMAL
+     * @protected
+     */
+    $blendMode: IBlendMode | null;
+    /**
+     * @description キャッシュした scaleX の値を返却します。
+     *              Returns the cached scaleX value.
+     *
+     * @type {number}
+     * @default null
+     * @protected
+     */
+    $scaleX: number | null;
+    /**
+     * @description キャッシュした scaleY の値を返却します。
+     *              Returns the cached scaleY value.
+     *
+     * @type {number}
+     * @default null
+     * @protected
+     */
+    $scaleY: number | null;
+    /**
+     * @description キャッシュした rotation の値を返却します。
+     *              Returns the cached rotation value.
+     *
+     * @type {number}
+     * @default null
+     * @protected
+     */
+    $rotation: number | null;
+    /**
+     * @description キャッシュした x の値を返却します。
+     *              Returns the cached x value.
+     *
+     * @type {number}
+     * @default null
+     * @protected
+     */
+    $x: number | null;
+    /**
+     * @description キャッシュした y の値を返却します。
+     *              Returns the cached y value.
+     *
+     * @type {number}
+     * @default null
+     * @protected
+     */
+    $y: number | null;
+    /**
+     * @description キャッシュした alpha の値を返却します。
+     *              Returns the cached alpha value.
+     *
+     * @type {number}
+     * @default null
+     * @protected
+     */
+    $alpha: number | null;
+    /**
+     * @description 描画情報を保持するキャッシュ
+     *              Cache that holds drawing information
+     *
+     * @type {Map<any, any> | null}
+     * @default null
+     * @protected
+     */
+    $cache: Map<any, any> | null;
+    /**
+     * @description 表示オブジェクトのスケール9グリッドを示します。
+     *              Indicates the scale9 grid of the display object.
+     *
+     * @type {Rectangle}
+     * @private
+     */
+    private _$scale9Grid;
+    /**
+     * @description 表示オブジェクトの可視性を示します。
+     *              Indicates the visibility of the display object.
+     *
+     * @type {boolean}
+     * @private
+     */
+    private _$visible;
+    /**
+     * @description 表示オブジェクト単位の変数を保持するマップ
+     *              Map that holds variables for display objects
+     *
+     * @type {Map<any, any>}
+     * @default null
+     * @private
+     */
+    private _$variables;
+    /**
+     * @description マスクとしてDisplayObjectにセットされているかを示します。
+     *              Indicates whether the DisplayObject is set as a mask.
+     *
+     * @type {boolean}
+     * @default false
+     * @private
+     */
+    isMask: boolean;
+    /**
+     * @description このDisplayObjectの親のDisplayObjectContainerを返却します。
+     *              通常であれば、親のDisplayObjectContainerを継承しているのは、Sprite、または MovieClip となります。
+     *              Returns the DisplayObjectContainer of this DisplayObject's parent.
+     *              Under normal circumstances, the parent DisplayObjectContainer would inherit from Sprite or MovieClip.
+     *
+     * @member {Sprite | MovieClip | null}
+     * @public
+     */
+    parent: ISprite<any> | null;
+    /**
+     * @constructor
+     * @public
+     */
+    constructor();
+    /**
+     * @description この表示オブジェクトおよびルートレベルまでのそのすべての親オブジェクトの結合された Matrix を返却します。
+     *              Returns a concatenated Matrix object representing the combined transformation matrixes of the display object and all of its parent objects, back to the root level.
+     *
+     * @member  {Matrix}
+     * @readonly
+     */
+    get concatenatedMatrix(): Matrix;
+    /**
+     * @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(): IBlendMode;
+    set blendMode(blend_mode: IBlendMode);
+    /**
+     * @description 表示オブジェクトに現在関連付けられている各フィルターオブジェクトの配列です。
+     *              An array of filter objects currently associated with the display object.
+     *
+     * @member  {array}
+     * @default null
+     * @public
+     */
+    get filters(): IFilterArray | null;
+    set filters(filters: IFilterArray | null);
+    /**
+     * @description スプライトのドラッグ先またはスプライトがドロップされた先の表示オブジェクトを指定します。
+     *              Specifies the display object over which the sprite is being dragged,
+     *              or on which the sprite was dropped.
+     *
+     * @member  {ISprite|null}
+     * @readonly
+     * @public
+     */
+    get dropTarget(): ISprite<any> | 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 表示オブジェクトの ColorTransform を返します。
+     *              Returns the ColorTransform object of the display object.
+     *
+     * @member {ColorTransform}
+     * @public
+     */
+    get colorTransform(): ColorTransform;
+    set colorTransform(color_transform: ColorTransform);
+    /**
+     * @description 表示オブジェクトの Matrix を返します。
+     *              Returns the Matrix of the display object.
+     *
+     * @member {Matrix}
+     * @public
+     */
+    get matrix(): Matrix;
+    set matrix(matrix: Matrix);
+    /**
+     * @description 対象のDisplayObjectの基準点からの x 軸の位置をピクセルで示します。
+     *              Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer.
+     *
+     * @member  {number}
+     * @default 0
+     * @readonly
+     * @public
+     */
+    get mouseX(): number;
+    /**
+     * @description 対象のDisplayObjectの基準点からの y 軸の位置をピクセルで示します。
+     *              Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer.
+     *
+     * @member  {number}
+     * @default 0
+     * @readonly
+     * @public
+     */
+    get mouseY(): number;
+    /**
+     * @description DisplayObject のルートである DisplayObjectContainer を返します。
+     *              Returns the DisplayObjectContainer object that contains this display object.
+     *
+     * @member   {MovieClip | Sprite | null}
+     * @readonly
+     * @public
+     */
+    get root(): IParent<MovieClip | Sprite> | null;
+    /**
+     * @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 基準点から適用されるオブジェクトの水平スケール値を返却します。
+     *              Returns the horizontal scale value of the object applied from the reference 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 表示オブジェクトが可視かどうかを示します。
+     *              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 指定したDisplayObject の座標系を基準にして、表示オブジェクトの領域を定義する矩形を返します。
+     *              Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetDisplayObject.
+     *
+     * @param  {DisplayObject} [target_display_object=null]
+     * @return {Rectangle}
+     */
+    getBounds<D extends DisplayObject>(target_display_object?: D | 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 DisplayObject の描画範囲を評価して、重複または交差するかどうかを調べます。
+     *              Evaluates a DisplayObject's drawing range to see if it overlaps or intersects.
+     *
+     * @param   {DisplayObject} target_display_object
+     * @returns {boolean}
+     * @public
+     */
+    hitTestObject<D extends DisplayObject>(target_display_object: D): 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;
+    /**
+     * @description 親子関係を解除します。
+     *              Removes the parent-child relationship.
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    remove(): void;
+    /**
+     * @description 指定の LoaderInfo を DisplayObject に同期します。
+     *              Synchronizes the specified LoaderInfo with the DisplayObject.
+     *
+     * @param  {LoaderInfo} loader_info
+     * @return {void}
+     * @method
+     * @protected
+     */
+    $syncLoaderInfo(loader_info: LoaderInfo): void;
+}