Hi fellow wiki editors!

To help newly registered users get more familiar with the wiki (and maybe older users too) there is now a {{Welcome to the wiki}} template. Have a look at it and feel free to add it to new users discussion pages (and perhaps your own).

I have tried to keep the template short, but meaningful. /Johan G

Difference between revisions of "Howto:Animated jetways"

From FlightGear wiki
Jump to: navigation, search
(First set of restyling modifications)
(Dequoting and restyling per FGW:MOS)
Line 1: Line 1:
 
'''Animated jetways''' are dynamic {{Wikipedia|jetway}} 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.
 
'''Animated jetways''' are dynamic {{Wikipedia|jetway}} 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.
  
== Current state ==
+
== Compatible airports and aircraft ==
As of September 2015, only the following airports have animated jetways.
+
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:
 
* [[London Gatwick Airport]] (EGKK)*
 
* [[London Gatwick Airport]] (EGKK)*
 
* [[Amsterdam Airport Schiphol]] (EHAM)
 
* [[Amsterdam Airport Schiphol]] (EHAM)
Line 10: Line 12:
 
* Ted Stevens Anchorage International Airport (PANC)*
 
* Ted Stevens Anchorage International Airport (PANC)*
 
''<nowiki>*</nowiki> indicates the jetways for this airport were auto-converted and do not have gate numbers.''
 
''<nowiki>*</nowiki> indicates the jetways for this airport were auto-converted and do not have gate numbers.''
 +
 +
The aircraft supporting animated jetways are:
 +
* [[Boeing 717]]
 +
* [[Boeing 747-8i]]
 +
* [[Boeing 757-200]] and -300
 +
* [[Boeing 767-300]]/ER
 +
* [[Boeing 777-200ER]]
 +
* [[Bombardier CRJ700]]
 +
 +
The [[Interactive traffic|AI aircraft]] supporting animated jetways are:
 +
* [[Airbus A319]]
 +
* [[Airbus A320]]
 +
* [[Airbus A321]]
 +
* [[Boeing 737]]
 +
* [[Boeing 747-400]]
 +
* [[McDonnell Douglas MD-80]]
  
 
The {{fgdata file|Models/Airport/Jetway/generic.xml|t=generic jetway model}} in FGData is broken, but there is [http://scenemodels.flightgear.org/app.php?c=Models&a=view&id=2211 a repaired version in the TerraSync scenery repository].
 
The {{fgdata file|Models/Airport/Jetway/generic.xml|t=generic jetway model}} in FGData is broken, but there is [http://scenemodels.flightgear.org/app.php?c=Models&a=view&id=2211 a repaired version in the TerraSync scenery repository].
Line 17: Line 35:
  
 
== Using the jetways ==
 
== Using the jetways ==
# Start FlightGear in any animated jetway-compatible aircraft. As of May 2016, these include the following:
+
# Start FlightGear in any compatible aircraft.
#* [[Boeing 717]]
+
#* [[Boeing 747-8i]]
+
#* [[Boeing 757-200]] and -300
+
#* [[Boeing 767-300]]/ER
+
#* [[Boeing 777-200ER]]
+
#* [[Bombardier CRJ700]]
+
 
# Fly (or spawn) to any airport equipped with animated jetways. You can tell if a jetway is animated by pressing {{key press|Ctrl|C}}; if the polygons are highlighted in yellow, then it is animated.
 
# Fly (or spawn) to any airport equipped with animated jetways. You can tell if a jetway is animated by pressing {{key press|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.}}
 
{{note|Ensure you have the latest scenery from [[TerraSync]] so you do not get conflicts between animated and static jetways.}}
Line 34: Line 46:
 
# Move the model around to account for any offsets you have in the main model file, then get the coordinates of the door.
 
# Move the model around to account for any offsets you have in the main model file, then get the coordinates of the door.
 
[[File:Animated-jetway-tutorial.jpg]]
 
[[File:Animated-jetway-tutorial.jpg]]
# Add the following code in your aircraft's -set.xml (remember to merge the tags properly):
+
<ol start="3">
 +
<li>Add the following code in your aircraft's -set.xml (remember to merge the tags properly):</li>
 +
</ol>
 
<syntaxhighlight language="xml">
 
<syntaxhighlight language="xml">
 
<sim>
 
<sim>
Line 66: Line 80:
 
=== Adding support in AI aircraft ===
 
=== Adding support in AI aircraft ===
 
Follow the steps for regular aircraft above, but only add in the Nasal code.
 
Follow the steps for regular aircraft above, but only add in the Nasal code.
 
=== jetway-enabled AI Aircraft (9/2015) ===
 
<pre>
 
AI/Aircraft/A319/A319-main.xml
 
AI/Aircraft/A320/A320-main.xml
 
AI/Aircraft/737/737-main.xml
 
AI/Aircraft/MD80/MD80-main.xml
 
AI/Aircraft/A321/A321-main.xml
 
AI/Aircraft/747-400/747-400-main.xml
 
</pre>
 
  
 
== Adding support in scenery ==
 
== Adding support in scenery ==
 
 
=== Placing jetways ===
 
=== Placing jetways ===
 
+
# Launch FlightGear in your favorite aircraft, such as the [[Bluebird]].
Launch FlightGear in your favorite aircraft. The author uses the [[Bluebird]]. You ''cannot'' use the [[UFO]] because its scenery-editing function will interfere with the jetway editor. Go to AI > Jetway Settings and tick the "Enable jetway editor" checkbox. Then click the "Open Editor" button.
+
{{note|You ''cannot'' use the [[UFO]] because its scenery editing function will interfere with the jetway editor.}}
 
+
<ol start="2">
 +
<li>Go to {{menu item|AI|Jetway Settings}} and tick the '''Enable jetway editor''' checkbox, then click the {{button|Open Editor}} button.
 
[[File:Animated-jetway-editor.jpg]]
 
[[File:Animated-jetway-editor.jpg]]
 +
<li>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 {{key press|Alt}}+click on the terrain to move the current selected jetway. {{key press|Ctrl}}+click selects the jetway closest to the click position (the new jetway will flash to indicate it is selected). {{key press|Shift}}+click deselects the current jetway.</li>
 +
</ol>
  
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's 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's 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:
 +
:* Generic
 +
:* Glass
 +
:* [[EHAM]] gate
 +
:* [[EHAM]] 747 gate
  
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 drop-down 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. At the moment, the following models are available:
+
<ol start="4">
 
+
<li>When you are finished editing your airport jetway layout, click the {{button|Export}} button. A jetway definition file will be created and written to <tt>$FG_HOME/Export/ICAO.xml</tt>, where <tt>ICAO</tt> is the ICAO code of the nearest airport. (The exact location of this file is printed to the console window.) This file should be [[FlightGear Scenery Database#Contribute|submitted to TerraSync]].</li>
* Generic
+
</ol>
* Glass
+
* [[EHAM]] gate
+
* [[EHAM]] 747 gate
+
 
+
When you are finished editing your airport jetway layout, click the "Export" button. A jetway definition file will be created and written to <tt>$FG_HOME/Export/ICAO.xml</tt>, where <tt>ICAO</tt> 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 (see [[FlightGear Scenery Database#Contribute]]).
+
  
 
=== Auto-converting static/obsolete jetways ===
 
=== Auto-converting static/obsolete jetways ===
 
 
{{WIP}}
 
{{WIP}}
  
== Future Development ==
+
== Future development ==
{{FGCquote
+
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:
|1= I don't know if anyone remembers the Nasal-based animated jetway code I wrote a few years ago, but I'd like to rewrite it as a clean-sheet C++ subsystem. I want to eliminate the truly atrocious Nasal hacks I used in the initial implementation and make the whole thing faster and more reliable. My objectives as of now are, 1) Implement a new FGJetwayManager subsystem to replace the existing code in jetways.nas. (I have not yet decided what to do with jetways_edit.nas - it might be fixed up instead of outright replaced.) 2) Streamline the jetway model files in fgdata. I want to do away with the generic.airline.<XYZ>.xml files because they're unnecessary clutter. The C++ code can deal with these cases. 3) As for the jetway definition files themselves (<airport>.jetways.xml), the only change I'd like to make is deprecating the "elevation-m" property for each jetway, which is currently relative to the surrounding scenery, including buildings and AI craft (due to the Nasal API). Instead, I propose fixing all jetways to the ground. Rationale: The current method is unreliable (see sunken jetways at KSFO) and I can't imagine a situation when you would need a floating jetway. 4) Performance optimiations - much of this would come from plain superior code, but I also plan to introduce a user preference for "jetway density." That is, you can choose to spawn between 0 to 100% of all jetways defined for an airport. This allows the user to reduce the overhead from rendering and animating all those jetway objects (which is probably the biggest bottleneck besides the current Nasal implementation). This is what FSX does. 5) Potential idea - integration with AI traffic. So that when AI airliners park at their gates, jetways will extend to meet them. The current Nasal code makes an attempt at this, but it's very hacky and unreliable. While I think this is a cool idea, I don't want to interfere with anyone's work on the AI subsystem. I would greatly appreciate any ideas and comments on my proposal, as well as some pointers and tips on getting started with core development. :-)
+
* some hacks in the current [[Nasal]] code would be removed, and the system would be faster and more reliable;
|2= {{cite web
+
* the model files could be streamlined and the jetways could be automatically placed on the ground, irrespective of the employed scenery;
  | url    = http://sourceforge.net/p/flightgear/mailman/message/34725917/
+
* performance could be improved by letting the user decide how many jetways would be rendered;
  | title  = <nowiki>[Flightgear-devel] Animated jet bridges redux</nowiki>
+
* they could be integrated with AI traffic.<ref>{{cite web
  | author = <nowiki>Ryan A Young</nowiki>
+
| url    = http://sourceforge.net/p/flightgear/mailman/message/34725917/
  | date  = Dec 29th, 2015
+
| title  = <nowiki>[Flightgear-devel] Animated jet bridges redux</nowiki>
  }}
+
| author = <nowiki>Ryan A Young</nowiki>
}}
+
| date  = Dec 29th, 2015
 
+
}}</ref>
  
 
== Related content ==
 
== Related content ==
=== FlightGear wiki ===
 
 
* [[Ramp Marshall]]
 
* [[Ramp Marshall]]
 +
* {{forumref|title=The animated jetway project|t=8728|f=5}}
  
=== Forum topics ===
+
{{Appendix}}
* [http://forum.flightgear.org/viewtopic.php?f=5&t=8728 The animated jetway project]
+
  
 
[[Category:Scenery]]
 
[[Category:Scenery]]
 
[[Category:Scenery enhancement]]
 
[[Category:Scenery enhancement]]

Revision as of 13:32, 13 May 2016

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.

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:

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

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.
  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.

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.

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.[1]

Related content

References
  1. Ryan A Young (Dec 29th, 2015). [Flightgear-devel] Animated jet bridges redux.