Class Point

The Point is specified by a x coordinate and a y coordinate.

Hierarchy

Point

Index

Constructors

Properties

Accessors

x y

Methods

add clone compare copy div isNull manhattanDist mul neg sub

Constructors

constructor

new Point(x?, y?): Point
Constructs a point with the given coordinates (x, y).
Parameters
- x: number = 0
- y: number = 0
Returns Point
- Defined in core/point.ts:11

Properties

`Private` m_x

m_x: number

`Private` m_y

m_y: number

Accessors

x

get x(): number
Returns the x coordinate of this point.

Returns number
- Defined in core/point.ts:19
set x(x): void
Sets the x coordinate of this point to the given x coordinate.
Parameters
- x: number
Returns void
- Defined in core/point.ts:26

y

get y(): number
Returns the y coordinate of this point.

Returns number
- Defined in core/point.ts:33
set y(y): void
Sets the y coordinate of this point to the given y coordinate.
Parameters
- y: number
Returns void
- Defined in core/point.ts:40

Methods

add

add(other): void
Adds the given point to this point. See also sub
Parameters
- other: Point
Returns void
- Defined in core/point.ts:69

clone

clone(): Point
Returns a copy of this point.

Returns Point
- Defined in core/point.ts:109

compare

compare(other): boolean
Returns true if this point and other are equal; otherwise returns false.
Parameters
- other: Point
Returns boolean
- Defined in core/point.ts:116

copy

copy(other): void
Copies the other point to this point.
Parameters
- other: Point
Returns void
- Defined in core/point.ts:101

div

div(divisor): void
Divides both x and y by the given divisor. See also mul
Parameters
- divisor: number
Returns void
- Defined in core/point.ts:93

isNull

isNull(): boolean
Returns true if both the x and y coordinates are set to 0, otherwise returns false.

Returns boolean
- Defined in core/point.ts:54

manhattanDist

manhattanDist(): number
Returns the sum of the absolute values of x and y.

Returns number
- Defined in core/point.ts:47

mul

mul(factor): void
Multiplies this point's coordinates by the given factor. See also div
Parameters
- factor: number
Returns void
- Defined in core/point.ts:85

neg

neg(): void
Changes the sign of both components.

Returns void
- Defined in core/point.ts:61

sub

sub(other): void
Subtracts the given point from this point. See also add
Parameters
- other: Point
Returns void
- Defined in core/point.ts:77

Generated using TypeDoc