Class Point`Beta`

A class for a Point

Index

Constructors

Properties

x y

Accessors

Methods

collidePoint copy distanceTo equals from rotate toString from rotate

Constructors

constructor

new Point(x: number, y: number): Point
Beta
Parameters
- x: number
- y: number
Returns Point
- Defined in Point.class.ts:14

Properties

`Beta`x

x: number

The x coordinate of the Point

`Beta`y

y: number

The y coordinate of the Point

Accessors

array

get array(): PointArray
Beta
The Point as a PointArray.

Returns PointArray
- Defined in Point.class.ts:51
set array(point: PointArray): void
Beta
Parameters
- point: PointArray
Returns void
- Defined in Point.class.ts:54

Methods

collidePoint

collidePoint(other: PointArray | Point): boolean
Alpha
Parameters
- other: PointArray | Point
  the Point or PointArray to compare
Returns boolean
true if the Point is equal to the given Point or PointArray
- Defined in Point.class.ts:108

copy

copy(): Point
Beta
Returns Point
a copy of the Point
- Defined in Point.class.ts:99

distanceTo

distanceTo(other: Point): number
Alpha
Calculates the distance between two Points
Parameters
- other: Point
  the other Point
Returns number
the distance between two Points
- Defined in Point.class.ts:136

equals

equals(other: Point): boolean
Beta
Parameters
- other: Point
  the other Point
Returns boolean
true if the Point is equal to the given Point
- Defined in Point.class.ts:126

from

from(other: PointArray | Point): void
Beta
Updates the Point to equal the given Point or PointArray
Parameters
- other: PointArray | Point
  the Point or PointArray to copy
Returns void
- Defined in Point.class.ts:87

rotate

rotate(theta: number, origin?: PointArray | Point): void
Alpha
Rotates the given point by theta around a given origin
Parameters
- theta: number
  the amount in radians to rotate
- origin: PointArray | Point = ...
  the origin to rotate around (default: (0, 0))
Returns void
- Defined in Point.class.ts:67

toString

toString(): string
Beta
Returns string
a string representation of the Point
- Defined in Point.class.ts:118

`Static`from

from(other: PointArray | Point): Point
Beta
Constructs a new Point from a given Point or PointArray
Parameters
- other: PointArray | Point
  Point or PointArray to copy
Returns Point
the new Point
- Defined in Point.class.ts:27

`Static`rotate

rotate(point: Point, theta: number, origin?: Point): Point
Alpha
Parameters
- point: Point
  the point to rotate
- theta: number
  the amount in radians to rotate
- origin: Point = ...
  the origin to rotate around (default: (0, 0))
Returns Point
a new Point rotated around the given Point
- Defined in Point.class.ts:40