openspace.pathnavigation

Functions overview

Name

Documentation

continuePath

Continue playing a paused camera path

createPath

Create a camera path as described by the instruction in the input argument

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

Functions

continuePath

Continue playing a paused camera path.

Return type: void

Signature
openspace.pathnavigation.continuePath()

createPath

Create a camera path as described by the instruction in the input argument.

Parameters
  • pathInstruction Table

    • A table representing a PathInstruction that describes a camera path to be created

Return type: void

Signature
openspace.pathnavigation.createPath(pathInstruction)

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()