Members summary
| Name | Description |
|---|---|
| navigationInstructionRadius | radius in meters to use when moving the camera to the beginning of an instruction. |
Methods summary
| Name | Description |
|---|---|
| displayNextInstruction | displays the next instruction if possible and move the camera to the start of the instruction |
| displayPrevInstruction | displays the previous instruction if possible and move the camera to the start of the instruction |
| getCurrentInstructionIndex | returns the index of the current instruction |
| getInstructionData | returns the instruction data for the given index |
| getInstructionHeading | returns the 3 heading values associated to a particular instruction: start, end and whole. |
| getInstructionViewpointPosition | returns the viewpoint position for a particular instruction. |
| getNbInstructions | returns the number of instructions for the current navigation |
Members detail
navigationInstructionRadius :number
radius in meters to use when moving the camera to the beginning of an instruction.
Methods detail
displayNextInstruction(animateCameraopt, withHeadingopt) → {Promise}
displays the next instruction if possible and move the camera to the start of the instruction
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
animateCamera |
Boolean |
<optional> |
true | |
withHeading |
Boolean |
<optional> |
false |
Returns:
- Type
- Promise
displayPrevInstruction(animateCameraopt, withHeadingopt) → {Promise}
displays the previous instruction if possible and move the camera to the start of the instruction
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
animateCamera |
Boolean |
<optional> |
true | |
withHeading |
Boolean |
<optional> |
false |
Returns:
- Type
- Promise
getCurrentInstructionIndex() → {number}
returns the index of the current instruction
Returns:
- Type
- number
getInstructionData(index) → {Object}
returns the instruction data for the given index
Parameters:
| Name | Type | Description |
|---|---|---|
index |
number |
Returns:
- Type
- Object
getInstructionHeading(index) → {Object}
returns the 3 heading values associated to a particular instruction: start, end and whole.
Parameters:
| Name | Type | Description |
|---|---|---|
index |
number |
Returns:
triplet {start, end, whole}, start being the heading direction at the beginning of the instruction,
end towards the end, whole representing the global direction of this instruction.
- Type
- Object
getInstructionViewpointPosition(index, headingopt) → {Object}
returns the viewpoint position for a particular instruction.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
index |
number | ||
heading |
number |
<optional> |
Returns:
camera position object {x,y,radius}
- Type
- Object
getNbInstructions() → {number}
returns the number of instructions for the current navigation
Returns:
- Type
- number