/** * 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:
* *You can use the new Point() constructor to create a Point
* object.
true if the object is equal to this Point
* object; false 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
* dx is added to the original value of x to create the
* new x value. The value of dy 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 "(x=x,
* y=y)", so calling the toString() method for a
* point at 23,17 would return "(x=23, y=17)".
*
* @return The string representation of the coordinates.
*/
toString(): string;
/**
* Returns the distance between pt1 and pt2.
*
* @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
* f determines where the new interpolated point is located
* relative to the two end points specified by parameters pt1
* and pt2. The closer the value of the parameter f
* is to 1.0, the closer the interpolated point is to the first
* point(parameter pt1). The closer the value of the parameter
* f is to 0, the closer the interpolated point is to the second
* point(parameter pt2).
*
* @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
* pt1 and pt2. If f=1,
* pt1 is returned; if f=0,
* pt2 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