@awayjs/core

/** * The Point object represents a location in a two-dimensional coordinate * system, where x represents the horizontal axis and y * represents the vertical axis. * * The following code creates a point at(0,0): * * Methods and properties of the following classes use Point objects: * * <ul> * <li>BitmapData</li> * <li>DisplayObject</li> * <li>DisplayObjectContainer</li> * <li>DisplacementMapFilter</li> * <li>NativeWindow</li> * <li>Matrix</li> * <li>Rectangle</li> * </ul> * * You can use the <code>new Point()</code> constructor to create a Point * object. */ export declare class Point { _rawData: Float32Array; /** * The horizontal coordinate of the point. The default value is 0. */ get x(): number; set x(value: number); /** * The vertical coordinate of the point. The default value is 0. */ get y(): number; set y(value: number); /** * The length of the line segment from(0,0) to this point. */ get length(): number; /** * Creates a new point. If you pass no parameters to this method, a point is * created at(0,0). * * @param x The horizontal coordinate. * @param y The vertical coordinate. */ constructor(x?: number, y?: number); /** * Adds the coordinates of another point to the coordinates of this point to * create a new point. * * @param v The point to be added. * @return The new point. */ add(v: Point): Point; /** * Creates a copy of this Point object. * * @return The new Point object. */ clone(): Point; copyFrom(sourcePoint: Point): void; /** * Determines whether two points are equal. Two points are equal if they have * the same x and y values. * * @param toCompare The point to be compared. * @return A value of <code>true</code> if the object is equal to this Point * object; <code>false</code> if it is not equal. */ equals(toCompare: Point): boolean; /** * Scales the line segment between(0,0) and the current point to a set * length. * * @param thickness The scaling value. For example, if the current point is * (0,5), and you normalize it to 1, the point returned is * at(0,1). */ normalize(thickness?: number): void; /** * Offsets the Point object by the specified amount. The value of * <code>dx</code> is added to the original value of x to create the * new x value. The value of <code>dy</code> is added to the original * value of y to create the new y value. * * @param dx The amount by which to offset the horizontal coordinate, * x. * @param dy The amount by which to offset the vertical coordinate, y. */ offset(dx: number, dy: number): void; setTo(xa: number, ya: number): void; /** * Subtracts the coordinates of another point from the coordinates of this * point to create a new point. * * @param v The point to be subtracted. * @return The new point. */ subtract(v: Point): Point; /** * Returns a string that contains the values of the x and y * coordinates. The string has the form <code>"(x=x, * y=y)"</code>, so calling the <code>toString()</code> method for a * point at 23,17 would return <code>"(x=23, y=17)"</code>. * * @return The string representation of the coordinates. */ toString(): string; /** * Returns the distance between <code>pt1</code> and <code>pt2</code>. * * @param pt1 The first point. * @param pt2 The second point. * @return The distance between the first and second points. */ static distance(pt1: Point, pt2: Point): number; /** * Determines a point between two specified points. The parameter * <code>f</code> determines where the new interpolated point is located * relative to the two end points specified by parameters <code>pt1</code> * and <code>pt2</code>. The closer the value of the parameter <code>f</code> * is to <code>1.0</code>, the closer the interpolated point is to the first * point(parameter <code>pt1</code>). The closer the value of the parameter * <code>f</code> is to 0, the closer the interpolated point is to the second * point(parameter <code>pt2</code>). * * @param pt1 The first point. * @param pt2 The second point. * @param f The level of interpolation between the two points. Indicates * where the new point will be, along the line between * <code>pt1</code> and <code>pt2</code>. If <code>f</code>=1, * <code>pt1</code> is returned; if <code>f</code>=0, * <code>pt2</code> is returned. * @return The new, interpolated point. */ static interpolate(pt1: Point, pt2: Point, f: number): Point; /** * Converts a pair of polar coordinates to a Cartesian point coordinate. * * @param len The length coordinate of the polar pair. * @param angle The angle, in radians, of the polar pair. * @return The Cartesian point. */ static polar(len: number, angle: number): Point; } //# sourceMappingURL=Point.d.ts.map