Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Point2

2D Point in Cartesian coordinate.

Hierarchy

  • Point2

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Point2(): Point2
  • new Point2(x: number, y: number): Point2

  • Returns Point2

  • Parameters

    • x: number
    • y: number

    Returns Point2

Properties

x

x: number

y

y: number

Static ORIGIN

ORIGIN: Point2 = new Point2(0, 0)

Methods

clamp

  • clamp(min: number, max: number): this

  • Clamps this point to the range [min, max].

    Parameters

    • min: number
    • max: number

    Returns this

clampMax

  • clampMax(max: number): this

  • Clamps the maximum value of this point to the max parameter.

    Parameters

    • max: number

    Returns this

clampMin

  • clampMin(min: number): this

  • Clamps the minimum value of this point to the min parameter.

    Parameters

    • min: number

    Returns this

clone

distance

  • distance(x: number, y: number): number

  • Computes the distance between this point and point p.

    Parameters

    • x: number
    • y: number

    Returns number

distanceL1

  • distanceL1(x: number, y: number): number

  • Computes the L-1 (Manhattan) distance between this point and point p. The L-1 distance is equal to: abs(x1-x2) + abs(y1-y2).

    Parameters

    • x: number
    • y: number

    Returns number

distanceLinf

  • distanceLinf(x: number, y: number): number

  • Computes the L-infinite distance between this point and point p1. The L-infinite distance is equal to MAX[abs(x1-x2), abs(y1-y2)].

    Parameters

    • x: number
    • y: number

    Returns number

distanceSq

  • distanceSq(x: number, y: number): number

  • Computes the square of the distance between this point and point p.

    Parameters

    • x: number
    • y: number

    Returns number

equals

  • Returns true if the L-infinite distance between this point and point p is less than or equal to the epsilon parameter, otherwise returns false. The L-infinite distance is equal to MAX[abs(x1-x2), abs(y1-y2), . . . ].

    Parameters

    Returns boolean

moveTo

  • moveTo(x: number, y: number): this

  • Parameters

    • x: number
    • y: number

    Returns this

radian

  • radian(): number

  • The radian between this point and X axis.
    计算点与X轴的夹角。

    Returns number

set

toArray

toPolar

toward

  • toward(step: number, rad: number): this

  • Move point toward along the radian.

    Parameters

    • step: number
    • rad: number

    Returns this

translate

  • translate(x: number, y: number): this

  • Parameters

    • x: number
    • y: number

    Returns this

Static distance

  • distance(x1: number, y1: number, x2: number, y2: number): number

  • Computes the distance between p1 and p2.

    Parameters

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

    Returns number

Static distanceSq

  • distanceSq(x1: number, y1: number, x2: number, y2: number): number

  • Computes the square of the distance between p1 and p2.

    Parameters

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

    Returns number

Static equal

  • equal(p1: ArrayPoint2, p2: ArrayPoint2): boolean
  • equal(x1: number, y1: number, x2: number, y2: number): boolean

  • Parameters

    Returns boolean

  • Parameters

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

    Returns boolean

Static isOrigin

  • isOrigin(x: number, y: number): boolean

  • Parameters

    • x: number
    • y: number

    Returns boolean

Static polar2xy

Static radian

  • radian(x1: number, y1: number, x2?: number, y2?: number): number

  • The radian between the line(p1, origin) or the line(p1, p2) and X-axis.
    计算点到原点的连线与X轴的夹角的弧度。

    Parameters

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

    Returns number

Static toArray

Static toPoint

Static xy2polar