Path
Constructor
constructor
constructor(from = null: ?AdsumLocation, to = null: ?AdsumLocation, pmr = false: boolean): Path
Parameters:
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| from | ?AdsumLocation | null | No | |
| to | ?AdsumLocation | null | No | |
| pmr | boolean | false | No |
Properties
computed
| Type | Read-Only | Description |
|---|---|---|
| boolean | YES |
from
| Type | Read-Only | Description |
|---|---|---|
| ?AdsumLocation | YES |
pathSections
Deprecated: Use getPathSections instead
| Type | Read-Only | Description |
|---|---|---|
| PathSection[] | YES |
pmr
| Type | Read-Only | Description |
|---|---|---|
| boolean | YES |
to
| Type | Read-Only | Description |
|---|---|---|
| ?AdsumLocation | YES |
Methods
getDistance
getDistance(): ?number
Returns:
Returns null if the path is not computed yet.
Type: ?number
getPathSections
getPathSections(includeInterGround = false): PathSection[]
Parameters:
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| includeInterGround | boolean | No | false | Boolean indicating if you want to include or not the inter ground path section |
Returns:
Type: PathSection[]
Note that
getPathSections()is equivalent to legacy pathSections
getPrecedingPathSections
getPrecedingPathSections(pathSection: PathSection): PathSection[]
Gets pathSection before a given one.
Parameters:
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| pathSection | PathSection | Yes | - |
Returns:
Type: PathSection[]