/ fm / liveswitch / Point
Class: Point
fm.liveswitch.Point
A point (x and y coordinates).
Table of contents
Constructors
Methods
- fmliveswitchPointInit
- getTypeString
- getX
- getY
- isEquivalent
- setX
- setY
- toJson
- toString
- fromJson
- getEmpty
- isEquivalent
- toJson
Constructors
constructor
+ new Point(): Point
Initializes a new instance of the [[fm.liveswitch.point]] class.
Returns: Point
Defined in: Generated/TypeScript/fm.liveswitch/Point.ts:23
+ new Point(x: number, y: number): Point
Initializes a new instance of the [[fm.liveswitch.point]] class.
Parameters:
| Name | Type | Description |
|---|---|---|
x |
number | The X coordinate. |
y |
number | The Y coordinate. |
Returns: Point
Defined in: Generated/TypeScript/fm.liveswitch/Point.ts:29
Methods
fmliveswitchPointInit
▸ PrivatefmliveswitchPointInit(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Point.ts:19
getTypeString
▸ getTypeString(): string
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/Point.ts:9
getX
▸ getX(): number
Gets the X coordinate.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/Point.ts:157
getY
▸ getY(): number
Gets the Y coordinate.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/Point.ts:169
isEquivalent
▸ isEquivalent(point: Point): boolean
Determines whether the specified point is equivalent.
Parameters:
| Name | Type | Description |
|---|---|---|
point |
Point | The point. |
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/Point.ts:182
setX
▸ setX(value: number): void
Sets the X coordinate.
Parameters:
| Name | Type |
|---|---|
value |
number |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Point.ts:194
setY
▸ setY(value: number): void
Sets the Y coordinate.
Parameters:
| Name | Type |
|---|---|
value |
number |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Point.ts:207
toJson
▸ toJson(): string
Serializes this instance to JSON.
Returns: string
The serialized JSON.
Defined in: Generated/TypeScript/fm.liveswitch/Point.ts:223
toString
▸ toString(): string
Returns a string that represents this instance using format "{x},{y}".
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/Point.ts:235
fromJson
▸ StaticfromJson(pointJson: string): Point
Deserializes an instance from JSON.
Parameters:
| Name | Type | Description |
|---|---|---|
pointJson |
string | The JSON to deserialize. |
Returns: Point
The deserialized point.
Defined in: Generated/TypeScript/fm.liveswitch/Point.ts:66
getEmpty
▸ StaticgetEmpty(): Point
Gets the empty point (0,0).
Returns: Point
Defined in: Generated/TypeScript/fm.liveswitch/Point.ts:91
isEquivalent
▸ StaticisEquivalent(point1: Point, point2: Point): boolean
Determines whether the two points are equivalent.
Parameters:
| Name | Type | Description |
|---|---|---|
point1 |
Point | The first point. |
point2 |
Point | The second point. |
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/Point.ts:108
toJson
▸ StatictoJson(point: Point): string
Serializes an instance to JSON.
Parameters:
| Name | Type | Description |
|---|---|---|
point |
Point | The point. |
Returns: string
The serialized JSON.
Defined in: Generated/TypeScript/fm.liveswitch/Point.ts:138