Spaces:
Sleeping
Sleeping
File size: 7,013 Bytes
cd6720a | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 | # @mapbox/point-geometry
A `Point` class for representing point geometry with useful utility methods.
## Installation
```sh
$ npm install @mapbox/point-geometry
```
## API
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
### Point
A standalone point geometry with useful accessor, comparison, and
modification methods.
#### Parameters
* `x` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** the x-coordinate. This could be longitude or screen pixels, or any other sort of unit.
* `y` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** the y-coordinate. This could be latitude or screen pixels, or any other sort of unit.
#### Examples
```javascript
const point = new Point(-77, 38);
```
#### clone
Clone this point, returning a new point that can be modified
without affecting the old one.
Returns **[Point](#point)** the clone
#### add
Add this point's x & y coordinates to another point,
yielding a new point.
##### Parameters
* `p` **[Point](#point)** the other point
Returns **[Point](#point)** output point
#### sub
Subtract this point's x & y coordinates to from point,
yielding a new point.
##### Parameters
* `p` **[Point](#point)** the other point
Returns **[Point](#point)** output point
#### multByPoint
Multiply this point's x & y coordinates by point,
yielding a new point.
##### Parameters
* `p` **[Point](#point)** the other point
Returns **[Point](#point)** output point
#### divByPoint
Divide this point's x & y coordinates by point,
yielding a new point.
##### Parameters
* `p` **[Point](#point)** the other point
Returns **[Point](#point)** output point
#### mult
Multiply this point's x & y coordinates by a factor,
yielding a new point.
##### Parameters
* `k` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** factor
Returns **[Point](#point)** output point
#### div
Divide this point's x & y coordinates by a factor,
yielding a new point.
##### Parameters
* `k` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** factor
Returns **[Point](#point)** output point
#### rotate
Rotate this point around the 0, 0 origin by an angle a,
given in radians
##### Parameters
* `a` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** angle to rotate around, in radians
Returns **[Point](#point)** output point
#### rotateAround
Rotate this point around p point by an angle a,
given in radians
##### Parameters
* `a` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** angle to rotate around, in radians
* `p` **[Point](#point)** Point to rotate around
Returns **[Point](#point)** output point
#### matMult
Multiply this point by a 4x1 transformation matrix
##### Parameters
* `m` **\[[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number), [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number), [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number), [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)]** transformation matrix
Returns **[Point](#point)** 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.
Returns **[Point](#point)** 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
Returns **[Point](#point)** perpendicular point
#### round
Return a version of this point with the x & y coordinates
rounded to integers.
Returns **[Point](#point)** rounded point
#### mag
Return the magnitude of this point: this is the Euclidean
distance from the 0, 0 coordinate to this point's x and y
coordinates.
Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** magnitude
#### equals
Judge whether this point is equal to another point, returning
true or false.
##### Parameters
* `other` **[Point](#point)** the other point
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** whether the points are equal
#### dist
Calculate the distance from this point to another point
##### Parameters
* `p` **[Point](#point)** the other point
Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** distance
#### distSqr
Calculate the distance from this point to another point,
without the square root step. Useful if you're comparing
relative distances.
##### Parameters
* `p` **[Point](#point)** the other point
Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** distance
#### angle
Get the angle from the 0, 0 coordinate to this point, in radians
coordinates.
Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** angle
#### angleTo
Get the angle from this point to another point, in radians
##### Parameters
* `b` **[Point](#point)** the other point
Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** angle
#### angleWith
Get the angle between this point and another point, in radians
##### Parameters
* `b` **[Point](#point)** the other point
Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** angle
#### angleWithSep
Find the angle of the two vectors, solving the formula for
the cross product a x b = |a||b|sin(θ) for θ.
##### Parameters
* `x` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** the x-coordinate
* `y` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** the y-coordinate
Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** the angle in radians
#### convert
Construct a point from an array if necessary, otherwise if the input
is already a Point, or an unknown type, return it unchanged
##### Parameters
* `a` **(\[[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number), [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)] | [Point](#point))** any kind of input value
##### Examples
```javascript
// this
var point = Point.convert([0, 1]);
// is equivalent to
var point = new Point(0, 1);
```
Returns **[Point](#point)** constructed point, or passed-through value.
|