Class Point

constructor

• new Point(x?, y?): Point

• Parameters

  • Optionalx: number
  • Optionaly: number

  Returns Point

• new Point(p): Point

• Parameters

  • p: string | PlainPoint

  Returns Point

type

x

y

add

• add(p): this

• Parameters

  • p: Point

  Returns this

adhereToRect

• adhereToRect(r): this

• Parameters

  • r: Rect

  Returns this

angleBetween

• angleBetween(p1, p2): number

• Parameters

  • p1: PlainPoint
  • p2: PlainPoint

  Returns number

bearing

• bearing(p): CardinalDirection

• Parameters

  • p: Point

  Returns CardinalDirection

changeInAngle

• changeInAngle(dx, dy, ref): number

• Parameters

  • dx: number
  • dy: number
  • ref: string | PlainPoint

  Returns number

chooseClosest

• chooseClosest(points): null | Point

• Parameters

  • points: PlainPoint[]

  Returns null | Point

clone

• clone(): Point

• Returns Point

cross

• cross(p1, p2): number

• Parameters

  • p1: PlainPoint
  • p2: PlainPoint

  Returns number

difference

• difference(dx?, dy?): Point

• Parameters

  • Optionaldx: number
  • Optionaldy: number

  Returns Point

• difference(p): Point

• Parameters

  • p: PlainPoint

  Returns Point

distance

• distance(p): number

• Parameters

  • p: string | PlainPoint

  Returns number

dot

• dot(p): number

• Parameters

  • p: PlainPoint

  Returns number

equals

• equals(p): boolean

• Parameters

  • p: Point

  Returns boolean

getMiddlePoint

• getMiddlePoint(p2): Point

• Parameters

  • p2: Point

  Returns Point

length

• length(): number

• Returns number

lerp

• lerp(p, t): Point

• Parameters

  • p: Point
  • t: number

  Returns Point

magnitude

• magnitude(): number

• Returns number

manhattanDistance

• manhattanDistance(p): number

• Parameters

  • p: PlainPoint

  Returns number

move

• move(ref, distance): this

• Parameters

  • ref: string | PlainPoint
  • distance: number

  Returns this

multiplyScalar

• multiplyScalar(scalar): this

• Parameters

  • scalar: number

  Returns this

normalize

• normalize(length?): this

• Parameters

  • Optionallength: number

  Returns this

offset

• offset(dx?, dy?): this

• Parameters

  • Optionaldx: number
  • Optionaldy: number

  Returns this

• offset(p): this

• Parameters

  • p: PlainPoint

  Returns this

reflection

• reflection(ref): Point

• Parameters

  • ref: string | PlainPoint

  Returns Point

rotate

• rotate(origin, angle): this

• Parameters

  • origin: string | PlainPoint
  • angle: number

  Returns this

round

• round(precision?): this

• Parameters

  • Optionalprecision: number

  Returns this

scale

• scale(sx, sy, origin?): this

• Parameters

  • sx: number
  • sy: number
  • Optionalorigin: string | PlainPoint

  Returns this

serialize

• serialize(): string

• Returns string

snapToGrid

• snapToGrid(gx, gy?): this

• Parameters

  • gx: number
  • Optionalgy: number

  Returns this

squaredDistance

• squaredDistance(p): number

• Parameters

  • p: string | PlainPoint

  Returns number

theta

• theta(p): number

• Parameters

  • p: string | PlainPoint

  Returns number

toJSON

• toJSON(): PlainPoint

• Returns PlainPoint

toPolar

• toPolar(origin?): this

• Parameters

  • Optionalorigin: string | PlainPoint

  Returns this

toString

• toString(): string

• Returns a string representation of an object.

  Returns string

translate

• translate(tx?, ty?): this

• Parameters

  • Optionaltx: number
  • Optionalty: number

  Returns this

• translate(tx): this

• Parameters

  • tx: PlainPoint

  Returns this

update

• update(x?, y?): this

• Parameters

  • Optionalx: number
  • Optionaly: number

  Returns this

• update(p): this

• Parameters

  • p: PlainPoint

  Returns this

vectorAngle

• vectorAngle(p): number

• Parameters

  • p: PlainPoint

  Returns number

StaticfromPolar

• fromPolar(distance, angle, origin?): Point

• Parameters

  • distance: number
  • angle: number
  • Optionalorigin: string | PlainPoint

  Returns Point

Staticrandom

• random(x1, x2, y1, y2): Point

• Parameters

  • x1: number
  • x2: number
  • y1: number
  • y2: number

  Returns Point