Class Point

Index

Constructors

constructor

new Point(): Point
Returns Point
Description
Create a point with coordinates (0, 0)
- Defined in src/utils/datatypes/point/point.ts:10
new Point(n: number): Point
Parameters
- n: number
  The input value
Returns Point
Description
Create a point with coordinates (n, n)
- Defined in src/utils/datatypes/point/point.ts:15
new Point(x: number, y: number): Point
Parameters
- x: number
  The x coordinate
- y: number
  The y coordinate
Returns Point
Description
Create a point with coordinates (x, y)
- Defined in src/utils/datatypes/point/point.ts:21
new Point(e: { clientX: number; clientY: number }): Point
Parameters
- e: { clientX: number; clientY: number }
  The coordinates
Returns Point
Description
Create a point with the clientX/clientY values. Useful for events.
- Defined in src/utils/datatypes/point/point.ts:26
new Point(p: Coordinate): Point
Parameters
- p: Coordinate
  The coordinates (or Point)
Returns Point
Description
Create a point with the provided coordinates
- Defined in src/utils/datatypes/point/point.ts:31
new Point(arr: [number, number]): Point
Parameters
- arr: [number, number]
  The array of size 2.
Returns Point
Description
Create a point with the provided [x, y] values.
- Defined in src/utils/datatypes/point/point.ts:36
new Point(
    x:
        | number
        | Coordinate
        | [number, number]
        | { clientX: number; clientY: number },
): Point
Parameters
- x: number | Coordinate | [number, number] | { clientX: number; clientY: number }
Returns Point
- Defined in src/utils/datatypes/point/point.ts:37

Properties

`Readonly`x

x: number

`Readonly`y

y: number

Accessors

object

get object(): Coordinate
Returns Coordinate
- Defined in src/utils/datatypes/point/point.ts:101

abs

get abs(): Point
Returns Point
A new Point object with the absolute values

Description
Calculate the absolute value of the coordinates
- Defined in src/utils/datatypes/point/point.ts:273

max

get max(): number
Returns number
The maximum value

Description
Get the maximum value between x and y coordinates
- Defined in src/utils/datatypes/point/point.ts:281

min

get min(): number
Returns number
The minimum value

Description
Get the minimum value between x and y coordinates
- Defined in src/utils/datatypes/point/point.ts:289

length2

get length2(): number
Returns number
- Defined in src/utils/datatypes/point/point.ts:293

length

get length(): number
Returns number
- Defined in src/utils/datatypes/point/point.ts:297

Methods

`Static`dist

dist(p1: Coordinate, p2: Coordinate): number
Parameters
- p1: Coordinate
  First point
- p2: Coordinate
  Second point
Returns number
Description
Calculate the distance between two Position2D points.
- Defined in src/utils/datatypes/point/point.ts:62

`Static`midPoint

midPoint(...arr: Coordinate[]): Point
Parameters
- ...arr: Coordinate[]
  Undetermined number of point parameters
Returns Point
Description
Calculate the mid-point from the provided points
- Defined in src/utils/datatypes/point/point.ts:70

`Static`max

max(...arr: Coordinate[]): Point
Parameters
- ...arr: Coordinate[]
  Undetermined number of point parameters
Returns Point
Description
Calculate the max on both x and y from the provided points
- Defined in src/utils/datatypes/point/point.ts:81

`Static`min

min(...arr: Coordinate[]): Point
Parameters
- ...arr: Coordinate[]
  Undetermined number of point parameters
Returns Point
Description
Calculate the min on both x and y from the provided points
- Defined in src/utils/datatypes/point/point.ts:92

equals

equals(p: Coordinate): boolean
Parameters
- p: Coordinate
  The coordinates to compare it to
Returns boolean
A boolean indicating whether they are equal

Description
Determine whether this point is equal to the provided coordinates
- Defined in src/utils/datatypes/point/point.ts:110
equals(x: number, y: number): boolean
Parameters
- x: number
  The x coordinate
- y: number
  The y coordinate
Returns boolean
A boolean indicating whether they are equal

Description
Determine whether this point is equal to the provided coordinates
- Defined in src/utils/datatypes/point/point.ts:117

boundX

boundX(x1: number, x2: number): number
Parameters
- x1: number
- x2: number
Returns number
- Defined in src/utils/datatypes/point/point.ts:123

boundY

boundY(y1: number, y2: number): number
Parameters
- y1: number
- y2: number
Returns number
- Defined in src/utils/datatypes/point/point.ts:129

bound

bound(n1: number, n2: number): Point
Parameters
- n1: number
- n2: number
Returns Point
- Defined in src/utils/datatypes/point/point.ts:135

add

add(n: number): Point
Parameters
- n: number
  The value to add to both x and y
Returns Point
A new Point object with the result

Description
Add coordinates to this point
- Defined in src/utils/datatypes/point/point.ts:145
add(x: number, y: number): Point
Parameters
- x: number
  The value to add to the x coordinate
- y: number
  The value to add to the y coordinate
Returns Point
A new Point object with the result

Description
Add coordinates to this point
- Defined in src/utils/datatypes/point/point.ts:152
add(p: Coordinate): Point
Parameters
- p: Coordinate
  The coordinates to add
Returns Point
A new Point object with the result

Description
Add coordinates to this point
- Defined in src/utils/datatypes/point/point.ts:158

sub

sub(n: number): Point
Parameters
- n: number
  The value to subtract from both x and y
Returns Point
A new Point object with the result

Description
Subtract coordinates from this point
- Defined in src/utils/datatypes/point/point.ts:169
sub(x: number, y: number): Point
Parameters
- x: number
  The value to subtract from the x coordinate
- y: number
  The value to subtract from the y coordinate
Returns Point
A new Point object with the result

Description
Subtract coordinates from this point
- Defined in src/utils/datatypes/point/point.ts:176
sub(p: Coordinate): Point
Parameters
- p: Coordinate
  The coordinates to subtract
Returns Point
A new Point object with the result

Description
Subtract coordinates from this point
- Defined in src/utils/datatypes/point/point.ts:182

mul

mul(n: number): Point
Parameters
- n: number
  The value to multiply both x and y
Returns Point
A new Point object with the result

Description
Multiply coordinates of this point
- Defined in src/utils/datatypes/point/point.ts:193
mul(x: number, y: number): Point
Parameters
- x: number
  The value to multiply the x coordinate
- y: number
  The value to multiply the y coordinate
Returns Point
A new Point object with the result

Description
Multiply coordinates of this point
- Defined in src/utils/datatypes/point/point.ts:200
mul(p: Coordinate): Point
Parameters
- p: Coordinate
  The coordinates to multiply
Returns Point
A new Point object with the result

Description
Multiply coordinates of this point
- Defined in src/utils/datatypes/point/point.ts:206

div

div(n: number): Point
Parameters
- n: number
  The value to divide both x and y
Returns Point
A new Point object with the result

Description
Divide coordinates of this point
- Defined in src/utils/datatypes/point/point.ts:217
div(x: number, y: number): Point
Parameters
- x: number
  The value to divide the x coordinate
- y: number
  The value to divide the y coordinate
Returns Point
A new Point object with the result

Description
Divide coordinates of this point
- Defined in src/utils/datatypes/point/point.ts:224
div(p: Coordinate): Point
Parameters
- p: Coordinate
  The coordinates to divide with
Returns Point
A new Point object with the result

Description
Divide coordinates of this point
- Defined in src/utils/datatypes/point/point.ts:230

mod

mod(n: number): Point
Parameters
- n: number
  The value to mod both x and y
Returns Point
A new Point object with the result

Description
Mod coordinates of this point
- Defined in src/utils/datatypes/point/point.ts:241
mod(x: number, y: number): Point
Parameters
- x: number
  The value to mod the x coordinate
- y: number
  The value to mod the y coordinate
Returns Point
A new Point object with the result

Description
Mod coordinates of this point
- Defined in src/utils/datatypes/point/point.ts:248
mod(p: Coordinate): Point
Parameters
- p: Coordinate
  The coordinates to mod with
Returns Point
A new Point object with the result

Description
Mod coordinates of this point
- Defined in src/utils/datatypes/point/point.ts:254

dot

dot(p: Point): number
Parameters
- p: Point
Returns number
- Defined in src/utils/datatypes/point/point.ts:301

copy

copy(): Point
Returns Point
A new Point object with the same coordinates

Description
Create a copy of the current point
- Defined in src/utils/datatypes/point/point.ts:309

arr

arr(): number[]
Returns number[]
An array with x and y coordinates

Description
Get the coordinates as an array
- Defined in src/utils/datatypes/point/point.ts:317

Class Point

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Point

Description

Parameters

Returns Point

Description

Parameters

Returns Point

Description

Parameters

Returns Point

Description

Parameters

Returns Point

Description

Parameters

Returns Point

Description

Parameters

Returns Point

Properties

Readonlyx

Readonlyy

Accessors

object

Returns Coordinate

abs

Returns Point

Description

max

Returns number

Description

min

Returns number

Description

length2

Returns number

length

Returns number

Methods

Staticdist

Parameters

Returns number

Description

StaticmidPoint

Parameters

Returns Point

Description

Staticmax

Parameters

Returns Point

Description

Staticmin

Parameters

Returns Point

Description

equals

Parameters

Returns boolean

Description

Parameters

Returns boolean

Description

boundX

Parameters

Returns number

boundY

Parameters

Returns number

bound

Parameters

Returns Point

add

`Readonly`x

`Readonly`y

`Static`dist

`Static`midPoint

`Static`max

`Static`min