@next2d/player 1.14.6 → 1.14.8

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

@@ -0,0 +1,174 @@
+import { DisplayObjectContainer } from "./DisplayObjectContainer";
+import { Graphics } from "./Graphics";
+import { SoundTransform } from "../media/SoundTransform";
+import type { Rectangle } from "../geom/Rectangle";
+import type { Point } from "../geom/Point";
+import type { SpriteImpl } from "../../../interface/SpriteImpl";
+import type { DropTargetImpl } from "../../../interface/DropTargetImpl";
+import type { DictionaryTagImpl } from "../../../interface/DictionaryTagImpl";
+import type { ParentImpl } from "../../../interface/ParentImpl";
+import type { MovieClipCharacterImpl } from "../../../interface/MovieClipCharacterImpl";
+/**
+ * Sprite クラスは、表示リストの基本的要素です。
+ * グラフィックを表示でき、子を持つこともできる表示リストノードです。
+ *
+ * The Sprite class is a basic display list building block:
+ * a display list node that can display graphics and can also contain children.
+ *
+ * @class
+ * @memberOf next2d.display
+ * @extends  DisplayObjectContainer
+ */
+export declare class Sprite extends DisplayObjectContainer {
+    protected _$buttonMode: boolean;
+    protected _$hitArea: SpriteImpl<any> | null;
+    protected _$soundTransform: SoundTransform | null;
+    protected _$graphics: Graphics | null;
+    protected _$useHandCursor: boolean;
+    /**
+     * @constructor
+     * @public
+     */
+    constructor();
+    /**
+     * @description 指定されたクラスのストリングを返します。
+     *              Returns the string representation of the specified class.
+     *
+     * @return  {string}
+     * @default [class Sprite]
+     * @method
+     * @static
+     */
+    static toString(): string;
+    /**
+     * @description 指定されたクラスの空間名を返します。
+     *              Returns the space name of the specified class.
+     *
+     * @return  {string}
+     * @default next2d.display.Sprite
+     * @const
+     * @static
+     */
+    static get namespace(): string;
+    /**
+     * @description 指定されたオブジェクトのストリングを返します。
+     *              Returns the string representation of the specified object.
+     *
+     * @return  {string}
+     * @default [object Sprite]
+     * @method
+     * @public
+     */
+    toString(): string;
+    /**
+     * @description 指定されたオブジェクトの空間名を返します。
+     *              Returns the space name of the specified object.
+     *
+     * @return  {string}
+     * @default next2d.display.Sprite
+     * @const
+     * @public
+     */
+    get namespace(): string;
+    /**
+     * @description このスプライトのボタンモードを指定します。
+     *              Specifies the button mode of this sprite.
+     *
+     * @member  {boolean}
+     * @default false
+     * @public
+     */
+    get buttonMode(): boolean;
+    set buttonMode(button_mode: boolean);
+    /**
+     * @description スプライトのドラッグ先またはスプライトがドロップされた先の表示オブジェクトを指定します。
+     *              Specifies the display object over which the sprite is being dragged,
+     *              or on which the sprite was dropped.
+     *
+     * @member  {DisplayObject|null}
+     * @readonly
+     * @public
+     */
+    get dropTarget(): DropTargetImpl;
+    /**
+     * @description ベクターの描画コマンドが発生するこのスプライトに属する Graphics オブジェクトを指定します。
+     *              Specifies the Graphics object that belongs to this sprite
+     *              where vector drawing commands can occur.
+     *
+     * @member  {Graphics}
+     * @readonly
+     * @public
+     */
+    get graphics(): Graphics;
+    /**
+     * @description スプライトのヒット領域となる別のスプライトを指定します。
+     *              Designates another sprite to serve as the hit area for a sprite.
+     *
+     * @member {Sprite|null}
+     * @public
+     */
+    get hitArea(): SpriteImpl<any> | null;
+    set hitArea(hit_area: SpriteImpl<any> | null);
+    /**
+     * @description このスプライト内のサウンドを制御します。
+     *              Controls sound within this sprite.
+     *
+     * @member  {SoundTransform}
+     * @public
+     */
+    get soundTransform(): SoundTransform;
+    set soundTransform(sound_transform: SoundTransform | null);
+    /**
+     * @description buttonMode プロパティが true に設定されたスプライト上にポインターが移動したときに、
+     *              指差しハンドポインター（ハンドカーソル）を表示するかどうかを示すブール値です。
+     *              A Boolean value that indicates whether the pointing hand (hand cursor)
+     *              appears when the pointer rolls over a sprite
+     *              in which the buttonMode property is set to true.
+     *
+     * @member  {boolean}
+     * @default true
+     * @public
+     */
+    get useHandCursor(): boolean;
+    set useHandCursor(use_hand_cursor: boolean);
+    /**
+     * @description 指定されたスプライトをユーザーがドラッグできるようにします。
+     *              Lets the user drag the specified sprite.
+     *
+     * @param  {boolean}   [lock_center=false]
+     * @param  {Rectangle} [bounds=null]
+     * @return {void}
+     * @method
+     * @public
+     */
+    startDrag(lock_center?: boolean, bounds?: Rectangle | null): void;
+    /**
+     * @description startDrag() メソッドを終了します。
+     *              Ends the startDrag() method.
+     *
+     * @return void
+     * @method
+     * @public
+     */
+    stopDrag(): void;
+    /**
+     * @return {object}
+     * @method
+     * @private
+     */
+    _$sync(): any;
+    /**
+     * @param  {object} tag
+     * @param  {DisplayObjectContainer} parent
+     * @return {object}
+     * @method
+     * @private
+     */
+    _$build(tag: DictionaryTagImpl, parent: ParentImpl<any>): MovieClipCharacterImpl;
+    /**
+     * @return {Point}
+     * @method
+     * @private
+     */
+    _$dragMousePoint(): Point;
+}

package/dist/player/next2d/display/Sprite.js

@@ -0,0 +1,288 @@
+import { DisplayObjectContainer } from "./DisplayObjectContainer";
+import { Graphics } from "./Graphics";
+import { SoundTransform } from "../media/SoundTransform";
+import { $currentMousePoint, $dragRules, $dropTarget, $rendererWorker, $setDropTarget } from "../../util/Util";
+/**
+ * Sprite クラスは、表示リストの基本的要素です。
+ * グラフィックを表示でき、子を持つこともできる表示リストノードです。
+ *
+ * The Sprite class is a basic display list building block:
+ * a display list node that can display graphics and can also contain children.
+ *
+ * @class
+ * @memberOf next2d.display
+ * @extends  DisplayObjectContainer
+ */
+export class Sprite extends DisplayObjectContainer {
+    _$buttonMode;
+    _$hitArea;
+    _$soundTransform;
+    _$graphics;
+    _$useHandCursor;
+    /**
+     * @constructor
+     * @public
+     */
+    constructor() {
+        super();
+        /**
+         * @type {boolean}
+         * @default false
+         * @private
+         */
+        this._$buttonMode = false;
+        /**
+         * @type {Sprite|null}
+         * @default null
+         * @private
+         */
+        this._$hitArea = null;
+        /**
+         * @type {SoundTransform}
+         * @default null
+         * @private
+         */
+        this._$soundTransform = null;
+        /**
+         * @type {boolean}
+         * @default true
+         * @private
+         */
+        this._$useHandCursor = true;
+        /**
+         * @type {Graphics|null}
+         * @default null
+         * @private
+         */
+        this._$graphics = null;
+    }
+    /**
+     * @description 指定されたクラスのストリングを返します。
+     *              Returns the string representation of the specified class.
+     *
+     * @return  {string}
+     * @default [class Sprite]
+     * @method
+     * @static
+     */
+    static toString() {
+        return "[class Sprite]";
+    }
+    /**
+     * @description 指定されたクラスの空間名を返します。
+     *              Returns the space name of the specified class.
+     *
+     * @return  {string}
+     * @default next2d.display.Sprite
+     * @const
+     * @static
+     */
+    static get namespace() {
+        return "next2d.display.Sprite";
+    }
+    /**
+     * @description 指定されたオブジェクトのストリングを返します。
+     *              Returns the string representation of the specified object.
+     *
+     * @return  {string}
+     * @default [object Sprite]
+     * @method
+     * @public
+     */
+    toString() {
+        return "[object Sprite]";
+    }
+    /**
+     * @description 指定されたオブジェクトの空間名を返します。
+     *              Returns the space name of the specified object.
+     *
+     * @return  {string}
+     * @default next2d.display.Sprite
+     * @const
+     * @public
+     */
+    get namespace() {
+        return "next2d.display.Sprite";
+    }
+    /**
+     * @description このスプライトのボタンモードを指定します。
+     *              Specifies the button mode of this sprite.
+     *
+     * @member  {boolean}
+     * @default false
+     * @public
+     */
+    get buttonMode() {
+        return this._$buttonMode;
+    }
+    set buttonMode(button_mode) {
+        this._$buttonMode = !!button_mode;
+    }
+    /**
+     * @description スプライトのドラッグ先またはスプライトがドロップされた先の表示オブジェクトを指定します。
+     *              Specifies the display object over which the sprite is being dragged,
+     *              or on which the sprite was dropped.
+     *
+     * @member  {DisplayObject|null}
+     * @readonly
+     * @public
+     */
+    get dropTarget() {
+        return $dropTarget;
+    }
+    /**
+     * @description ベクターの描画コマンドが発生するこのスプライトに属する Graphics オブジェクトを指定します。
+     *              Specifies the Graphics object that belongs to this sprite
+     *              where vector drawing commands can occur.
+     *
+     * @member  {Graphics}
+     * @readonly
+     * @public
+     */
+    get graphics() {
+        if (!this._$graphics) {
+            this._$graphics = new Graphics(this);
+        }
+        return this._$graphics;
+    }
+    /**
+     * @description スプライトのヒット領域となる別のスプライトを指定します。
+     *              Designates another sprite to serve as the hit area for a sprite.
+     *
+     * @member {Sprite|null}
+     * @public
+     */
+    get hitArea() {
+        return this._$hitArea;
+    }
+    set hitArea(hit_area) {
+        // reset
+        if (this._$hitArea) {
+            this._$hitArea._$hitObject = null;
+        }
+        this._$hitArea = hit_area;
+        if (hit_area) {
+            hit_area._$hitObject = this;
+        }
+    }
+    /**
+     * @description このスプライト内のサウンドを制御します。
+     *              Controls sound within this sprite.
+     *
+     * @member  {SoundTransform}
+     * @public
+     */
+    get soundTransform() {
+        if (!this._$soundTransform) {
+            this._$soundTransform = new SoundTransform();
+        }
+        return this._$soundTransform;
+    }
+    set soundTransform(sound_transform) {
+        this._$soundTransform = sound_transform;
+    }
+    /**
+     * @description buttonMode プロパティが true に設定されたスプライト上にポインターが移動したときに、
+     *              指差しハンドポインター（ハンドカーソル）を表示するかどうかを示すブール値です。
+     *              A Boolean value that indicates whether the pointing hand (hand cursor)
+     *              appears when the pointer rolls over a sprite
+     *              in which the buttonMode property is set to true.
+     *
+     * @member  {boolean}
+     * @default true
+     * @public
+     */
+    get useHandCursor() {
+        return this._$useHandCursor;
+    }
+    set useHandCursor(use_hand_cursor) {
+        this._$useHandCursor = use_hand_cursor;
+    }
+    /**
+     * @description 指定されたスプライトをユーザーがドラッグできるようにします。
+     *              Lets the user drag the specified sprite.
+     *
+     * @param  {boolean}   [lock_center=false]
+     * @param  {Rectangle} [bounds=null]
+     * @return {void}
+     * @method
+     * @public
+     */
+    startDrag(lock_center = false, bounds = null) {
+        let x = 0;
+        let y = 0;
+        if (!lock_center) {
+            const point = this._$dragMousePoint();
+            x = this.x - point.x;
+            y = this.y - point.y;
+        }
+        $setDropTarget(this);
+        $dragRules.lock = lock_center;
+        $dragRules.position.x = x;
+        $dragRules.position.y = y;
+        $dragRules.bounds = bounds;
+    }
+    /**
+     * @description startDrag() メソッドを終了します。
+     *              Ends the startDrag() method.
+     *
+     * @return void
+     * @method
+     * @public
+     */
+    stopDrag() {
+        // reset
+        $setDropTarget(null);
+        $dragRules.lock = false;
+        $dragRules.position.x = 0;
+        $dragRules.position.y = 0;
+        $dragRules.bounds = null;
+    }
+    /**
+     * @return {object}
+     * @method
+     * @private
+     */
+    _$sync() {
+        const character = super._$sync();
+        if ($rendererWorker && this._$stage) {
+            this._$createWorkerInstance();
+        }
+        if (character) {
+            this._$controller = character.controller;
+            this._$dictionary = character.dictionary;
+            this._$placeMap = character.placeMap;
+            this._$placeObjects = character.placeObjects;
+        }
+        return character;
+    }
+    /**
+     * @param  {object} tag
+     * @param  {DisplayObjectContainer} parent
+     * @return {object}
+     * @method
+     * @private
+     */
+    _$build(tag, parent) {
+        const character = this
+            ._$baseBuild(tag, parent);
+        if ($rendererWorker && this._$stage) {
+            this._$createWorkerInstance();
+        }
+        this._$controller = character.controller;
+        this._$dictionary = character.dictionary;
+        this._$placeMap = character.placeMap;
+        this._$placeObjects = character.placeObjects;
+        return character;
+    }
+    /**
+     * @return {Point}
+     * @method
+     * @private
+     */
+    _$dragMousePoint() {
+        return this._$parent
+            ? this._$parent.globalToLocal($currentMousePoint())
+            : this.globalToLocal($currentMousePoint());
+    }
+}

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

@@ -0,0 +1,164 @@
+import { DisplayObjectContainer } from "./DisplayObjectContainer";
+import type { Player } from "../../player/Player";
+import type { DisplayObjectImpl } from "../../../interface/DisplayObjectImpl";
+/**
+ * Stage クラスはメイン描画領域を表します。
+ * The Stage class represents the main drawing area.
+ *
+ * @class
+ * @memberOf next2d.display
+ * @extends  DisplayObjectContainer
+ */
+export declare class Stage extends DisplayObjectContainer {
+    _$player: Player | null;
+    _$invalidate: boolean;
+    private _$color;
+    _$frameRate: number;
+    /**
+     * @constructor
+     * @public
+     */
+    constructor();
+    /**
+     * @description 指定されたクラスのストリングを返します。
+     *              Returns the string representation of the specified class.
+     *
+     * @return  {string}
+     * @default [class Stage]
+     * @method
+     * @static
+     */
+    static toString(): string;
+    /**
+     * @description 指定されたクラスの空間名を返します。
+     *              Returns the space name of the specified class.
+     *
+     * @return  {string}
+     * @default next2d.display.Stage
+     * @const
+     * @static
+     */
+    static get namespace(): string;
+    /**
+     * @description 指定されたオブジェクトのストリングを返します。
+     *              Returns the string representation of the specified object.
+     *
+     * @return  {string}
+     * @default [object Stage]
+     * @method
+     * @public
+     */
+    toString(): string;
+    /**
+     * @description 指定されたオブジェクトの空間名を返します。
+     *              Returns the space name of the specified object.
+     *
+     * @return  {string}
+     * @default next2d.display.Stage
+     * @const
+     * @public
+     */
+    get namespace(): string;
+    /**
+     * @description 背景色です。
+     *              background color.
+     *
+     * @member {number}
+     * @public
+     */
+    get color(): number;
+    set color(color: number);
+    /**
+     * @description ステージのフレームレートを取得または設定します。
+     *              Gets and sets the frame rate of the stage.
+     *
+     * @member {number}
+     * @public
+     */
+    get frameRate(): number;
+    set frameRate(frame_rate: number);
+    /**
+     * @description Player オブジェクトを返します。
+     *              Returns a Player object.
+     *
+     * @member {Player}
+     * @readonly
+     * @public
+     */
+    get player(): Player | null;
+    /**
+     * @description 現在のCanvasの高さをピクセル単位で指定します。
+     *              Specifies the height of the current Canvas in pixels.
+     *
+     * @member {number}
+     * @readonly
+     * @public
+     */
+    get canvasHeight(): number;
+    /**
+     * @description 現在のCanvasの幅をピクセル単位で指定します。
+     *              Specifies the width of the current Canvas in pixels.
+     *
+     * @member {number}
+     * @readonly
+     * @public
+     */
+    get canvasWidth(): number;
+    /**
+     * @description 現在のStageの高さをピクセル単位で指定します。
+     *              Specifies the height of the current Stage in pixels.
+     *
+     * @member {number}
+     * @readonly
+     * @public
+     */
+    get currentStageHeight(): number;
+    /**
+     * @description 現在のStageの幅をピクセル単位で指定します。
+     *              Specifies the width of the current Stage in pixels.
+     *
+     * @member {number}
+     * @readonly
+     * @public
+     */
+    get currentStageWidth(): number;
+    /**
+     * @description 初期設定したステージの高さをピクセル単位で指定します。
+     *              Specifies the height of the initially set stage in pixels.
+     *
+     * @member {number}
+     * @readonly
+     * @public
+     */
+    get stageHeight(): number;
+    /**
+     * @description 初期設定したステージの幅をピクセル単位で指定します。
+     *              Specifies the width of the initially set stage in pixels.
+     *
+     * @member {number}
+     * @readonly
+     * @public
+     */
+    get stageWidth(): number;
+    /**
+     * @description 表示リストをレンダリングする必要のある次の機会に、
+     *              表示オブジェクトに警告するようランタイムに通知します。
+     *              (例えば、再生ヘッドを新しいフレームに進める場合などです。)
+     *              Calling the invalidate() method signals runtimes
+     *              to alert display objects on the next opportunity
+     *              it has to render the display list.
+     *              (for example, when the playhead advances to a new frame)
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    invalidate(): void;
+    /**
+     * @param  {DisplayObject} child
+     * @return {DisplayObject}
+     * @method
+     * @private
+     */
+    _$addChild(child: DisplayObjectImpl<any>): DisplayObjectImpl<any>;
+}