A standalone point geometry with useful accessor, comparison, and
modification methods.
Parameters
parameter
type
description
x
Number
the x-coordinate. this could be longitude or screen pixels, or any other sort of unit.
y
Number
the y-coordinate. this could be latitude or screen pixels, or any other sort of unit.
Example
var point = new Point(-77, 38);
clone
Clone this point, returning a new point that can be modified
without affecting the old one.
ReturnsPoint, the clone
add(p)
Add this point's x & y coordinates to another point,
yielding a new point.
Parameters
parameter
type
description
p
Point
the other point
ReturnsPoint, output point
sub(p)
Subtract this point's x & y coordinates to from point,
yielding a new point.
Parameters
parameter
type
description
p
Point
the other point
ReturnsPoint, output point
multByPoint(p)
Multiply this point's x & y coordinates by point,
yielding a new point.
Parameters
parameter
type
description
p
Point
the other point
ReturnsPoint, output point
divByPoint(p)
Divide this point's x & y coordinates by point,
yielding a new point.
Parameters
parameter
type
description
p
Point
the other point
ReturnsPoint, output point
mult(k)
Multiply this point's x & y coordinates by a factor,
yielding a new point.
Parameters
parameter
type
description
k
Point
factor
ReturnsPoint, output point
div(k)
Divide this point's x & y coordinates by a factor,
yielding a new point.
Parameters
parameter
type
description
k
Point
factor
ReturnsPoint, output point
rotate(a)
Rotate this point around the 0, 0 origin by an angle a,
given in radians
Parameters
parameter
type
description
a
Number
angle to rotate around, in radians
ReturnsPoint, output point
rotateAround(a, p)
Rotate this point around p point by an angle a,
given in radians
Parameters
parameter
type
description
a
Number
angle to rotate around, in radians
p
Point
Point to rotate around
ReturnsPoint, output point
matMult(m)
Multiply this point by a 4x1 transformation matrix
Parameters
parameter
type
description
m
Array.<Number>
transformation matrix
ReturnsPoint, output point
unit
Calculate this point but as a unit vector from 0, 0, meaning
that the distance from the resulting point to the 0, 0
coordinate will be equal to 1 and the angle from the resulting
point to the 0, 0 coordinate will be the same as before.
ReturnsPoint, unit vector point
perp
Compute a perpendicular point, where the new y coordinate
is the old x coordinate and the new x coordinate is the old y
coordinate multiplied by -1
ReturnsPoint, perpendicular point
round
Return a version of this point with the x & y coordinates
rounded to integers.
ReturnsPoint, rounded point
mag
Return the magitude of this point: this is the Euclidean
distance from the 0, 0 coordinate to this point's x and y
coordinates.
ReturnsNumber, magnitude
equals(other)
Judge whether this point is equal to another point, returning
true or false.
Parameters
parameter
type
description
other
Point
the other point
Returnsboolean, whether the points are equal
dist(p)
Calculate the distance from this point to another point
Parameters
parameter
type
description
p
Point
the other point
ReturnsNumber, distance
distSqr(p)
Calculate the distance from this point to another point,
without the square root step. Useful if you're comparing
relative distances.
Parameters
parameter
type
description
p
Point
the other point
ReturnsNumber, distance
angle
Get the angle from the 0, 0 coordinate to this point, in radians
coordinates.
ReturnsNumber, angle
angleTo(b)
Get the angle from this point to another point, in radians
Parameters
parameter
type
description
b
Point
the other point
ReturnsNumber, angle
angleWith(b)
Get the angle between this point and another point, in radians
Parameters
parameter
type
description
b
Point
the other point
ReturnsNumber, angle
angleWithSep(x, y)
Find the angle of the two vectors, solving the formula for
the cross product a x b = |a||b|sin(θ) for θ.
Parameters
parameter
type
description
x
Number
the x-coordinate
y
Number
the y-coordinate
ReturnsNumber, the angle in radians
convert(a)
Construct a point from an array if necessary, otherwise if the input
is already a Point, or an unknown type, return it unchanged
Parameters
parameter
type
description
a
Array.<Number>,Point
any kind of input value
Example
// thisvar point = Point.convert([0, 1]);// is equivalent tovar point = new Point(0, 1);
ReturnsPoint, constructed point, or passed-through value.