Howto:Animated jetways

From FlightGear wiki
Jump to: navigation, search

Animated jetways are dynamic jetway This is a link to a Wikipedia article models that connect to your aircraft when you are pulled up at a gate. FlightGear boasts the most advanced animated jetways in the flight simulator market, beating those of Microsoft Flight Simulator and X-Plane in features — a testament to the flexibility of FlightGear. This article describes how to obtain and use the jetways and interface them with aircraft and scenery.

This feature was broken for a while from end of 2016 up to 2018.2. FlightGear couldn't write the temporary model files in FG_HOME. Meanwhile this issue is solved. [1] A workaround was to use jetways.nas modified by icare38.[2]


Compatible airports and aircraft

This section lists the airports having animated jetways, as well as the aircraft and AI aircraft supporting them, as of September 2015.

The compatible airports are:

* indicates the jetways for this airport were auto-converted and do not have gate numbers.

The aircraft supporting animated jetways are:

The AI aircraft supporting animated jetways are:


Obtaining and installing

FlightGear 2.4.0 and later include the animated jetway system. Nothing extra has to be installed.

Using the jetways

  1. Start FlightGear in any compatible aircraft. Make sure to have animated jetways enabled (AI->Jetway->EnableAnimatedJetways and View->RenderingOptions->AnimatedJetways)
  2. Fly (or spawn) to any airport equipped with animated jetways. You can tell if a jetway is animated by pressing Ctrl+C; if the polygons are highlighted in yellow, then it is animated.
Note  Ensure you have the latest scenery from TerraSync so you do not get conflicts between animated and static jetways.
  1. Taxi up to an animated jetway and park near it, then click it. If your aircraft is supported and parked well enough, the jetway will extend, rotate, and connect.

An easy use case eg. is to spawn FlightGear with a 777-200 (which is supported) at KSFO parking position E60. You will see the jetway through the cockpit window. Click on it and it will start moving.

Development

Available jetway models

The generic jetway model in FGData is broken, but there is a repaired version in the TerraSync scenery repository.

Available jetway models in the object database are listed here https://scenery.flightgear.org/app.php?c=Models&a=browse&shared=21. Only some of them can be used as animated jetway. These are:

Model file Link Used at Remarks
generic.xml https://scenery.flightgear.org/app.php?c=Models&a=view&id=2211 KSFO This model might cause a collision with your aircraft if you move too close.

The number of occurences in the database probably is misleading because usages in ICAO.jetways.xml are not counted here.

Adding support in aircraft

  1. Open up the main model of your aircraft in your favorite 3D modeling software (such as Blender).
  2. Move the model around to account for any offsets you have in the main model file, then get the coordinates of the door.

Animated-jetway-tutorial.jpg

  1. Add the following code in your aircraft's -set.xml (remember to merge the tags properly):
<sim>
 <model>
  <door>
   <position-x-m type="float">X-M</position-x-m>
   <position-y-m type="float">Y-M</position-y-m>
   <position-z-m type="float">Z-M</position-z-m>
   <jetway-hood-deg type="float">HOOD-DEG</jetway-hood-deg>
  </door>
 </model>
</sim>
where X-M, Y-M, and Z-M are the X/Y/Z coordinates of the door in meters and HOOD-DEG is the jetway hood rotation amount. To specify more doors, just add more door elements.
  1. Add the following code into your XML model file to enable the jetways to connect to your aircraft over the multiplayer network:
 <nasal>
  <load>
   var model = cmdarg();
   model.getNode("door[0]/position-x-m", 1).setValue(X-M);
   model.getNode("door[0]/position-y-m", 1).setValue(Y-M);
   model.getNode("door[0]/position-z-m", 1).setValue(Z-M);
   model.getNode("door[0]/jetway-hood-deg", 1).setValue(HOOD-DEG);
  </load>
 </nasal>
Again, replace X-M, Y-M, Z-M and HOOD-DEG with their respective values. To add more doors, duplicate the last four lines of Nasal code and replace [0] with [1] or [2].

Adding support in AI aircraft

Follow the steps for regular aircraft above, but only add in the Nasal code.

Background: The model definition of AI (and MP) aircraft is not available in Nasal. So any door definition located as property inside any XML file is not available for the jetways module. For that reason AI aircraft xml files must contain an embedded piece of Nasal code for writing the door information into the AI models property tree. This is an example taken from the MD80 AI aircraft:

<?xml version="1.0"?>
<PropertyList>
        ...
        <nasal>
                <load>
                 var model = cmdarg();
                 model.getNode("door[0]/position-x-m",1).setValue(-19.241);
                 model.getNode("door[0]/position-y-m",1).setValue(-1.529);
                 model.getNode("door[0]/position-z-m",1).setValue(2.505);
                 model.getNode("door[0]/jetway-hood-deg",1).setValue(3);
                </load>
        </nasal>
        ...
</PropertyList>

Adding support in scenery

Placing jetways

  1. Launch FlightGear in your favorite aircraft, such as the Bluebird.
Note  You cannot use the UFO because its scenery editing function will interfere with the jetway editor.
  1. Go to AIJetway Settings and tick the Enable jetway editor checkbox, then click the Open Editor button. Animated-jetway-editor.jpg
  2. With the editor enabled, click anywhere on the ground to place an animated jetway, which will flash to indicate it is selected. The jetway editor is similar to the UFO scenery model editor. You can Alt+click on the terrain to move the current selected jetway. Ctrl+click selects the jetway closest to the click position (the new jetway will flash to indicate it is selected). Shift+click deselects the current jetway.
The dialog is used to adjust the selected jetway. The top sliders adjust position and orientation and the bottom ones adjust the jetway itself. The offsets that the bottom sliders control can be used to model jetways that are in obscure configurations. The dropdown menus at the very bottom of the dialog control various properties of the jetway, such as the model, gate number, airline sign and door number. The following models are available:
  1. When you are finished editing your airport jetway layout, click the Export button. A jetway definition file will be created and written to $FG_HOME/Export/ICAO.xml, where ICAO is the ICAO code of the nearest airport. (The exact location of this file is printed to the console window.) This file should be submitted to TerraSync.

Auto-converting static/obsolete jetways

WIP.png Work in progress
This article or section will be worked on in the upcoming hours or days.
See history for the latest developments.

Future development

Ryan A Young, the original developer of the animated jetway code, is planning to rewrite it as a C++ subsystem. This would bring several advantages:

  • some hacks in the current Nasal code would be removed, and the system would be faster and more reliable;
  • the model files could be streamlined and the jetways could be automatically placed on the ground, irrespective of the employed scenery;
  • performance could be improved by letting the user decide how many jetways would be rendered;
  • they could be integrated with AI traffic.[3]

Related content

References
  1. several  (Sep 20th, 2016).  AI Jetways broken in 2016.3.1 .
  2. icare38  (Feb 29th, 2017).  AI Jetways broken in 2016.3.1 .
  3. Ryan A Young (Dec 29th, 2015). [Flightgear-devel] Animated jet bridges redux.