`openspace.pathnavigation`

Functions overview

Name	Documentation
`continuePath`	Continue playing a paused camera path
`createPath`	Create a camera path as described by the lua table input argument
`flyTo`	Move the camera to the node with the specified identifier
`flyToHeight`	Move the camera to the node with the specified identifier
`flyToNavigationState`	Create a path to the navigation state described by the input table
`isFlying`	Returns true if a camera path is currently running, and false otherwise
`jumpTo`	Fade rendering to black, jump to the specified navigation state, and then fade in
`jumpToNavigationState`	Fade rendering to black, jump to the specified node, and then fade in
`pausePath`	Pause a playing camera path
`skipToEnd`	Immediately skips to the end of the current camera path, if one is being played
`stopPath`	Stops a path, if one is being played
`zoomToDistance`	Fly linearly to a specific distance in relation to the focus node
`zoomToDistanceRelative`	Fly linearly to a specific distance in relation to the focus node
`zoomToFocus`	Zoom linearly to the current focus node, using the default distance

Functions

`continuePath`

Continue playing a paused camera path.

Return type: void

Signature

openspace.pathnavigation.continuePath()

`createPath`

Create a camera path as described by the lua table input argument.

Parameters

path Table

Return type: void

Signature

openspace.pathnavigation.createPath(path)

Move the camera to the node with the specified identifier. The optional double specifies the duration of the motion, in seconds. If the optional bool is set to true the target up vector for camera is set based on the target node. Either of the optional parameters can be left out.

Parameters

nodeIdentifier String
useUpFromTargetOrDuration Boolean | Number?
duration Number?

Return type: void

Signature

openspace.pathnavigation.flyTo(nodeIdentifier, useUpFromTargetOrDuration, duration)

`flyToHeight`

Move the camera to the node with the specified identifier. The second argument is the desired target height above the target node’s bounding sphere, in meters. The optional double specifies the duration of the motion, in seconds. If the optional bool is set to true, the target up vector for camera is set based on the target node. Either of the optional parameters can be left out.

Parameters

nodeIdentifier String
height Number
useUpFromTargetOrDuration Boolean | Number?
duration Number?

Return type: void

Signature

openspace.pathnavigation.flyToHeight(nodeIdentifier, height, useUpFromTargetOrDuration, duration)

`flyToNavigationState`

Create a path to the navigation state described by the input table. The optional double specifies the target duration of the motion, in seconds. Note that roll must be included for the target up direction to be taken into account.

Parameters

navigationState Table
duration Number?

Return type: void

Signature

openspace.pathnavigation.flyToNavigationState(navigationState, duration)

`isFlying`

Returns true if a camera path is currently running, and false otherwise.

Return type: Boolean

Signature

openspace.pathnavigation.isFlying()

`jumpTo`

Fade rendering to black, jump to the specified navigation state, and then fade in. This is done by triggering another script that handles the logic.

If no fade duration is specified, use the property from Navigation Handler

Parameters

nodeIdentifier String
fadeDuration Number?

Return type: void

Signature

openspace.pathnavigation.jumpTo(nodeIdentifier, fadeDuration)

`jumpToNavigationState`

Fade rendering to black, jump to the specified node, and then fade in. This is done by triggering another script that handles the logic.

If no fade duration is specified, use the property from Navigation Handler

Parameters

navigationState Table
fadeDuration Number?

Return type: void

Signature

openspace.pathnavigation.jumpToNavigationState(navigationState, fadeDuration)

`pausePath`

Pause a playing camera path.

Return type: void

Signature

openspace.pathnavigation.pausePath()

`skipToEnd`

Immediately skips to the end of the current camera path, if one is being played.

Return type: void

Signature

openspace.pathnavigation.skipToEnd()

`stopPath`

Stops a path, if one is being played.

Return type: void

Signature

openspace.pathnavigation.stopPath()

`zoomToDistance`

Fly linearly to a specific distance in relation to the focus node. The distance is given in meters above the bounding sphere of the current focus node. The optional input parameter specifies the duration for the motion, in seconds.

Parameters

distance Number
duration Number?

Return type: void

Signature

openspace.pathnavigation.zoomToDistance(distance, duration)

`zoomToDistanceRelative`

Fly linearly to a specific distance in relation to the focus node. The distance is given as a multiple of the bounding sphere of the current focus node. That is, a value of 1 will result in a position at a distance of one times the size of the bounding sphere away from the object. The optional input parameter specifies the duration for the motion, in seconds.

Parameters

distance Number
duration Number?

Return type: void

Signature

openspace.pathnavigation.zoomToDistanceRelative(distance, duration)

`zoomToFocus`

Zoom linearly to the current focus node, using the default distance. The optional input parameter specifies the duration for the motion, in seconds.

Parameters

duration Number?

Return type: void

Signature

openspace.pathnavigation.zoomToFocus(duration)

openspace.pathnavigation

Functions overview

Functions

`openspace.pathnavigation`