Point

Source: AWT.js:584

Contains the x andy y coordinates of a point, and provides some useful methods.

Constructor

Point constructor

Parameters

• x (number | Point) — When x is an Point object, a clone of it will be created.
• y (number, optional) — Not used when x is an Point

Instance Methods

setProperties($xml: external:jQuery): module:AWT.Point

Reads the properties of this Point from an XML element

Parameters

• $xml (external:jQuery) — The xml element to be parsed

Returns

• module:AWT.Point

getAttributes(): object

Gets a object with the basic attributes needed to rebuild this instance excluding functions,
parent references, constants and also attributes retaining the default value.
The resulting object is commonly usued to serialize elements in JSON format.

Returns

• object

setAttributes(data: object): module:AWT.Point

Reads the properties of this Point from a data object

Parameters

• data (object) — The data object to be parsed

Returns

• module:AWT.Point

moveBy(delta: Point | Dimension): module:AWT.Point

Moves this Point to a new position, by a specified displacement

Parameters

• delta (Point | Dimension) — The amount to move

Returns

• module:AWT.Point

moveTo(newPos: number | Point, y?: number): module:AWT.Point

Moves this Point to a new position

Parameters

• newPos (number | Point) — The new position, or a x coordinate
• y (number, optional) — null or undefined when newPos is a Point

Returns

• module:AWT.Point

multBy(delta: Point | Dimension): module:AWT.Point

Multiplies the x and y coordinates by a specified delta

Parameters

• delta (Point | Dimension) — The amount to multiply by.

Returns

• module:AWT.Point

equals(p: module:AWT.Point): boolean

Checks if two points are at the same place

Parameters

• p (module:AWT.Point) — The Point to check against to

Returns

• boolean

distanceTo(point: module:AWT.Point): number

Calculates the distance between two points

Parameters

• point (module:AWT.Point) — The Point to calculate the distance against to

Returns

• number

clone(): module:AWT.Point

Clones this point

Returns

• module:AWT.Point

Instance Fields

x: number

y: number