@awayjs/graphics
Version:
AwayJS graphics classes
817 lines • 46.6 kB
TypeScript
import { Matrix, Matrix3D, AssetBase, Rectangle } from '@awayjs/core';
import { BitmapImage2D } from '@awayjs/stage';
import { IEntityTraverser } from '@awayjs/view';
import { IMaterial, TriangleElements, LineScaleMode } from '@awayjs/renderer';
import { GraphicsPath } from './draw/GraphicsPath';
import { InterpolationMethod } from './draw/InterpolationMethod';
import { TriangleCulling } from './draw/TriangleCulling';
import { SpreadMethod } from './draw/SpreadMethod';
import { GradientType } from './draw/GradientType';
import { GraphicsPathWinding } from './draw/GraphicsPathWinding';
import { IGraphicsData } from './draw/IGraphicsData';
import { Shape } from './renderables/Shape';
import { ShapeStyle } from './flash/ShapeStyle';
import { BBox, ShapeTag } from './flash/ShapeTag';
/**
*
* Graphics is a collection of Shapes, each of which contain the actual geometrical data such as vertices,
* normals, uvs, etc. It also contains a reference to an animation class, which defines how the geometry moves.
* A Graphics object is assigned to a Sprite, a scene graph occurence of the geometry, which in turn assigns
* the SubGeometries to its respective TriangleGraphic objects.
*
*
*
*
* @class Graphics
*/
export declare class Graphics extends AssetBase {
private static _pool;
static getShapeForBitmap(bitmap: BitmapImage2D, rect: Rectangle): Shape<TriangleElements>;
static getShapeForBitmapStyle(shapeStyle: ShapeStyle, flashBox: BBox): Shape<TriangleElements>;
static getGraphics(): Graphics;
static clearPool(): void;
static assetType: string;
private _bitmapFillPool;
private _queuedShapeTags;
private _shapes;
private _style;
private _queued_fill_pathes;
private _queued_stroke_pathes;
private _active_fill_path;
private _active_stroke_path;
private _lineStyle;
private _fillStyle;
private _current_position;
tryOptimiseSigleImage: boolean;
private _lastPrebuildedShapes;
private _drawingDirty;
usages: number;
_start: GraphicsPath[];
_end: GraphicsPath[];
_clearCount: number;
private _internalShapesId;
private _rFillPool;
private _rStrokePool;
private _poolingConfig;
sourceGraphics: Graphics;
get start(): GraphicsPath[];
get end(): GraphicsPath[];
set start(v: GraphicsPath[]);
set end(v: GraphicsPath[]);
get assetType(): string;
get count(): number;
get queued_stroke_pathes(): Array<GraphicsPath>;
set queued_stroke_pathes(value: Array<GraphicsPath>);
get queued_fill_pathes(): Array<GraphicsPath>;
set queued_fill_pathes(value: Array<GraphicsPath>);
add_queued_path(value: GraphicsPath, supressFill?: boolean): void;
/**
* Creates a new Graphics object.
*/
constructor();
set internalPoolConfig(v: {
stroke: boolean;
fill: boolean;
} | boolean);
get internalPoolConfig(): {
stroke: boolean;
fill: boolean;
} | boolean;
popEmptyFillShape(): Shape<import("@awayjs/renderer").ElementsBase>;
popEmptyStrokeShape(): Shape<import("@awayjs/renderer").ElementsBase>;
addShapeInternal(shape: Shape<any>): void;
/**
* Adds a GraphicBase wrapping a Elements.
*
* @param elements
*/
addShape(shape: Shape<any>): Shape;
removeShape(shape: Shape): void;
removeShapeAt(index: number): void;
getShapeAt(index: number): Shape;
getShapeIndex(shape: Shape): number;
applyTransformation(transform: Matrix3D): void;
copyTo(graphics: Graphics, cloneShapes?: boolean): void;
clone(cloneShapes?: boolean): Graphics;
/**
* Scales the geometry.
* @param scale The amount by which to scale.
*/
scale(scale: number): void;
private tryPoolShape;
clear(): void;
/**
* Clears all resources used by the Graphics object, including SubGeometries.
*/
dispose(): void;
/**
* Scales the uv coordinates (tiling)
* @param scaleU The amount by which to scale on the u axis. Default is 1;
* @param scaleV The amount by which to scale on the v axis. Default is 1;
*/
scaleUV(scaleU?: number, scaleV?: number): void;
_acceptTraverser(traverser: IEntityTraverser): void;
/**
* Fills a drawing area with a bitmap image. The bitmap can be repeated or
* tiled to fill the area. The fill remains in effect until you call the
* <code>beginFill()</code>, <code>beginBitmapFill()</code>,
* <code>beginGradientFill()</code>, or <code>beginShaderFill()</code>
* method. Calling the <code>clear()</code> method clears the fill.
*
* <p>The application renders the fill whenever three or more points are
* drawn, or when the <code>endFill()</code> method is called. </p>
*
* @param bitmap A transparent or opaque bitmap image that contains the bits
* to be displayed.
* @param matrix A matrix object(of the flash.geom.Matrix class), which you
* can use to define transformations on the bitmap. For
* example, you can use the following matrix to rotate a bitmap
* by 45 degrees(pi/4 radians):
* @param repeat If <code>true</code>, the bitmap image repeats in a tiled
* pattern. If <code>false</code>, the bitmap image does not
* repeat, and the edges of the bitmap are used for any fill
* area that extends beyond the bitmap.
*
* <p>For example, consider the following bitmap(a 20 x
* 20-pixel checkerboard pattern):</p>
*
* <p>When <code>repeat</code> is set to <code>true</code>(as
* in the following example), the bitmap fill repeats the
* bitmap:</p>
*
* <p>When <code>repeat</code> is set to <code>false</code>,
* the bitmap fill uses the edge pixels for the fill area
* outside the bitmap:</p>
* @param smooth If <code>false</code>, upscaled bitmap images are rendered
* by using a nearest-neighbor algorithm and look pixelated. If
* <code>true</code>, upscaled bitmap images are rendered by
* using a bilinear algorithm. Rendering by using the nearest
* neighbor algorithm is faster.
*/
beginBitmapFill(bitmap: BitmapImage2D, matrix?: Matrix, repeat?: boolean, smooth?: boolean): void;
/**
* Specifies a simple one-color fill that subsequent calls to other Graphics
* methods(such as <code>lineTo()</code> or <code>drawCircle()</code>) use
* when drawing. The fill remains in effect until you call the
* <code>beginFill()</code>, <code>beginBitmapFill()</code>,
* <code>beginGradientFill()</code>, or <code>beginShaderFill()</code>
* method. Calling the <code>clear()</code> method clears the fill.
*
* <p>The application renders the fill whenever three or more points are
* drawn, or when the <code>endFill()</code> method is called.</p>
*
* @param color The color of the fill(0xRRGGBB).
* @param alpha The alpha value of the fill(0.0 to 1.0).
*/
beginFill(color: number, alpha?: number): void;
/**
* Specifies a gradient fill used by subsequent calls to other Graphics
* methods(such as <code>lineTo()</code> or <code>drawCircle()</code>) for
* the object. The fill remains in effect until you call the
* <code>beginFill()</code>, <code>beginBitmapFill()</code>,
* <code>beginGradientFill()</code>, or <code>beginShaderFill()</code>
* method. Calling the <code>clear()</code> method clears the fill.
*
* <p>The application renders the fill whenever three or more points are
* drawn, or when the <code>endFill()</code> method is called. </p>
*
* @param type A value from the GradientType class that
* specifies which gradient type to use:
* <code>GradientType.LINEAR</code> or
* <code>GradientType.RADIAL</code>.
* @param colors An array of RGB hexadecimal color values used
* in the gradient; for example, red is 0xFF0000,
* blue is 0x0000FF, and so on. You can specify
* up to 15 colors. For each color, specify a
* corresponding value in the alphas and ratios
* parameters.
* @param alphas An array of alpha values for the corresponding
* colors in the colors array; valid values are 0
* to 1. If the value is less than 0, the default
* is 0. If the value is greater than 1, the
* default is 1.
* @param ratios An array of color distribution ratios; valid
* values are 0-255. This value defines the
* percentage of the width where the color is
* sampled at 100%. The value 0 represents the
* left position in the gradient box, and 255
* represents the right position in the gradient
* box.
* @param matrix A transformation matrix as defined by the
* flash.geom.Matrix class. The flash.geom.Matrix
* class includes a
* <code>createGradientBox()</code> method, which
* lets you conveniently set up the matrix for use
* with the <code>beginGradientFill()</code>
* method.
* @param spreadMethod A value from the SpreadMethod class that
* specifies which spread method to use, either:
* <code>SpreadMethod.PAD</code>,
* <code>SpreadMethod.REFLECT</code>, or
* <code>SpreadMethod.REPEAT</code>.
*
* <p>For example, consider a simple linear
* gradient between two colors:</p>
*
* <p>This example uses
* <code>SpreadMethod.PAD</code> for the spread
* method, and the gradient fill looks like the
* following:</p>
*
* <p>If you use <code>SpreadMethod.REFLECT</code>
* for the spread method, the gradient fill looks
* like the following:</p>
*
* <p>If you use <code>SpreadMethod.REPEAT</code>
* for the spread method, the gradient fill looks
* like the following:</p>
* @param interpolationMethod A value from the InterpolationMethod class that
* specifies which value to use:
* <code>InterpolationMethod.LINEAR_RGB</code> or
* <code>InterpolationMethod.RGB</code>
*
* <p>For example, consider a simple linear
* gradient between two colors(with the
* <code>spreadMethod</code> parameter set to
* <code>SpreadMethod.REFLECT</code>). The
* different interpolation methods affect the
* appearance as follows: </p>
* @param focalPointRatio A number that controls the location of the
* focal point of the gradient. 0 means that the
* focal point is in the center. 1 means that the
* focal point is at one border of the gradient
* circle. -1 means that the focal point is at the
* other border of the gradient circle. A value
* less than -1 or greater than 1 is rounded to -1
* or 1. For example, the following example shows
* a <code>focalPointRatio</code> set to 0.75:
* @throws ArgumentError If the <code>type</code> parameter is not valid.
*/
beginGradientFill(type: GradientType, colors: number[], alphas: number[], ratios: number[], matrix?: Matrix, spreadMethod?: string, interpolationMethod?: string, focalPointRatio?: number): void;
/**
* Copies all of drawing commands from the source Graphics object into the
* calling Graphics object.
*
* @param sourceGraphics The Graphics object from which to copy the drawing
* commands.
*/
copyFrom(sourceGraphics: Graphics): void;
/**
* Draws a cubic Bezier curve from the current drawing position to the
* specified anchor point. Cubic Bezier curves consist of two anchor points
* and two control points. The curve interpolates the two anchor points and
* curves toward the two control points.
*
* The four points you use to draw a cubic Bezier curve with the
* <code>cubicCurveTo()</code> method are as follows:
*
* <ul>
* <li>The current drawing position is the first anchor point. </li>
* <li>The anchorX and anchorY parameters specify the second anchor point.
* </li>
* <li>The <code>controlX1</code> and <code>controlY1</code> parameters
* specify the first control point.</li>
* <li>The <code>controlX2</code> and <code>controlY2</code> parameters
* specify the second control point.</li>
* </ul>
*
* If you call the <code>cubicCurveTo()</code> method before calling the
* <code>moveTo()</code> method, your curve starts at position (0, 0).
*
* If the <code>cubicCurveTo()</code> method succeeds, the Flash runtime sets
* the current drawing position to (<code>anchorX</code>,
* <code>anchorY</code>). If the <code>cubicCurveTo()</code> method fails,
* the current drawing position remains unchanged.
*
* If your movie clip contains content created with the Flash drawing tools,
* the results of calls to the <code>cubicCurveTo()</code> method are drawn
* underneath that content.
*
* @param controlX1 Specifies the horizontal position of the first control
* point relative to the registration point of the parent
* display object.
* @param controlY1 Specifies the vertical position of the first control
* point relative to the registration point of the parent
* display object.
* @param controlX2 Specifies the horizontal position of the second control
* point relative to the registration point of the parent
* display object.
* @param controlY2 Specifies the vertical position of the second control
* point relative to the registration point of the parent
* display object.
* @param anchorX Specifies the horizontal position of the anchor point
* relative to the registration point of the parent display
* object.
* @param anchorY Specifies the vertical position of the anchor point
* relative to the registration point of the parent display
* object.
*/
cubicCurveTo(controlX1: number, controlY1: number, controlX2: number, controlY2: number, anchorX: number, anchorY: number): void;
/**
* Draws a curve using the current line style from the current drawing
* position to(anchorX, anchorY) and using the control point that
* (<code>controlX</code>, <code>controlY</code>) specifies. The current
* drawing position is then set to(<code>anchorX</code>,
* <code>anchorY</code>). If the movie clip in which you are drawing contains
* content created with the Flash drawing tools, calls to the
* <code>curveTo()</code> method are drawn underneath this content. If you
* call the <code>curveTo()</code> method before any calls to the
* <code>moveTo()</code> method, the default of the current drawing position
* is(0, 0). If any of the parameters are missing, this method fails and the
* current drawing position is not changed.
*
* <p>The curve drawn is a quadratic Bezier curve. Quadratic Bezier curves
* consist of two anchor points and one control point. The curve interpolates
* the two anchor points and curves toward the control point. </p>
*
* @param controlX A number that specifies the horizontal position of the
* control point relative to the registration point of the
* parent display object.
* @param controlY A number that specifies the vertical position of the
* control point relative to the registration point of the
* parent display object.
* @param anchorX A number that specifies the horizontal position of the
* next anchor point relative to the registration point of
* the parent display object.
* @param anchorY A number that specifies the vertical position of the next
* anchor point relative to the registration point of the
* parent display object.
*/
curveTo(controlX: number, controlY: number, anchorX: number, anchorY: number): void;
/**
* Draws a circle. Set the line style, fill, or both before you call the
* <code>drawCircle()</code> method, by calling the <code>linestyle()</code>,
* <code>lineGradientStyle()</code>, <code>beginFill()</code>,
* <code>beginGradientFill()</code>, or <code>beginBitmapFill()</code>
* method.
*
* @param x The <i>x</i> location of the center of the circle relative
* to the registration point of the parent display object(in
* pixels).
* @param y The <i>y</i> location of the center of the circle relative
* to the registration point of the parent display object(in
* pixels).
* @param radius The radius of the circle(in pixels).
*/
drawCircle(x: number, y: number, radius: number): void;
/**
* Draws an ellipse. Set the line style, fill, or both before you call the
* <code>drawEllipse()</code> method, by calling the
* <code>linestyle()</code>, <code>lineGradientStyle()</code>,
* <code>beginFill()</code>, <code>beginGradientFill()</code>, or
* <code>beginBitmapFill()</code> method.
*
* @param x The <i>x</i> location of the top-left of the bounding-box of
* the ellipse relative to the registration point of the parent
* display object(in pixels).
* @param y The <i>y</i> location of the top left of the bounding-box of
* the ellipse relative to the registration point of the parent
* display object(in pixels).
* @param width The width of the ellipse(in pixels).
* @param height The height of the ellipse(in pixels).
*/
drawEllipse(x: number, y: number, width: number, height: number): void;
/**
* Submits a series of IGraphicsData instances for drawing. This method
* accepts a Vector containing objects including paths, fills, and strokes
* that implement the IGraphicsData interface. A Vector of IGraphicsData
* instances can refer to a part of a shape, or a complex fully defined set
* of data for rendering a complete shape.
*
* <p> Graphics paths can contain other graphics paths. If the
* <code>graphicsData</code> Vector includes a path, that path and all its
* sub-paths are rendered during this operation. </p>
*
*/
drawGraphicsData(graphicsData: Array<IGraphicsData>): void;
/**
* Submits a series of commands for drawing. The <code>drawPath()</code>
* method uses vector arrays to consolidate individual <code>moveTo()</code>,
* <code>lineTo()</code>, and <code>curveTo()</code> drawing commands into a
* single call. The <code>drawPath()</code> method parameters combine drawing
* commands with x- and y-coordinate value pairs and a drawing direction. The
* drawing commands are values from the GraphicsPathCommand class. The x- and
* y-coordinate value pairs are Numbers in an array where each pair defines a
* coordinate location. The drawing direction is a value from the
* GraphicsPathWinding class.
*
* <p> Generally, drawings render faster with <code>drawPath()</code> than
* with a series of individual <code>lineTo()</code> and
* <code>curveTo()</code> methods. </p>
*
* <p> The <code>drawPath()</code> method uses a uses a floating computation
* so rotation and scaling of shapes is more accurate and gives better
* results. However, curves submitted using the <code>drawPath()</code>
* method can have small sub-pixel alignment errors when used in conjunction
* with the <code>lineTo()</code> and <code>curveTo()</code> methods. </p>
*
* <p> The <code>drawPath()</code> method also uses slightly different rules
* for filling and drawing lines. They are: </p>
*
* <ul>
* <li>When a fill is applied to rendering a path:
* <ul>
* <li>A sub-path of less than 3 points is not rendered.(But note that the
* stroke rendering will still occur, consistent with the rules for strokes
* below.)</li>
* <li>A sub-path that isn't closed(the end point is not equal to the
* begin point) is implicitly closed.</li>
* </ul>
* </li>
* <li>When a stroke is applied to rendering a path:
* <ul>
* <li>The sub-paths can be composed of any number of points.</li>
* <li>The sub-path is never implicitly closed.</li>
* </ul>
* </li>
* </ul>
*
* @param winding Specifies the winding rule using a value defined in the
* GraphicsPathWinding class.
*/
drawPath(commands: Int32Array, data: Float64Array, winding: GraphicsPathWinding): void;
private _drawPathInternal;
/**
* Draws a rectangle. Set the line style, fill, or both before you call the
* <code>drawRect()</code> method, by calling the <code>linestyle()</code>,
* <code>lineGradientStyle()</code>, <code>beginFill()</code>,
* <code>beginGradientFill()</code>, or <code>beginBitmapFill()</code>
* method.
*
* @param x A number indicating the horizontal position relative to the
* registration point of the parent display object(in pixels).
* @param y A number indicating the vertical position relative to the
* registration point of the parent display object(in pixels).
* @param width The width of the rectangle(in pixels).
* @param height The height of the rectangle(in pixels).
* @throws ArgumentError If the <code>width</code> or <code>height</code>
* parameters are not a number
* (<code>Number.NaN</code>).
*/
drawRect(x: number, y: number, width: number, height: number): void;
/**
* Draws a rounded rectangle. Set the line style, fill, or both before you
* call the <code>drawRoundRect()</code> method, by calling the
* <code>linestyle()</code>, <code>lineGradientStyle()</code>,
* <code>beginFill()</code>, <code>beginGradientFill()</code>, or
* <code>beginBitmapFill()</code> method.
*
* @param x A number indicating the horizontal position relative
* to the registration point of the parent display
* object(in pixels).
* @param y A number indicating the vertical position relative to
* the registration point of the parent display object
* (in pixels).
* @param width The width of the round rectangle(in pixels).
* @param height The height of the round rectangle(in pixels).
* @param ellipseWidth The width of the ellipse used to draw the rounded
* corners(in pixels).
* @param ellipseHeight The height of the ellipse used to draw the rounded
* corners(in pixels). Optional; if no value is
* specified, the default value matches that provided
* for the <code>ellipseWidth</code> parameter.
* @throws ArgumentError If the <code>width</code>, <code>height</code>,
* <code>ellipseWidth</code> or
* <code>ellipseHeight</code> parameters are not a
* number(<code>Number.NaN</code>).
*/
drawRoundRect(x: number, y: number, width: number, height: number, ellipseWidth: number, ellipseHeight?: number): void;
drawRoundRectComplex(x: number, y: number, width: number, height: number, topLeftRadius: number, topRightRadius: number, bottomLeftRadius: number, bottomRightRadius: number): void;
/**
* Renders a set of triangles, typically to distort bitmaps and give them a
* three-dimensional appearance. The <code>drawTriangles()</code> method maps
* either the current fill, or a bitmap fill, to the triangle faces using a
* set of(u,v) coordinates.
*
* <p> Any type of fill can be used, but if the fill has a transform matrix
* that transform matrix is ignored. </p>
*
* <p> A <code>uvtData</code> parameter improves texture mapping when a
* bitmap fill is used. </p>
*
* @param culling Specifies whether to render triangles that face in a
* specified direction. This parameter prevents the rendering
* of triangles that cannot be seen in the current view. This
* parameter can be set to any value defined by the
* TriangleCulling class.
*/
drawTriangles(vertices: Array<number>, indices?: Array<number>, uvtData?: Array<number>, culling?: TriangleCulling): void;
/**
* Applies a fill to the lines and curves that were added since the last call
* to the <code>beginFill()</code>, <code>beginGradientFill()</code>, or
* <code>beginBitmapFill()</code> method. Flash uses the fill that was
* specified in the previous call to the <code>beginFill()</code>,
* <code>beginGradientFill()</code>, or <code>beginBitmapFill()</code>
* method. If the current drawing position does not equal the previous
* position specified in a <code>moveTo()</code> method and a fill is
* defined, the path is closed with a line and then filled.
*
*/
endFill(): void;
private _endFillInternal;
/**
* Specifies a bitmap to use for the line stroke when drawing lines.
*
* <p>The bitmap line style is used for subsequent calls to Graphics methods
* such as the <code>lineTo()</code> method or the <code>drawCircle()</code>
* method. The line style remains in effect until you call the
* <code>lineStyle()</code> or <code>lineGradientStyle()</code> methods, or
* the <code>lineBitmapStyle()</code> method again with different parameters.
* </p>
*
* <p>You can call the <code>lineBitmapStyle()</code> method in the middle of
* drawing a path to specify different styles for different line segments
* within a path. </p>
*
* <p>Call the <code>lineStyle()</code> method before you call the
* <code>lineBitmapStyle()</code> method to enable a stroke, or else the
* value of the line style is <code>undefined</code>.</p>
*
* <p>Calls to the <code>clear()</code> method set the line style back to
* <code>undefined</code>. </p>
*
* @param bitmap The bitmap to use for the line stroke.
* @param matrix An optional transformation matrix as defined by the
* flash.geom.Matrix class. The matrix can be used to scale or
* otherwise manipulate the bitmap before applying it to the
* line style.
* @param repeat Whether to repeat the bitmap in a tiled fashion.
* @param smooth Whether smoothing should be applied to the bitmap.
*/
lineBitmapStyle(bitmap: BitmapImage2D, matrix?: Matrix, repeat?: boolean, smooth?: boolean): void;
/**
* Specifies a gradient to use for the stroke when drawing lines.
*
* <p>The gradient line style is used for subsequent calls to Graphics
* methods such as the <code>lineTo()</code> methods or the
* <code>drawCircle()</code> method. The line style remains in effect until
* you call the <code>lineStyle()</code> or <code>lineBitmapStyle()</code>
* methods, or the <code>lineGradientStyle()</code> method again with
* different parameters. </p>
*
* <p>You can call the <code>lineGradientStyle()</code> method in the middle
* of drawing a path to specify different styles for different line segments
* within a path. </p>
*
* <p>Call the <code>lineStyle()</code> method before you call the
* <code>lineGradientStyle()</code> method to enable a stroke, or else the
* value of the line style is <code>undefined</code>.</p>
*
* <p>Calls to the <code>clear()</code> method set the line style back to
* <code>undefined</code>. </p>
*
* @param type A value from the GradientType class that
* specifies which gradient type to use, either
* GradientType.LINEAR or GradientType.RADIAL.
* @param colors An array of RGB hexadecimal color values used
* in the gradient; for example, red is 0xFF0000,
* blue is 0x0000FF, and so on. You can specify
* up to 15 colors. For each color, specify a
* corresponding value in the alphas and ratios
* parameters.
* @param alphas An array of alpha values for the corresponding
* colors in the colors array; valid values are 0
* to 1. If the value is less than 0, the default
* is 0. If the value is greater than 1, the
* default is 1.
* @param ratios An array of color distribution ratios; valid
* values are 0-255. This value defines the
* percentage of the width where the color is
* sampled at 100%. The value 0 represents the
* left position in the gradient box, and 255
* represents the right position in the gradient
* box.
* @param matrix A transformation matrix as defined by the
* flash.geom.Matrix class. The flash.geom.Matrix
* class includes a
* <code>createGradientBox()</code> method, which
* lets you conveniently set up the matrix for use
* with the <code>lineGradientStyle()</code>
* method.
* @param spreadMethod A value from the SpreadMethod class that
* specifies which spread method to use:
* @param interpolationMethod A value from the InterpolationMethod class that
* specifies which value to use. For example,
* consider a simple linear gradient between two
* colors(with the <code>spreadMethod</code>
* parameter set to
* <code>SpreadMethod.REFLECT</code>). The
* different interpolation methods affect the
* appearance as follows:
* @param focalPointRatio A number that controls the location of the
* focal point of the gradient. The value 0 means
* the focal point is in the center. The value 1
* means the focal point is at one border of the
* gradient circle. The value -1 means that the
* focal point is at the other border of the
* gradient circle. Values less than -1 or greater
* than 1 are rounded to -1 or 1. The following
* image shows a gradient with a
* <code>focalPointRatio</code> of -0.75:
*/
lineGradientStyle(type: GradientType, colors: Array<number>, alphas: Array<number>, ratios: Array<number>, matrix?: Matrix, spreadMethod?: SpreadMethod, interpolationMethod?: InterpolationMethod, focalPointRatio?: number): void;
/**
* Specifies a shader to use for the line stroke when drawing lines.
*
* <p>The shader line style is used for subsequent calls to Graphics methods
* such as the <code>lineTo()</code> method or the <code>drawCircle()</code>
* method. The line style remains in effect until you call the
* <code>lineStyle()</code> or <code>lineGradientStyle()</code> methods, or
* the <code>lineBitmapStyle()</code> method again with different parameters.
* </p>
*
* <p>You can call the <code>lineShaderStyle()</code> method in the middle of
* drawing a path to specify different styles for different line segments
* within a path. </p>
*
* <p>Call the <code>lineStyle()</code> method before you call the
* <code>lineShaderStyle()</code> method to enable a stroke, or else the
* value of the line style is <code>undefined</code>.</p>
*
* <p>Calls to the <code>clear()</code> method set the line style back to
* <code>undefined</code>. </p>
*
* @param shader The shader to use for the line stroke.
* @param matrix An optional transformation matrix as defined by the
* flash.geom.Matrix class. The matrix can be used to scale or
* otherwise manipulate the bitmap before applying it to the
* line style.
*/
/**
* Specifies a line style used for subsequent calls to Graphics methods such
* as the <code>lineTo()</code> method or the <code>drawCircle()</code>
* method. The line style remains in effect until you call the
* <code>lineGradientStyle()</code> method, the
* <code>lineBitmapStyle()</code> method, or the <code>lineStyle()</code>
* method with different parameters.
*
* <p>You can call the <code>lineStyle()</code> method in the middle of
* drawing a path to specify different styles for different line segments
* within the path.</p>
*
* <p><b>Note: </b>Calls to the <code>clear()</code> method set the line
* style back to <code>undefined</code>.</p>
*
* <p><b>Note: </b>Flash Lite 4 supports only the first three parameters
* (<code>thickness</code>, <code>color</code>, and <code>alpha</code>).</p>
*
* @param thickness An integer that indicates the thickness of the line in
* points; valid values are 0-255. If a number is not
* specified, or if the parameter is undefined, a line is
* not drawn. If a value of less than 0 is passed, the
* default is 0. The value 0 indicates hairline
* thickness; the maximum thickness is 255. If a value
* greater than 255 is passed, the default is 255.
* @param color A hexadecimal color value of the line; for example,
* red is 0xFF0000, blue is 0x0000FF, and so on. If a
* value is not indicated, the default is 0x000000
* (black). Optional.
* @param alpha A number that indicates the alpha value of the color
* of the line; valid values are 0 to 1. If a value is
* not indicated, the default is 1(solid). If the value
* is less than 0, the default is 0. If the value is
* greater than 1, the default is 1.
* @param pixelHinting(Not supported in Flash Lite 4) A Boolean value that
* specifies whether to hint strokes to full pixels. This
* affects both the position of anchors of a curve and
* the line stroke size itself. With
* <code>pixelHinting</code> set to <code>true</code>,
* line widths are adjusted to full pixel widths. With
* <code>pixelHinting</code> set to <code>false</code>,
* disjoints can appear for curves and straight lines.
* For example, the following illustrations show how
* Flash Player or Adobe AIR renders two rounded
* rectangles that are identical, except that the
* <code>pixelHinting</code> parameter used in the
* <code>lineStyle()</code> method is set differently
* (the images are scaled by 200%, to emphasize the
* difference):
*
* <p>If a value is not supplied, the line does not use
* pixel hinting.</p>
* @param scaleMode (Not supported in Flash Lite 4) A value from the
* LineScaleMode class that specifies which scale mode to
* use:
* <ul>
* <li> <code>LineScaleMode.NORMAL</code> - Always
* scale the line thickness when the object is scaled
* (the default). </li>
* <li> <code>LineScaleMode.NONE</code> - Never scale
* the line thickness. </li>
* <li> <code>LineScaleMode.VERTICAL</code> - Do not
* scale the line thickness if the object is scaled
* vertically <i>only</i>. For example, consider the
* following circles, drawn with a one-pixel line, and
* each with the <code>scaleMode</code> parameter set to
* <code>LineScaleMode.VERTICAL</code>. The circle on the
* left is scaled vertically only, and the circle on the
* right is scaled both vertically and horizontally:
* </li>
* <li> <code>LineScaleMode.HORIZONTAL</code> - Do not
* scale the line thickness if the object is scaled
* horizontally <i>only</i>. For example, consider the
* following circles, drawn with a one-pixel line, and
* each with the <code>scaleMode</code> parameter set to
* <code>LineScaleMode.HORIZONTAL</code>. The circle on
* the left is scaled horizontally only, and the circle
* on the right is scaled both vertically and
* horizontally: </li>
* </ul>
* @param caps (Not supported in Flash Lite 4) A value from the
* CapsStyle class that specifies the type of caps at the
* end of lines. Valid values are:
* <code>CapsStyle.NONE</code>,
* <code>CapsStyle.ROUND</code>, and
* <code>CapsStyle.SQUARE</code>. If a value is not
* indicated, Flash uses round caps.
*
* <p>For example, the following illustrations show the
* different <code>capsStyle</code> settings. For each
* setting, the illustration shows a blue line with a
* thickness of 30(for which the <code>capsStyle</code>
* applies), and a superimposed black line with a
* thickness of 1(for which no <code>capsStyle</code>
* applies): </p>
* @param joints (Not supported in Flash Lite 4) A value from the
* JointStyle class that specifies the type of joint
* appearance used at angles. Valid values are:
* <code>JointStyle.BEVEL</code>,
* <code>JointStyle.MITER</code>, and
* <code>JointStyle.ROUND</code>. If a value is not
* indicated, Flash uses round joints.
*
* <p>For example, the following illustrations show the
* different <code>joints</code> settings. For each
* setting, the illustration shows an angled blue line
* with a thickness of 30(for which the
* <code>jointStyle</code> applies), and a superimposed
* angled black line with a thickness of 1(for which no
* <code>jointStyle</code> applies): </p>
*
* <p><b>Note:</b> For <code>joints</code> set to
* <code>JointStyle.MITER</code>, you can use the
* <code>miterLimit</code> parameter to limit the length
* of the miter.</p>
* @param miterLimit (Not supported in Flash Lite 4) A number that
* indicates the limit at which a miter is cut off. Valid
* values range from 1 to 255(and values outside that
* range are rounded to 1 or 255). This value is only
* used if the <code>jointStyle</code> is set to
* <code>"miter"</code>. The <code>miterLimit</code>
* value represents the length that a miter can extend
* beyond the point at which the lines meet to form a
* joint. The value expresses a factor of the line
* <code>thickness</code>. For example, with a
* <code>miterLimit</code> factor of 2.5 and a
* <code>thickness</code> of 10 pixels, the miter is cut
* off at 25 pixels.
*
* <p>For example, consider the following angled lines,
* each drawn with a <code>thickness</code> of 20, but
* with <code>miterLimit</code> set to 1, 2, and 4.
* Superimposed are black reference lines showing the
* meeting points of the joints:</p>
*
* <p>Notice that a given <code>miterLimit</code> value
* has a specific maximum angle for which the miter is
* cut off. The following table lists some examples:</p>
*/
lineStyle(thickness?: number, color?: number, alpha?: number, pixelHinting?: boolean, scaleMode?: LineScaleMode, capstyle?: number, jointstyle?: number, miterLimit?: number): void;
/**
* Draws a line using the current line style from the current drawing
* position to(<code>x</code>, <code>y</code>); the current drawing position
* is then set to(<code>x</code>, <code>y</code>). If the display object in
* which you are drawing contains content that was created with the Flash
* drawing tools, calls to the <code>lineTo()</code> method are drawn
* underneath the content. If you call <code>lineTo()</code> before any calls
* to the <code>moveTo()</code> method, the default position for the current
* drawing is(<i>0, 0</i>). If any of the parameters are missing, this
* method fails and the current drawing position is not changed.
*
* @param x A number that indicates the horizontal position relative to the
* registration point of the parent display object(in pixels).
* @param y A number that indicates the vertical position relative to the
* registration point of the parent display object(in pixels).
*/
lineTo(x: number, y: number): void;
/**
* Moves the current drawing position to(<code>x</code>, <code>y</code>). If
* any of the parameters are missing, this method fails and the current
* drawing position is not changed.
*
* @param x A number that indicates the horizontal position relative to the
* registration point of the parent display object(in pixels).
* @param y A number that indicates the vertical position relative to the
* registration point of the parent display object(in pixels).
*/
moveTo(x: number, y: number): void;
private processLazyTesselation;
queueShapeTag(shapeTag: ShapeTag): void;
private _updateFillPath;
private _updateLinePath;
private _addShapes;
_isShapeMaterial(material: IMaterial): boolean;
convertRecordsToShapeData(tag: ShapeTag, supressFill?: boolean): void;
private transformCurve;
}
//# sourceMappingURL=Graphics.d.ts.map