Default head-up display: Difference between revisions

From FlightGear wiki
Jump to navigation Jump to search
mNo edit summary
(finished 'Colour' and 'Path', added 'Font')
Line 8: Line 8:


= Features =
= Features =
[[Image:HUD_default_overview.png|thumb|200px|HUD overview]]


== Aileron ==
=== Aileron ===
[[Image:HUD_aileron.jpg|thumb|200px|Aileron]]
[[Image:HUD_aileron.jpg|thumb|200px|Aileron]]
:[[Aileron]]
:[[Aileron]]


== Airspeed ==
=== Airspeed ===
[[Image:HUD_speed.jpg|thumb|200px|Airspeed]]
[[Image:HUD_speed.jpg|thumb|200px|Airspeed]]
Current speed relating to the ambient air in knot/knots (kt/kts) (1 kt = 1.852 km/h).
Current speed relating to the ambient air in knot/knots (kt/kts) (1 kt = 1.852 km/h).


== Altitude ==
=== Altitude ===
[[Image:HUD_altitude.jpg|thumb|200px|Altitude]]
[[Image:HUD_altitude.jpg|thumb|200px|Altitude]]
Current altitude relating to sea-level in feet (ft) (1 ft = 30.48 cm).
Current altitude relating to sea-level in feet (ft) (1 ft = 30.48 cm).


== Autopilot ==
=== Autopilot ===
[[Image:HUD_default_autopilot.jpg|thumb|200px|HUD autopilot]]
If autopilot is activ the direction of the next waypoint is displayed as well as the next two and the last waypoint of the <tt>Autopilot --> Route manager</tt> list.
If autopilot is activ the direction of the next waypoint is displayed as well as the next two and the last waypoint of the <tt>Autopilot --> Route manager</tt> list.
:[[Autopilot]]
:[[Autopilot]]


== Elevation ==
=== Elevation ===
Current altitude above ground in feet. Relating to the location of the aircrafts radio altimeter therefore it's not zero if the aircraft is on the ground.
Current altitude above ground in feet. Relating to the location of the aircrafts radio altimeter, therefore it's not zero if the aircraft is on the ground.


== Elevator ==
=== Elevator ===
[[Image:HUD_elevator.jpg|thumb|200px|Elevator]]
[[Image:HUD_elevator.jpg|thumb|200px|Elevator]]
:[[Elevator]]
:[[Elevator]]


== G-load ==
=== G-load ===
Displays the g-force to the pilot in g - to avoid black-/redout.
Displays the g-force to the pilot in g - to avoid black-/redout.
:The value riding on top of the [[#Airspeed|Airspeed]] indicator.
:The value riding on top of the [[#Airspeed|Airspeed]] indicator.


== Heading ==
=== Heading ===
[[Image:HUD_heading.jpg|thumb|200px|Heading]]
[[Image:HUD_heading.jpg|thumb|200px|Heading]]
Direction of the aircraft relating to the geographical North pole in degree (360 degree scale).
Direction of the aircraft relating to the geographical North pole in degree (360 degree scale).
:[[Avionics_and_Instruments#Compass|Compass]]
:[[Avionics_and_Instruments#Compass|Compass]]


== Location ==
=== Location ===
[[Image:HUD_location.jpg|thumb|200px|Location]]
[[Image:HUD_location.jpg|thumb|200px|Location]]
To change the coordinates-system, go to <tt>Autopilot --> Set Lat/Lon-format</tt>.
To change the coordinates-system, go to <tt>Autopilot --> Set Lat/Lon-format</tt>.


== Pitch ==
=== Pitch ===
Like set with <tt>[Home]</tt>/<tt>[End]</tt>.
Like set with <tt>[Home]</tt>/<tt>[End]</tt>.
:It's the left marker of the [[#Elevator|Elevator]] indicator.  
:It's the left marker of the [[#Elevator|Elevator]] indicator.  


== Pitch ladder ==
=== Pitch ladder ===
Displays the aircrafts pitch relating to the grounds level/horizontal in degree. It's used as an artificial horizon.
Displays the aircrafts pitch relating to the grounds level/horizontal in degree. It's used as an artificial horizon.
:The big ladder like looking indicator at the HUDs centre.  
:The big ladder like looking indicator at the HUDs centre.  
:[[Avionics_and_Instruments#Attitude_Indicator|Attitude indicator]]
:[[Avionics_and_Instruments#Attitude_Indicator|Attitude indicator]]


== Rudder ==
=== Rudder ===
[[Image:HUD_rudder.jpg|thumb|200px|Rudder]]
[[Image:HUD_rudder.jpg|thumb|200px|Rudder]]
:[[Rudder]]
:[[Rudder]]


== Thrust ==
=== Thrust ===
[[Image:HUD_thrust.jpg|thumb|200px|Thrust]]
[[Image:HUD_thrust.jpg|thumb|200px|Thrust]]


== Turn-bank-indicator ==
=== Turn-bank-indicator ===
:[[Avionics_and_Instruments#Turn_Coordinator|Turn Coordinator]]
:[[Avionics_and_Instruments#Turn_Coordinator|Turn Coordinator]]
[[Image:HUD_default_autopilot.jpg|thumb|200px|HUD autopilot]]
[[Image:HUD_default_overview.png|thumb|200px|HUD overview]]




Line 87: Line 88:
The prefered thing one would like to customize is, I guess, the HUDs colour.
The prefered thing one would like to customize is, I guess, the HUDs colour.


Discover your own settings is quite easy: Access the property tree via the Menu  <tt>File --> Browse Internal Properties</tt> or via the [[Property_Tree#Property_server|Property server]] and your browser. Go to sim/hud/color, e.g. http://localhost:5500/sim/hud/color, edit a value and watch the result in FlightGears window instantly.
Discover your own settings is quite easy: Access the property tree via the Menu  <tt>File --> Browse Internal Properties</tt> (<tt>[/]</tt>-character) '''or''' via the [[Property_Tree#Property_server|Property server]] and your browser. Go to sim/hud/color, e.g. http://localhost:5500/sim/hud/color, edit a value and watch the result in FlightGears window instantly.
 
Once the decision is made head back to preferences.xml, copy the <color n="0">-tag and paste it on top of the colours within the <palette>-tag. Rename the existing tags in numeric order and finally put your discovered values in the  new one. It should look like this, except your own values, of course:
  <current-color type="int">0</current-color>
  <palette>
    <color n="0">
    <transparent type="bool">true</transparent>
    <antialiased type="bool">false</antialiased>
    <brightness type="float">1</brightness>
    <alpha type="float">0.67</alpha>
    <red type="float">0.1</red>
    <green type="float">1.0</green>
    <blue type="float">0.3</blue>
    </color>
    <color n="1"><!-- day -->
    ...
    </color>
    <color n="2"><!-- night -->
    ...
    </color>
  </palette>
 
=== Font ===


Once the decision is made copy one of the <color n="x">-tags and paste it on top of the colours within the <palette>-tag. ... Interrupted ... to be continued ...


=== Path ===
=== Path ===
/!\ Just a draft and maybe not correct.
  <path>Huds/Default/default.xml</path>
  <path>Huds/NTPS.xml</path>                <!-- new HUD -->
The first one is the default HUD mentioned above. It is for the old HUD only.
The second is the first one of the 'minimal HUD's and it is for the new HUD only. The other 'minimal' one is called by the code (I guess), its path is Huds/Minimal/default.xml.
For each <path> are some more HUDs available, a complete list (except aircraft specific):
old HUD:
Huds/Custom/default.xml
Huds/Default/default.xml
Huds/Engineering/default.xml
Huds/Minimal/default.xml
new HUD:
Huds/NTPS.xml
Huds/default.xml


== Property tree ==
== Property tree ==
Line 98: Line 139:
Paths starting with '$FG_ROOT/' apply to the file system, the others are intra-property tree.
Paths starting with '$FG_ROOT/' apply to the file system, the others are intra-property tree.
  /sim/hud
  /sim/hud
   current-color  (0|1|2...)    One out of /sim/hud/palette
   current-color  (0|1|2...)    int    One out of /sim/hud/palette
   enable3d        (false|true)  hud n=0 3D off|on
   enable3d        (false|true)  bool    hud n=0 3D off|on
   enable3d[1]    (false|true)  hud n=1 3D off|on
   enable3d[1]    (false|true)  bool    hud n=1 3D off|on
   frame-stat-type (tris|???)   ???
   frame-stat-type (tris|???)           ???
   path            (Huds/...)   Path to hud n=0
   path            (Huds/...)           Path to hud n=0
   path[1]        (Huds/...)   Path to hud n=1
   path[1]        (Huds/...)           Path to hud n=1
   visibility      (false|true)  hud n=0 hidden|visible
   visibility      (false|true)  bool    hud n=0 hidden|visible
   visibility[1]  (false|true)  hud n=1 hidden|visible
   visibility[1]  (false|true)  bool    hud n=1 hidden|visible
  /sim/hud/color/                 Contains settings of current-color
  /sim/hud/color/         Contains settings of current-color
     alpha        (0...1)      0=invisible, 1=nontransparent
     alpha        (0...1)      float  0=invisible, 1=nontransparent
     alpha-clamp  (???)         ???
     alpha-clamp  (???)                 ???
     antialiased  (false|true)  Antialiasing off|on
     antialiased  (false|true)  bool    Antialiasing off|on
     blue          (0...1)       
     blue          (0...1)      float
     brightness    (0...1)      0=dark/black
     brightness    (0...1)      float  0=dark/black
     green        (0...1)
     green        (0...1)       float
     red          (0...1)
     red          (0...1)       float
     transparent  (false|true)  Transparency off|on
     transparent  (false|true)  bool    Transparency off|on
  /sim/hud/font/
  /sim/hud/font/
     name          (*.txf)      One out of $FG_ROOT/Fonts
     name          (*.txf)      string  One out of $FG_ROOT/Fonts
     size          (8)          Size of font
     size          (8)          float  Size of font
  /sim/hud/palette/
  /sim/hud/palette/
  /sim/hud/palette/color/        Settings of predefined colors, nearly
  /sim/hud/palette/color/        Settings of predefined colors, nearly
  /sim/hud/palette/color[n]/      the same options as in /sim/hud/color.
  /sim/hud/palette/color[n]/      the same options as in /sim/hud/color.

Revision as of 23:57, 6 September 2008

This article is a stub. You can help the wiki by expanding it.

This is a short description of FlightGears default Head-up display (HUD), it can be (de)activated with the [h]-key. To change the brightness, press [shift]+[h].

There are also two so called 'minimal' HUDs available which are accessible with [shift]+[i], to return to default HUD press [i].

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

Features

Aileron

Aileron
Aileron

Airspeed

Airspeed

Current speed relating to the ambient air in knot/knots (kt/kts) (1 kt = 1.852 km/h).

Altitude

Altitude

Current altitude relating to sea-level in feet (ft) (1 ft = 30.48 cm).

Autopilot

If autopilot is activ the direction of the next waypoint is displayed as well as the next two and the last waypoint of the Autopilot --> Route manager list.

Autopilot

Elevation

Current altitude above ground in feet. Relating to the location of the aircrafts radio altimeter, therefore it's not zero if the aircraft is on the ground.

Elevator

Elevator
Elevator

G-load

Displays the g-force to the pilot in g - to avoid black-/redout.

The value riding on top of the Airspeed indicator.

Heading

Heading

Direction of the aircraft relating to the geographical North pole in degree (360 degree scale).

Compass

Location

Location

To change the coordinates-system, go to Autopilot --> Set Lat/Lon-format.

Pitch

Like set with [Home]/[End].

It's the left marker of the Elevator indicator.

Pitch ladder

Displays the aircrafts pitch relating to the grounds level/horizontal in degree. It's used as an artificial horizon.

The big ladder like looking indicator at the HUDs centre.
Attitude indicator

Rudder

Rudder
Rudder

Thrust

Thrust

Turn-bank-indicator

Turn Coordinator
HUD autopilot
HUD overview


Further Information

The basic setup of the above described default HUD is defined at

$FG_ROOT/Huds/Default/default.xml

There is also a 'Runway projection' available which is, because of some issues, disabled by default.

Documentation can be found at

$FG_ROOT/Docs/README.xmlhud

Since FlightGear 0.9.10 there is also a newer and more flexibly HUD-system available. An example can be found at

$FG_ROOT/Huds/NTPS.xml and documentation at
$FG_ROOT/Docs/README.hud.

Also have a look at $FG_ROOT/Huds/README.

preferences.xml

While the instruments and their behaviour are set in the Huds-directory, the basic settings and the look regarding to any HUD are set in $FG_ROOT/preferences.xml. Search the file for <hud> and you will find a list of properties. For a short description of those have a look at property tree. But I'll give some of them a closer look:

Colour

The prefered thing one would like to customize is, I guess, the HUDs colour.

Discover your own settings is quite easy: Access the property tree via the Menu File --> Browse Internal Properties ([/]-character) or via the Property server and your browser. Go to sim/hud/color, e.g. http://localhost:5500/sim/hud/color, edit a value and watch the result in FlightGears window instantly.

Once the decision is made head back to preferences.xml, copy the <color n="0">-tag and paste it on top of the colours within the <palette>-tag. Rename the existing tags in numeric order and finally put your discovered values in the new one. It should look like this, except your own values, of course:

  <current-color type="int">0</current-color>
  <palette>
   <color n="0">
    <transparent type="bool">true</transparent>
    <antialiased type="bool">false</antialiased>
    <brightness type="float">1</brightness>
    <alpha type="float">0.67</alpha>
    <red type="float">0.1</red>
    <green type="float">1.0</green>
    <blue type="float">0.3</blue>
   </color>
   <color n="1">
    ...
   </color>
   <color n="2">
    ...
   </color>
  </palette>

Font

Path

/!\ Just a draft and maybe not correct.

  <path>Huds/Default/default.xml</path>
  <path>Huds/NTPS.xml</path>                 

The first one is the default HUD mentioned above. It is for the old HUD only. The second is the first one of the 'minimal HUD's and it is for the new HUD only. The other 'minimal' one is called by the code (I guess), its path is Huds/Minimal/default.xml.

For each <path> are some more HUDs available, a complete list (except aircraft specific):

old HUD:

Huds/Custom/default.xml
Huds/Default/default.xml
Huds/Engineering/default.xml
Huds/Minimal/default.xml

new HUD:

Huds/NTPS.xml
Huds/default.xml


Property tree

More information about FlightGears property tree and on how to access it can be found at its page: Property Tree.

Paths starting with '$FG_ROOT/' apply to the file system, the others are intra-property tree.

/sim/hud
  current-color   (0|1|2...)    int     One out of /sim/hud/palette
  enable3d        (false|true)  bool    hud n=0 3D off|on
  enable3d[1]     (false|true)  bool    hud n=1 3D off|on
  frame-stat-type (tris|???)            ???
  path            (Huds/...)            Path to hud n=0
  path[1]         (Huds/...)            Path to hud n=1
  visibility      (false|true)  bool    hud n=0 hidden|visible
  visibility[1]   (false|true)  bool    hud n=1 hidden|visible
/sim/hud/color/          Contains settings of current-color
    alpha         (0...1)       float   0=invisible, 1=nontransparent
    alpha-clamp   (???)                 ???
    antialiased   (false|true)  bool    Antialiasing off|on
    blue          (0...1)       float 
    brightness    (0...1)       float   0=dark/black
    green         (0...1)       float
    red           (0...1)       float
    transparent   (false|true)  bool    Transparency off|on
/sim/hud/font/
    name          (*.txf)       string  One out of $FG_ROOT/Fonts
    size          (8)           float   Size of font
/sim/hud/palette/
/sim/hud/palette/color/         Settings of predefined colors, nearly
/sim/hud/palette/color[n]/      the same options as in /sim/hud/color.