Difference between revisions of "Default head-up display"

From FlightGear wiki
Jump to: navigation, search
m (altered download link for HeliHUD)
m (Johan G moved page Head-up display to Default head-up display: Less ambiguous title)
 
(10 intermediate revisions by 5 users not shown)
Line 1: Line 1:
The [http://en.wikipedia.org/wiki/Head-up_display '''Head-up display'''] (HUD) is an important instrument in modern, mostly military, cockpits. FlightGear provides a XML-based system to relatively easily create HUDs for aircraft such as the [[F-14]] and [[F-16]].
+
{{Note|The HUD system will one day be replaced by a [[Canvas HUD]] system.}}
  
However, this article's focus is on FlightGear's default head-up displays. Those are available for any craft which does not include its own set. Have a look at [[#Further Information|Further Information]] if you're planning to create a HUD.
+
[[File:HUD_default_overview.png|thumb|420px|Huds/default.xml]]
 +
[[File:HUD_minimal_overview.png|thumb|420px|Huds/minimal.xml]]
 +
[[File:HUD_NTPS_overview.png|thumb|420px|Huds/NTPS.xml]]
  
Activate the HUD with the '''<tt>[h]</tt>'''-key. Pressing it repeatedly moves through the configured colours and turns it off again. To change the brightness, press '''<tt>[shift]</tt>+<tt>[h]</tt>'''. Press '''<tt>[shift]</tt>+<tt>[i]</tt>''' to go through the available HUD's. Press '''<tt>[i]</tt>''' to switch back to the first one at any time. Have in mind that some aircraft do assign one or more of those keys differently and therefore one or more function/s is/are missing on them.
+
The '''default head-up display''' (HUD) of FlightGear is available for any craft which does not include its own. A {{Wikipedia|head-up display}} is an important instrument in modern, mostly military, cockpits.  
  
Some of the head-up display's options can be altered in the menu: <tt>View</tt> --> <tt>Adjust HUD [[Property_tree|Properties]]</tt>
+
Activate the HUD with {{key press|h}}. Pressing it repeatedly moves through the configured colours and turns it off again. To change the brightness, press {{key press|Shift|H}}. Press {{key press|Shift|I}} to go through the available HUDs. Press {{key press|i}} to switch back to the first one at any time. Have in mind that some aircraft do assign one or more of those keys differently and therefore some functions may be missing from them.
  
 +
Some of the head-up options of the HUD can be altered in the menu: ''View'' &gt; ''Adjust HUD Properties''
 +
 +
In addition custom HUDs for aircraft such as the [[F-14B]] and [[F-16]] can relatively easily be created through an XML-based system FlightGear provides. Have a look at [[#Further Information|Further Information]] if you are planning to create a HUD.
  
[[File:HUD_default_overview.png|thumb|420px|Huds/default.xml]]
 
[[File:HUD_minimal_overview.png|thumb|420px|Huds/minimal.xml]]
 
[[File:HUD_NTPS_overview.png|thumb|420px|Huds/NTPS.xml]]
 
 
== Features ==
 
== Features ==
 
=== Control inputs ===
 
=== Control inputs ===
; [[Aileron]]
+
; Aileron
: Monitors the bearing of the control input on the aileron's axis. Attached along the upper side is the indicator for the trim input on that axis.
+
: Displays the [[aileron]] control axis input. Attached along the upper side is the indicator for the trim input on that axis.
 
: Properties: <code>/controls/flight/aileron</code> and <code>/controls/flight/aileron-trim</code>
 
: Properties: <code>/controls/flight/aileron</code> and <code>/controls/flight/aileron-trim</code>
  
; [[Elevator]]
+
; Elevator
: Monitors the bearing of the control input on the elevator's axis. Attached to the left the trim on this axis.
+
: Displays the [[elevator]] control axis input. Attached to the left the trim on this axis.
 
: Properties: <code>/controls/flight/elevator</code> and <code>/controls/flight/elevator-trim</code>
 
: Properties: <code>/controls/flight/elevator</code> and <code>/controls/flight/elevator-trim</code>
  
; [[Rudder]]
+
; Rudder
: Monitors the bearing of the control input on the rudder's axis. Attached to the bottom the trim input.
+
: Displays the [[rudder]] control axis input. Attached to the bottom the trim input.
 
: Properties: <code>/controls/flight/rudder</code> and <code>/controls/flight/rudder-trim</code>
 
: Properties: <code>/controls/flight/rudder</code> and <code>/controls/flight/rudder-trim</code>
  
 
; Throttle
 
; Throttle
: Monitors the throttle input axis.
+
: Displays the [[throttle]] control axis input.
 
: Property: <code>/controls/engines/engine/throttle</code>
 
: Property: <code>/controls/engines/engine/throttle</code>
 
  
 
=== Instruments ===
 
=== Instruments ===
; [[AMSL]] (Height <u>a</u>bove <u>m</u>ean <u>s</u>ea <u>l</u>evel)
+
; AMSL (Altitude above Mean Sea Level)
: Current altitude relative to sea level in feet (ft) (1 ft = 30.48 cm).
+
: Current [[AMSL|altitude above mean seal level]] in feet (ft) (1 ft = 30.48 cm).
 
: Property: <code>/position/altitude-ft</code>
 
: Property: <code>/position/altitude-ft</code>
  
 
; g-load
 
; g-load
: The [http://en.wikipedia.org/wiki/G-force g-force] appealing to the pilot - to avoid black-/redout.
+
: The {{Wikipedia|G-force}} applied to the pilot - to avoid black-/redout.
: Property: <code>/accelerations/pilot/z-accel-fps_sec</code> with factor <tt>-0.03108095</tt>
+
: Property: <code>/accelerations/pilot/z-accel-fps_sec</code> with factor <code>-0.03108095</code>
  
; [[Avionics and Instruments#Directional_Gyro|Gyrocompass]]
+
; Gyrocompass
: This is an ideal version of a gyrocompass without the drawbacks of a real one. It shows heading of the aircraft relative to the geographical North Pole (true north) in degree (360 degree scale).
+
: This is an ideal version of a [[Avionics and Instruments#DirectionalGyro|gyrocompass]] without the drawbacks of a real one. It shows heading of the aircraft relative to the geographical north pole (true north) in degree (360 degree scale).
 
: Property: <code>/orientation/heading-deg</code>
 
: Property: <code>/orientation/heading-deg</code>
  
; [[KIAS]] (<u>K</u>nots <u>I</u>ndicated <u>A</u>ir<u>s</u>peed)
+
; KIAS (Knots Indicated Airspeed)
: Current speed relating to the ambient air in knot/knots (kt/kts) (1 kt = 1.151 mph = 1.852 km/h).
+
: Current [[KIAS|speed relative to the ambient air in knots]] (kt) (1 kt = 1.151 mph = 1.852 km/h).
 
: Property: <code>/velocities/airspeed-kt</code>
 
: Property: <code>/velocities/airspeed-kt</code>
  
 
; Latitude / Longitude
 
; Latitude / Longitude
: Current location according to the [http://en.wikipedia.org/wiki/Geographic_coordinate_system geographic coordinate system].
+
: Current location according to the {{Wikipedia|geographic coordinate system}}.
: To change the format of the displayed coordinates, go to <tt>Autopilot</tt> --> <tt>Set Lat/Lon-format</tt>.
+
: To change the format of the displayed coordinates, go to ''Autopilot'' &gt; ''Set Lat/Lon-format''.
 
: Properties: <code>/position/latitude-string</code> and <code>/position/longitude-string</code>
 
: Properties: <code>/position/latitude-string</code> and <code>/position/longitude-string</code>
  
 
; Pitch ladder
 
; Pitch ladder
: Displays the aircraft's pitch and roll relative to the ground's level/horizontal in degree. It's used as an artificial horizon ([[Avionics and Instruments#Attitude Indicator|Attitude indicator]]).
+
: Displays the pitch and roll of the aircraft relative to the horizontal plane in degrees. It is used as an artificial horizon ([[Avionics and Instruments#Attitude Indicator|Attitude indicator]]).
 
: Properties: <code>/orientation/roll-deg</code> and <code>/orientation/pitch-deg</code>
 
: Properties: <code>/orientation/roll-deg</code> and <code>/orientation/pitch-deg</code>
  
 
; Radio altimeter
 
; Radio altimeter
: Shows current altitude [[above ground level]] (AGL) in feet. Relating to the location of the aircraft's radio altimeter, it's not zero if the aircraft is on the ground.
+
: Shows current altitude [[above ground level]] (AGL) in feet. Relating to the location of the radio altimeter of the aircraft, it is not zero if the aircraft is on the ground.
 
: Property: <code>/position/altitude-agl-ft</code>
 
: Property: <code>/position/altitude-agl-ft</code>
  
Line 64: Line 65:
 
: Properties: <code>/orientation/roll-deg</code> and <code>/orientation/side-slip-deg</code>
 
: Properties: <code>/orientation/roll-deg</code> and <code>/orientation/side-slip-deg</code>
  
 
+
=== Autopilot ===
 
[[File:HUD_default_autopilot.jpg|thumb|420px|HUD autopilot]]
 
[[File:HUD_default_autopilot.jpg|thumb|420px|HUD autopilot]]
=== [[Autopilot]] ===
+
If the [[autopilot]] is active the HUD displays its settings. For each active function (heading, altitude and speed) a box will appear below the gyrocompass containing information on its mode and, if existent, the associated value.
If the autopilot is active the HUD displays its settings. For each active function (heading, altitude and speed) a box will appear below the gyrocompass containing information on its mode and, if existent, the associated value.
+
 
 
; Heading control
 
; Heading control
 
: Whether it is active or not and on which mode it operates is determined by the content of the  <code>/autopilot/locks/heading</code> property.
 
: Whether it is active or not and on which mode it operates is determined by the content of the  <code>/autopilot/locks/heading</code> property.
Line 80: Line 81:
 
: Their values: <code>/autopilot/settings/target-speed-kt</code> and <code>/autopilot/settings/target-speed-mach</code>
 
: Their values: <code>/autopilot/settings/target-speed-kt</code> and <code>/autopilot/settings/target-speed-mach</code>
  
 
+
=== GPS ===
 
[[File:HUD_default_gps.jpg|thumb|420px|HUD GPS]]
 
[[File:HUD_default_gps.jpg|thumb|420px|HUD GPS]]
=== [[GPS]] ===
+
The upper left hand corner shows the most important information on the current state of the [[GPS]]. Namely these are (line by line):
The upper left hand corner shows the most important information on the actual state of the GPS. Namely these are (line by line):
+
: the mode the GPS operates in and the active waypoint's identifier.
+
: the distance "D" (in nautical miles, nm) and the calculated time to this waypoint "TTW".
+
: the bearing "BRG" to the active waypoint and the course deviation "XTR" based on the leg from the previous waypoint.
+
: the current speed relative to the ground "GS".
+
  
 +
{| class="wikitable"
 +
| GPS operating mode
 +
| Active waypoint
 +
|-
 +
| '''D''': Distance in nautical miles (NM) to active waypoint
 +
| '''TTW''': Calculated time to active waypoint
 +
|-
 +
| '''BRG''': Bearing to next waypoint
 +
| '''XTR''': Cross track deviation, deviation from the track between the previous and active waypoint in nautical miles (NM)
 +
|-
 +
| '''GS''': Ground speed, the speed relative to the ground
 +
|
 +
|}
  
 
=== Big fat arrow ===
 
=== Big fat arrow ===
 
Remains of a going to be useful instrument.
 
Remains of a going to be useful instrument.
: To get rid of it, remove or comment "runway.xml" from/in <tt>$FG_ROOT/Huds/[http://mapserver.flightgear.org/git/?p=fgdata;a=blob_plain;f=Huds/default.xml;hb=HEAD default.xml]</tt>.
+
 
 +
: To get rid of it, remove or comment <code>runway.xml</code> from <code>[[$FG_ROOT]]/Huds/{{fgdata source|path=Huds/default.xml|text=default.xml}}</code>.
 
: To make it point to the airport selected by menu item "Tower Position", apply patches as shown [http://sourceforge.net/mailarchive/message.php?msg_id=30422572 here].
 
: To make it point to the airport selected by menu item "Tower Position", apply patches as shown [http://sourceforge.net/mailarchive/message.php?msg_id=30422572 here].
 
  
 
== Further Information ==
 
== Further Information ==
HUDs may be replaced or added by changing or adding their paths in <tt>preferences.xml</tt> or by setting the paths as command line options. To change the order of the existing ones the options would be: <code>--prop:/sim/hud/path[1]=Huds/minimal.xml</code> <code>--prop:/sim/hud/path[2]=Huds/default.xml</code>
+
HUDs may be replaced or added by changing or adding their paths in <code>preferences.xml</code> or by setting the paths as command line options. To change the order of the existing ones the options would be: <code>--prop:/sim/hud/path[1]=Huds/minimal.xml</code> <code>--prop:/sim/hud/path[2]=Huds/default.xml</code>
  
 
If you consider to create your own HUD have a look at [[Canvas HUD]] first.
 
If you consider to create your own HUD have a look at [[Canvas HUD]] first.
  
The basic settings regarding to any HUD are set in <tt>$FG_ROOT/[http://mapserver.flightgear.org/git/?p=fgdata;a=blob_plain;f=preferences.xml;hb=HEAD preferences.xml]</tt>. Search the file for the <tt><hud></tt>-tag and you will find a list of properties.
+
The basic settings regarding to any HUD are set in {{fgdata source|path=defaults.xml}}. Search the file for the <code><hud></code> tag and you will find a list of properties.
 
+
The setup of the default HUD is defined at <tt>[[$FG_ROOT]]/Huds/[http://mapserver.flightgear.org/git/?p=fgdata;a=blob_plain;f=Huds/default.xml;hb=HEAD default.xml]</tt> and documentation can be found at <tt>$FG_ROOT/Docs/[http://mapserver.flightgear.org/git/?p=fgdata;a=blob_plain;f=Docs/README.hud;hb=HEAD README.hud]</tt>.
+
  
 +
The setup of the default HUD is defined at {{fgdata source|path=Huds/default.xml}} and documentation can be found at {{readme file|hud}}.
  
 
== Additional HUDs ==
 
== Additional HUDs ==
 
; HeliHUD
 
; HeliHUD
: Designed to fly helicopters in Helicopter View it is also handy for any craft with a not yet finished cockpit. It also contains a minimalistic HUD only showing some navigational information such as compass and GPS. The [http://beggabaur.onpw.de/site_data/helihud_0.2.tar.bz2 download] contains instructions and specs.
+
: The [http://wiki.beggabaur.rocks/ya/HeliHUD HeliHUD] is designed for fly helicopters in Helicopter View it is also handy for any craft with a not yet finished cockpit. It also contains a minimalistic HUD only showing some navigational information such as compass and GPS. The [http://beggabaur.rocks/fgfs/helihud_0.3.tar.bz2 download] contains instructions and specs.
 
+
  
 
[[Category:FlightGear feature]]
 
[[Category:FlightGear feature]]
 
[[Category:Menubar]]
 
[[Category:Menubar]]

Latest revision as of 13:48, 2 May 2020

Note  The HUD system will one day be replaced by a Canvas HUD system.
Huds/default.xml
Huds/minimal.xml
Huds/NTPS.xml

The default head-up display (HUD) of FlightGear is available for any craft which does not include its own. A head-up display This is a link to a Wikipedia article is an important instrument in modern, mostly military, cockpits.

Activate the HUD with h. Pressing it repeatedly moves through the configured colours and turns it off again. To change the brightness, press Shift+H. Press Shift+I to go through the available HUDs. Press i to switch back to the first one at any time. Have in mind that some aircraft do assign one or more of those keys differently and therefore some functions may be missing from them.

Some of the head-up options of the HUD can be altered in the menu: View > Adjust HUD Properties

In addition custom HUDs for aircraft such as the F-14B and F-16 can relatively easily be created through an XML-based system FlightGear provides. Have a look at Further Information if you are planning to create a HUD.

Features

Control inputs

Aileron
Displays the aileron control axis input. Attached along the upper side is the indicator for the trim input on that axis.
Properties: /controls/flight/aileron and /controls/flight/aileron-trim
Elevator
Displays the elevator control axis input. Attached to the left the trim on this axis.
Properties: /controls/flight/elevator and /controls/flight/elevator-trim
Rudder
Displays the rudder control axis input. Attached to the bottom the trim input.
Properties: /controls/flight/rudder and /controls/flight/rudder-trim
Throttle
Displays the throttle control axis input.
Property: /controls/engines/engine/throttle

Instruments

AMSL (Altitude above Mean Sea Level)
Current altitude above mean seal level in feet (ft) (1 ft = 30.48 cm).
Property: /position/altitude-ft
g-load
The G-force This is a link to a Wikipedia article applied to the pilot - to avoid black-/redout.
Property: /accelerations/pilot/z-accel-fps_sec with factor -0.03108095
Gyrocompass
This is an ideal version of a gyrocompass without the drawbacks of a real one. It shows heading of the aircraft relative to the geographical north pole (true north) in degree (360 degree scale).
Property: /orientation/heading-deg
KIAS (Knots Indicated Airspeed)
Current speed relative to the ambient air in knots (kt) (1 kt = 1.151 mph = 1.852 km/h).
Property: /velocities/airspeed-kt
Latitude / Longitude
Current location according to the geographic coordinate system This is a link to a Wikipedia article.
To change the format of the displayed coordinates, go to Autopilot > Set Lat/Lon-format.
Properties: /position/latitude-string and /position/longitude-string
Pitch ladder
Displays the pitch and roll of the aircraft relative to the horizontal plane in degrees. It is used as an artificial horizon (Attitude indicator).
Properties: /orientation/roll-deg and /orientation/pitch-deg
Radio altimeter
Shows current altitude above ground level (AGL) in feet. Relating to the location of the radio altimeter of the aircraft, it is not zero if the aircraft is on the ground.
Property: /position/altitude-agl-ft
Turn-bank-indicator
Turn Coordinator
Properties: /orientation/roll-deg and /orientation/side-slip-deg

Autopilot

HUD autopilot

If the autopilot is active the HUD displays its settings. For each active function (heading, altitude and speed) a box will appear below the gyrocompass containing information on its mode and, if existent, the associated value.

Heading control
Whether it is active or not and on which mode it operates is determined by the content of the /autopilot/locks/heading property.
The values are taken from /autopilot/settings/heading-bug-deg and /autopilot/settings/true-heading-deg.
Altitude control
Active mode: /autopilot/locks/altitude
Their values: /autopilot/settings/target-altitude-ft, /autopilot/settings/vertical-speed-fpm and /autopilot/settings/target-agl-ft.
Speed control
Active mode: /autopilot/locks/speed
Their values: /autopilot/settings/target-speed-kt and /autopilot/settings/target-speed-mach

GPS

HUD GPS

The upper left hand corner shows the most important information on the current state of the GPS. Namely these are (line by line):

GPS operating mode Active waypoint
D: Distance in nautical miles (NM) to active waypoint TTW: Calculated time to active waypoint
BRG: Bearing to next waypoint XTR: Cross track deviation, deviation from the track between the previous and active waypoint in nautical miles (NM)
GS: Ground speed, the speed relative to the ground

Big fat arrow

Remains of a going to be useful instrument.

To get rid of it, remove or comment runway.xml from $FG_ROOT/Huds/default.xml.
To make it point to the airport selected by menu item "Tower Position", apply patches as shown here.

Further Information

HUDs may be replaced or added by changing or adding their paths in preferences.xml or by setting the paths as command line options. To change the order of the existing ones the options would be: --prop:/sim/hud/path[1]=Huds/minimal.xml --prop:/sim/hud/path[2]=Huds/default.xml

If you consider to create your own HUD have a look at Canvas HUD first.

The basic settings regarding to any HUD are set in flightgear/fgdata/next/defaults.xml. Search the file for the <hud> tag and you will find a list of properties.

The setup of the default HUD is defined at flightgear/fgdata/next/Huds/default.xml and documentation can be found at $FG_ROOT/Docs/README.hud.

Additional HUDs

HeliHUD
The HeliHUD is designed for fly helicopters in Helicopter View it is also handy for any craft with a not yet finished cockpit. It also contains a minimalistic HUD only showing some navigational information such as compass and GPS. The download contains instructions and specs.