Class: FlightPlayer

Tools.VirtualCity FlightPlayer

FlightPlayer

new FlightPlayer()

modules/tools/virtualCity/flightPlayer.js, line 27
FlightPlayer to control the 3D Map to fly on a predefined path. This is a singleton, use getInstance method to get the instance
Properties:
Name Type Argument Default Description
playing boolean <optional>
 false
paused boolean <optional>
 false
multiplier number <optional>
 1
repeat boolean <optional>
 false
valid boolean <optional>
 false
activeInstance FlightInstance | null
startTime number
endTime number
currentTime number
currentSystemTime number | null
times Array.<number>
Fires:
Listens to Events:

Extends

Methods

clearActiveFlight(){void}

modules/tools/virtualCity/flightPlayer.js, line 109

initialize(){void}

modules/tools/virtualCity/flightPlayer.js, line 68
Listens to Events:

play(flightInstance){void}

modules/tools/virtualCity/flightPlayer.js, line 125
starts playing either the given flightInstance or the activeInstance
Name Type Description
flightInstance FlightInstance | undefined -
Fires:

setActiveFlightInstance(flightInstance){void}

modules/tools/virtualCity/flightPlayer.js, line 98
Name Type Description
flightInstance FlightInstance -

stop(){void}

modules/tools/virtualCity/flightPlayer.js, line 159
stops the active flight and sets the currentTime to 0
Fires:

Events

RadioRequestFlightPlayerGetValues

devtools/jsdoc/events.js, line 2232
returns the state values of the flightplayer
Listeners of This Event:

RadioRequestFlightPlayerPlay

devtools/jsdoc/events.js, line 2227
starts playing the given flight
Listeners of This Event:

RadioRequestFlightPlayerStop

devtools/jsdoc/events.js, line 2222
stops the active Flight
Listeners of This Event:

RadioTriggerFlightPlayerStateChange

devtools/jsdoc/events.js, line 2237
fires if the flightplayer state changes. If the player starts playing or stop is called
Name Type Description
state string "play" or "stop"
flightInstance FlightInstance