@next2d/player 1.14.7 → 1.14.9

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

@@ -0,0 +1,577 @@
+import { BitmapData } from "./BitmapData";
+import type { GraphicsParentImpl } from "../../../interface/GraphicsParentImpl";
+import type { Matrix } from "../geom/Matrix";
+import type { CapsStyle, JointStyle } from "../../../interface/StrokeTypeImpl";
+import type { FilterArrayImpl } from "../../../interface/FilterArrayImpl";
+import type { BlendModeImpl } from "../../../interface/BlendModeImpl";
+import type { CanvasToWebGLContext } from "../../../webgl/CanvasToWebGLContext";
+import type { BoundsImpl } from "../../../interface/BoundsImpl";
+import type { PlayerHitObjectImpl } from "../../../interface/PlayerHitObjectImpl";
+import { SpreadMethod, GradientType, InterpolationMethod } from "../../../interface/GradientTypeImpl";
+/**
+ * Graphics クラスには、ベクターシェイプの作成に使用できる一連のメソッドがあります。
+ * 描画をサポートする表示オブジェクトには、Sprite および Shape オブジェクトがあります。
+ * これらの各クラスには、Graphics オブジェクトである graphics プロパティがあります。
+ * 以下は、簡単に使用できるように用意されているヘルパー関数の一例です。
+ * drawRect()、drawRoundRect()、drawCircle()、および drawEllipse()。
+ *
+ * The Graphics class contains a set of methods that you can use to create a vector shape.
+ * Display objects that support drawing include Sprite and Shape objects.
+ * Each of these classes includes a graphics property that is a Graphics object.
+ * The following are among those helper functions provided for ease of use:
+ * drawRect(), drawRoundRect(), drawCircle(), and drawEllipse().
+ *
+ * @class
+ * @memberOf next2d.display
+ */
+export declare class Graphics {
+    private readonly _$displayObject;
+    _$maxAlpha: number;
+    private _$pointerX;
+    private _$pointerY;
+    _$canDraw: boolean;
+    private _$fillType;
+    private _$fillGradient;
+    private _$fillBitmap;
+    private _$fillStyleR;
+    private _$fillStyleG;
+    private _$fillStyleB;
+    private _$fillStyleA;
+    private _$doFill;
+    private _$lineType;
+    private _$lineGradient;
+    private _$caps;
+    private _$joints;
+    private _$miterLimit;
+    private _$lineWidth;
+    private _$lineStyleR;
+    private _$lineStyleG;
+    private _$lineStyleB;
+    private _$lineStyleA;
+    private _$doLine;
+    _$xMin: number;
+    _$xMax: number;
+    _$yMin: number;
+    _$yMax: number;
+    _$buffer: Float32Array | null;
+    _$recode: any[] | null;
+    private _$fills;
+    private _$lines;
+    /**
+     * @param {DisplayObject} src
+     *
+     * @constructor
+     * @public
+     */
+    constructor(src?: GraphicsParentImpl<any> | null);
+    /**
+     * @description 指定されたクラスのストリングを返します。
+     *              Returns the string representation of the specified class.
+     *
+     * @return  {string}
+     * @default [class Graphics]
+     * @method
+     * @static
+     */
+    static toString(): string;
+    /**
+     * @description 指定されたクラスの空間名を返します。
+     *              Returns the space name of the specified class.
+     *
+     * @return  {string}
+     * @default next2d.display.Bitmap
+     * @const
+     * @static
+     */
+    static get namespace(): string;
+    /**
+     * @description 指定されたオブジェクトのストリングを返します。
+     *              Returns the string representation of the specified object.
+     *
+     * @return  {string}
+     * @default [object Graphics]
+     * @method
+     * @public
+     */
+    toString(): string;
+    /**
+     * @description 指定されたオブジェクトの空間名を返します。
+     *              Returns the space name of the specified object.
+     *
+     * @return  {string}
+     * @default next2d.display.Graphics
+     * @const
+     * @public
+     */
+    get namespace(): string;
+    /**
+     * @return {number}
+     * @default 0
+     * @const
+     * @static
+     * @private
+     */
+    static get MOVE_TO(): number;
+    /**
+     * @return {number}
+     * @default 1
+     * @const
+     * @static
+     * @private
+     */
+    static get CURVE_TO(): number;
+    /**
+     * @return {number}
+     * @default 2
+     * @const
+     * @static
+     * @private
+     */
+    static get LINE_TO(): number;
+    /**
+     * @return {number}
+     * @default 3
+     * @const
+     * @static
+     * @private
+     */
+    static get CUBIC(): number;
+    /**
+     * @return {number}
+     * @default 4
+     * @const
+     * @static
+     * @private
+     */
+    static get ARC(): number;
+    /**
+     * @return {number}
+     * @default 5
+     * @const
+     * @static
+     * @private
+     */
+    static get FILL_STYLE(): number;
+    /**
+     * @return {number}
+     * @default 6
+     * @const
+     * @static
+     * @private
+     */
+    static get STROKE_STYLE(): number;
+    /**
+     * @return {number}
+     * @default 7
+     * @const
+     * @static
+     * @private
+     */
+    static get END_FILL(): number;
+    /**
+     * @return {number}
+     * @default 8
+     * @const
+     * @static
+     * @private
+     */
+    static get END_STROKE(): number;
+    /**
+     * @return {number}
+     * @default 9
+     * @const
+     * @static
+     * @private
+     */
+    static get BEGIN_PATH(): number;
+    /**
+     * @return {number}
+     * @default 10
+     * @const
+     * @static
+     * @private
+     */
+    static get GRADIENT_FILL(): number;
+    /**
+     * @return {number}
+     * @default 11
+     * @const
+     * @static
+     * @private
+     */
+    static get GRADIENT_STROKE(): number;
+    /**
+     * @return {number}
+     * @default 12
+     * @const
+     * @static
+     * @private
+     */
+    static get CLOSE_PATH(): number;
+    /**
+     * @return {number}
+     * @default 13
+     * @const
+     * @static
+     * @private
+     */
+    static get BITMAP_FILL(): number;
+    /**
+     * @return {number}
+     * @default 14
+     * @const
+     * @static
+     * @private
+     */
+    static get BITMAP_STROKE(): number;
+    /**
+     * @description 描画領域をビットマップイメージで塗りつぶします。
+     *              Fills a drawing area with a bitmap image.
+     *
+     * @param  {BitmapData} bitmap_data
+     * @param  {Matrix}     [matrix=null]
+     * @param  {boolean}    [repeat=true]
+     * @param  {boolean}    [smooth=false]
+     * @return {Graphics}
+     * @method
+     * @public
+     */
+    beginBitmapFill(bitmap_data: BitmapData, matrix?: Matrix | null, repeat?: boolean, smooth?: boolean): Graphics;
+    /**
+     * @description 描画のときに他の Graphics メソッド（lineTo() や drawCircle() など）
+     *              に対する今後の呼び出しに使用する単純な一色塗りを指定します。
+     *              Specifies a simple one-color fill that subsequent calls
+     *              to other Graphics methods (such as lineTo() or drawCircle()) use when drawing.
+     *
+     * @param  {string|number} [color=0]
+     * @param  {number} [alpha=1.0]
+     * @return {Graphics}
+     * @method
+     * @public
+     */
+    beginFill(color?: string | number, alpha?: number): Graphics;
+    /**
+     * @description Graphics の他のメソッド（lineTo()、drawCircle() など）に対する、
+     *              オブジェクトの後続の呼び出しに使用するグラデーション塗りを指定します。
+     *              Specifies a gradient fill used by subsequent calls
+     *              to other Graphics methods (such as lineTo() or drawCircle()) for the object.
+     *
+     * @param  {string} type
+     * @param  {array}  colors
+     * @param  {array}  alphas
+     * @param  {array}  ratios
+     * @param  {Matrix} [matrix=null]
+     * @param  {string} [spread_method=SpreadMethod.PAD]
+     * @param  {string} [interpolation_method=InterpolationMethod.RGB]
+     * @param  {number} [focal_point_ratio=0]
+     * @return {Graphics}
+     * @method
+     * @public
+     */
+    beginGradientFill(type: GradientType, colors: number[], alphas: number[], ratios: number[], matrix?: Matrix | null, spread_method?: SpreadMethod, interpolation_method?: InterpolationMethod, focal_point_ratio?: number): Graphics;
+    /**
+     * @description この Graphics オブジェクトに描画されているグラフィックをクリアし、
+     *              塗りと線のスタイルの設定をリセットします。
+     *              Clears the graphics that were drawn to this Graphics object,
+     *              and resets fill and line style settings.
+     *
+     * @return {Graphics}
+     * @method
+     * @public
+     */
+    clear(): Graphics;
+    /**
+     * @description すべての描画コマンドをソース Graphics オブジェクトから、呼び出し Graphics オブジェクトにコピーします。
+     *              Copies all of drawing commands from the source Graphics object into the calling Graphics object.
+     *
+     * @return {Graphics}
+     * @method
+     * @public
+     */
+    clone(): Graphics;
+    /**
+     * @description すべての描画コマンドをソース Graphics オブジェクトから、呼び出し Graphics オブジェクトにコピーします。
+     *              Copies all of drawing commands from the source Graphics object into the calling Graphics object.
+     *
+     * @param  {Graphics} graphics
+     * @return {void}
+     * @method
+     * @public
+     */
+    copyFrom(graphics: Graphics): void;
+    /**
+     * @description 現在の描画位置から指定されたアンカーポイントに 3 次ベジェ曲線を描画します。
+     *              Draws a cubic Bezier curve from the current drawing position to the specified anchor point.
+     *
+     * @param  {number} control_x1
+     * @param  {number} control_y1
+     * @param  {number} control_x2
+     * @param  {number} control_y2
+     * @param  {number} anchor_x
+     * @param  {number} anchor_y
+     * @return {Graphics}
+     * @method
+     * @public
+     */
+    cubicCurveTo(control_x1: number, control_y1: number, control_x2: number, control_y2: number, anchor_x: number, anchor_y: number): Graphics;
+    /**
+     * @description (controlX, controlY) で指定されたコントロールポイントを使用し、
+     *              現在の描画位置から (anchorX, anchorY) まで、現在の線のスタイルで 2 次ベジェ曲線を描画します。
+     *              Draws a quadratic Bezier curve using the current line style from
+     *              the current drawing position to (anchorX, anchorY)
+     *              and using the control point that (controlX, controlY) specifies.
+     *
+     * @param  {number} control_x
+     * @param  {number} control_y
+     * @param  {number} anchor_x
+     * @param  {number} anchor_y
+     * @return {Graphics}
+     * @method
+     * @public
+     */
+    curveTo(control_x: number, control_y: number, anchor_x: number, anchor_y: number): Graphics;
+    /**
+     * @description 円を描画します。
+     *              Draws a circle.
+     *
+     * @param  {number} x
+     * @param  {number} y
+     * @param  {number} radius
+     * @return {Graphics}
+     * @method
+     * @public
+     */
+    drawCircle(x: number, y: number, radius: number): Graphics;
+    /**
+     * @description 楕円を描画します。
+     *              Draws an ellipse.
+     *
+     * @param  {number} x
+     * @param  {number} y
+     * @param  {number} width
+     * @param  {number} height
+     * @return {Graphics}
+     * @method
+     * @public
+     */
+    drawEllipse(x: number, y: number, width: number, height: number): Graphics;
+    /**
+     * @description 矩形を描画します。
+     *              Draws a rectangle.
+     *
+     * @param  {number} x
+     * @param  {number} y
+     * @param  {number} width
+     * @param  {number} height
+     * @return {Graphics}
+     * @method
+     * @public
+     */
+    drawRect(x: number, y: number, width: number, height: number): Graphics;
+    /**
+     * @description 角丸矩形を描画します。
+     *              Draws a rounded rectangle.
+     *
+     * @param  {number} x
+     * @param  {number} y
+     * @param  {number} width
+     * @param  {number} height
+     * @param  {number} ellipse_width
+     * @param  {number} [ellipse_height=NaN]
+     * @return {Graphics}
+     * @method
+     * @public
+     */
+    drawRoundRect(x: number, y: number, width: number, height: number, ellipse_width: number, ellipse_height?: number): Graphics;
+    /**
+     * @description beginFill()、beginGradientFill()、または beginBitmapFill() メソッドへの
+     *              最後の呼び出し以降に追加された線と曲線に塗りを適用します。
+     *              Applies a fill to the lines and curves that were added since
+     *              the last call to the beginFill(), beginGradientFill(),
+     *              or beginBitmapFill() method.
+     *
+     * @return {Graphics}
+     * @method
+     * @public
+     */
+    endFill(): Graphics;
+    /**
+     * @description lineStyle()、または lineGradientStyle() メソッドへの
+     *              最後の呼び出し以降に追加された線と曲線に塗りを適用します。
+     *              Applies a fill to the lines and curves that were added since
+     *              the last call to the beginFill() or beginGradientFill() method.
+     *
+     * @return {Graphics}
+     * @method
+     * @public
+     */
+    endLine(): Graphics;
+    /**
+     * @description 線の描画で、線として使用するビットマップを指定します。
+     *              Specifies a bitmap to use for the line stroke when drawing lines.
+     *
+     * @param  {BitmapData} bitmap_data
+     * @param  {Matrix}     [matrix=null]
+     * @param  {boolean}    [repeat=true]
+     * @param  {boolean}    [smooth=false]
+     * @return {Graphics}
+     * @method
+     * @public
+     */
+    lineBitmapStyle(bitmap_data: BitmapData, matrix?: Matrix | null, repeat?: boolean, smooth?: boolean): Graphics;
+    /**
+     * @description 線の描画で使用するグラデーションを指定します。
+     *              Specifies a gradient to use for the stroke when drawing lines.
+     *
+     * @param  {string} type
+     * @param  {array}  colors
+     * @param  {array}  alphas
+     * @param  {array}  ratios
+     * @param  {Matrix} [matrix=null]
+     * @param  {string} [spread_method=SpreadMethod.PAD]
+     * @param  {string} [interpolation_method=InterpolationMethod.RGB]
+     * @param  {number} [focal_point_ratio=0]
+     * @return {Graphics}
+     * @method
+     * @public
+     */
+    lineGradientStyle(type: GradientType, colors: number[], alphas: number[], ratios: number[], matrix?: Matrix | null, spread_method?: SpreadMethod, interpolation_method?: InterpolationMethod, focal_point_ratio?: number): Graphics;
+    /**
+     * @description lineTo() メソッドや drawCircle() メソッドなど、
+     *              Graphics のメソッドの後続の呼び出しに使用する線スタイルを指定します。
+     *              Specifies a line style used for subsequent calls
+     *              to Graphics methods such as the lineTo() method
+     *              or the drawCircle() method.
+     *
+     * @param  {number}  [thickness=NaN]
+     * @param  {number|string} [color=0]
+     * @param  {number}  [alpha=1]
+     * @param  {string}  [caps=CapsStyle.NONE]
+     * @param  {string}  [joints=JointStyle.ROUND]
+     * @param  {number}  [miter_limit=3]
+     * @return {Graphics}
+     * @method
+     * @public
+     */
+    lineStyle(thickness?: number, color?: string | number, alpha?: number, caps?: CapsStyle, joints?: JointStyle, miter_limit?: number): Graphics;
+    /**
+     * @description 現在の描画位置から (x, y) まで、現在の線のスタイルを使用して線を描画します。
+     *              その後で、現在の描画位置は (x, y) に設定されます。
+     *              Draws a line using the current line style from the current drawing position to (x, y);
+     *              the current drawing position is then set to (x, y).
+     *
+     * @param   {number} x
+     * @param   {number} y
+     * @returns {Graphics}
+     * @method
+     * @public
+     */
+    lineTo(x: number, y: number): Graphics;
+    /**
+     * @description 現在の描画位置を (x, y) に移動します。
+     *              Moves the current drawing position to (x, y).
+     *
+     * @param   {number} x
+     * @param   {number} y
+     * @returns {Graphics}
+     * @method
+     * @public
+     */
+    moveTo(x: number, y: number): Graphics;
+    /**
+     * @param  {CanvasToWebGLContext} context
+     * @param  {Float32Array} matrix
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$clip(context: CanvasToWebGLContext, matrix: Float32Array): void;
+    /**
+     * @param  {CanvasToWebGLContext} context
+     * @param  {Float32Array} matrix
+     * @param  {Float32Array} color_transform
+     * @param  {string} [blend_mode=BlendMode.NORMAL]
+     * @param  {array}  [filters=null]
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$draw(context: CanvasToWebGLContext, matrix: Float32Array, color_transform: Float32Array, blend_mode?: BlendModeImpl, filters?: FilterArrayImpl | null): void;
+    /**
+     * @param  {CanvasToWebGLContext} context
+     * @param  {Float32Array}         [color_transform=null]
+     * @param  {boolean}              [is_clip=false]
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$doDraw(context: CanvasToWebGLContext, color_transform?: Float32Array | null, is_clip?: boolean): void;
+    /**
+     * @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;
+    /**
+     * @return {object}
+     * @method
+     * @private
+     */
+    _$getBounds(): BoundsImpl;
+    /**
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$restart(): void;
+    /**
+     * @param  {number} [x=0]
+     * @param  {number} [y=0]
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$setBounds(x?: number, y?: number): void;
+    /**
+     * @param  {number} x
+     * @param  {number} y
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$setFillBounds(x?: number, y?: number): void;
+    /**
+     * @param  {number} x
+     * @param  {number} y
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$setLineBounds(x?: number, y?: number): void;
+    /**
+     * @param {array} data
+     * @method
+     * @private
+     */
+    _$margePath(data: any[]): void;
+    /**
+     * @return {Float32Array}
+     * @method
+     * @private
+     */
+    _$getRecodes(): Float32Array;
+    /**
+     * @param  {CanvasToWebGLContext|CanvasRenderingContext2D} context
+     * @param  {Float32Array} [color_transform=null]
+     * @param  {boolean}      [is_clip=false]
+     * @param  {object}       [options=null]
+     * @return {boolean}
+     * @method
+     * @private
+     */
+    _$runCommand(context: CanvasToWebGLContext | CanvasRenderingContext2D, color_transform?: Float32Array | null, is_clip?: boolean, options?: PlayerHitObjectImpl | null): boolean;
+}