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):
var myPoint = new Point();
Methods and properties of the following classes use Point objects:
You can use the new Point() constructor to create a
Point object.
length:Number [read-only]
The length of the line segment from (0,0) to this point.
See also
var x:Number
The horizontal coordinate of the point. The default value is 0.
var y:Number
The vertical coordinate of the point. The default value is 0.
function Point(x:Number = 0, y:Number = 0)
Creates a new point. If you pass no parameters to this method, a point is created at (0,0).
Parameters | x:Number (default = 0) — The horizontal coordinate.
|
| |
| y:Number (default = 0) — The vertical coordinate.
|
function add(v:Point):Point
Adds the coordinates of another point to the coordinates of this point to create a new point.
Parameters
| v:Point — The point to be added.
|
Returns function clone():Point
Creates a copy of this Point object.
Returns | Point — The new Point object.
|
function distance(pt1:Point, pt2:Point):Number
Returns the distance between pt1 and pt2.
Parameters
| pt1:Point — The first point.
|
| |
| pt2:Point — The second point.
|
Returns | Number — The distance between the first and second points.
|
function equals(toCompare:Point):Boolean
Determines whether two points are equal. Two points are equal if they have the same x and
y values.
Parameters
| toCompare:Point — The point to be compared.
|
Returns | Boolean — A value of true if the object is equal to this Point object; false if it is not equal.
|
function interpolate(pt1:Point, pt2:Point, f:Number):Point
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).
Parameters
| pt1:Point — The first point.
|
| |
| pt2:Point — The second point.
|
| |
| f:Number — 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.
|
Returns | Point — The new, interpolated point.
|
function normalize(thickness:Number):void
Scales the line segment between (0,0) and the current point to a set length.
Parameters
| thickness:Number — 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).
|
See also
function offset(dx:Number, dy: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.
Parameters
| dx:Number — The amount by which to offset the horizontal coordinate, x.
|
| |
| dy:Number — The amount by which to offset the vertical coordinate, y.
|
function polar(len:Number, angle:Number):Point
Converts a pair of polar coordinates to a Cartesian point coordinate.
Parameters
| len:Number — The length coordinate of the polar pair.
|
| |
| angle:Number — The angle, in radians, of the polar pair.
|
Returns | Point — The Cartesian point.
|
See also
function subtract(v:Point):Point
Subtracts the coordinates of another point from the coordinates of this point to create a new
point.
Parameters
| v:Point — The point to be subtracted.
|
Returns function toString():String
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)".
Returns | String — The string representation of the coordinates.
|
© 2009 Adobe Systems Incorporated. All rights reserved.
Fri Feb 20 2009, 11:31 AM -08:00