FlightGear wiki - User contributions [en]

Transponder

2022-11-07T14:23:53Z

Thilo: EU uses squawk 7000 for VFR flights, squawk 7700 is a generic emergency code

'''Transponders''' are radio beacons which make [[aircraft]] more identifiable on [[ATC]] displays and systems. Modern transponders support transmitting additional data such as an identification ('squawk') code and aircraft altitude. See more at {{wikipedia|Transponder (aeronautics)}}.

== Id Codes ==
Id or 'squawk' codes aid ATC in identify aircraft positively. 1200 is the standard code for VFR flight (in the US; Europe uses 7000), IFR aircraft will typically be advised a code on delivery clearance or startup.

Normal code digits are 0..7; 0000 is reserved for military use, and there are other standard codes, such as 7600 for radio comms failure. See the Wikipedia page for many more examples.

== Modes ==
{{hatnote|For a thorough description, see {{wikipedia|Aviation transponder interrogation modes}}.}}

Civilian Mode-S and Mode-C both transmit pressure altitude (at 10-foot and 100-foot precision, respectively). To do this the transponder needs an altitude source. In real-life this can be a separate box called an encoder, or may be derived for FMC / ADIRU sources. It's important to note this altitude is referenced to standard pressure (29.92 inHg / 1012Hpa), and not corrected for actual barometric pressure in the local environment.

Additional support for military modes is possible if anyone wishes to add it.

== Configuration in FlightGear ==
Transponder support was overhauled in May 2013; earlier versions (2.10 and prior) have different support and are not documented here. Updating an aircraft to use the new config is straightforward. Key transponder properties (altitude, ident and transmitted-id) are now sent via the MP protocols for use in ATC clients.

The default altimeter can act as an altitude encoder; in its configuration, set either or both of the following boolean flags:

* encode-mode-c
* encode-mode-s

The transponder has various config properties:

* '''bus-volts''': required DV volts for operations, defaults to 8.0
* '''encoder-path''': defaults to '/instruments/altimeter', but can be changed to any other location. The transponder looks for child properties 'mode-c-alt-ft' and 'mode-s-alt-ft' at this path for altitude data.
* '''kt70-compatibility''': boolean, default to false. Set this to enable legacy compatibility with the old KT-70 C++ instrument. Do not use in new/updated aircraft!
* '''mode''': this is 0 for Mode-A, 1 for Mode-C and 2 for Mode-S. Other modes can be added, ask on the [[Mailing list|devel list]]!

=== Run-time properties ===
* '''altitude''': gives the transmitted altitude in feet (or -9999 for invalid)
* '''altitude-valid''': indicates if altitude value is valid data or not
* '''id-code''': allows the id-code to be read and set
* '''serviceable''': can be set to control the instrument serviceability
* '''transmitted-id''': gives the value being transmitted, including over the network via MP

==== Input properties ====
These live under <tt>/inputs</tt>.
* '''knob-mode''': sets the transponder operating mode. This corresponds to the KT-70 knob positions for convenience, but the actual modes should work for any transponder instrument. Knob modes are documented below
* '''ident-btn''': can be set to place the transponder in ident mode for 18 seconds. Note this property is not spring-loaded, i.e you must manually reset it to false
* '''digit[0]-[4]''': properties allow the id code individual digits to be read and set

In KT-70 compatibility mode, additional properties are read and set, to preserve legacy aircraft. Do not use these properties in new aircraft.

==== Knob/Functional Modes ====
* 0 - off
* 1 - standby, basically the same as off for the C++ code (3D instrument would power up the display, presumably)
* 2 - test, again the C++ largely ignores this since the test configuration of real-world instruments varies. In particular the unit does *not* set altitude or transmitted-id to any test values, you should do that in your own logic. (Maybe we should allow the test values to be defined int he config section?)
* 3 - Ground mode, responds to altitude interrogation but does not broadcast an ID. This would typically be used while taxiing prior to takeoff.
* 4 - On, normal operation but altitude transmission is inhibited
* 5 - Alt, same as on but altitude is broadcast if transponder was configured in Mode-S or Mode-C

=== Generic transponder ===
Below are all available property that you can set for your instrumentation.xml file :

<syntaxhighlight lang="xml">
<transponder>
<name type="string">transponder</name>
<number type="int">0</number>
<mode type="int">1</mode> 
<bus-volts type="double">8.0</bus-volts>
<encoder-path type="string">/instrumentation/altimeter</encoder-path>
<kt70-compatibility type="bool">0</kt70-compatibility>
</transponder>
</syntaxhighlight>

== Related content ==
=== Wiki articles ===
* [[Howto:Develop an aircraft transponder in Nasal]] – Most probably obsolete
* [[FLARM]]
* [[Multiplayer protocol]] – The IDs 1501-1503 are earmarked for transmitting transponder properties
* [[OpenRadar: Transponder]]
* [[Traffic alert and collision avoidance system]]

=== Forum topics ===
* [https://forum.flightgear.org/viewtopic.php?f=4&t=31492 Transponder properties over MP] (January-June 2017)
* [https://forum.flightgear.org/viewtopic.php?f=75&t=19826 Transponder over network] (April-December 2018)
* [https://forum.flightgear.org/viewtopic.php?f=4&t=6395 Transponder] (November 2009-December 2010)

=== Developer mailing list ===
* [https://sourceforge.net/p/flightgear/mailman/message/30785263/ <nowiki>[</nowiki>Flightgear-devel<nowiki>]</nowiki> Improve tranponder instrument] (Apr 2009)
* [https://sourceforge.net/p/flightgear/mailman/flightgear-devel/thread/1388915221.2195.15.camel%40duter.localdomain/#msg31810053 <nowiki>[</nowiki>Flightgear-devel<nowiki>]</nowiki> Transponder Ident not transmitted via MP Protocol?] (Jan-Feb 2014)

=== Source code ===
* {{flightgear source|src/Instrumentation/transponder.hxx}}
* {{flightgear source|src/Instrumentation/transponder.cxx}}

[[Category:Aircraft enhancement]]
[[Category:Aircraft instruments]]

Discord

2022-07-14T16:42:20Z

Thilo: Added soaring club

'''Discord''' is used in the FlightGear community as an alternative to [[Mumble]], [[TeamSpeak]], [[FGCom]] or [[Ventrilo]].

Discord is a free voice and chat software that can be downloaded as an app or used in a browser.

== Invite links ==
{{note|1=Its advised that you create a permanent account, instead of creating guest accounts as some people create duplicate accounts which clogs up the member logs and makes it more difficult to @mention people.}}

Furthermore many other FlightGear servers exist that you may need an personal invite to join. The easiest way to find them is to go to the FlightGear server and ask or ask in forums.

== FlightGear Communities on Discord ==

=== General, Help and Support, Communities ===

{| class=wikitable
! Topic !! Invite link
|-
| FlightGear
| https://discord.gg/rzuV2DR
|-
| FlightGear FDM School
| https://discord.gg/Uyrtsar
|-
| FlightGear Air Race League
| https://discord.gg/HCAuU9D
|-
| FlightGear Virtual Alliance
| https://discord.gg/VqzTG2N
|-
| FG Events
| https://discord.gg/GY4N6Cu
|-
| FG FDM School
| https://discord.gg/U5KXyMU
|-
| FlightGear Republic, A friendly community about FlightGear.
| https://discord.gg/sBJy46Uq7z
|-
|FlightGear soaring club
|https://discord.gg/NvJjmzMfRP
|}

=== Military Aviation Communities ===

{| class=wikitable
! Topic !! Invite link
|-
| Operation Red Flag military FG community (OPRF)
| https://discord.gg/ptVapkE
|-
| Combined Joint Task Force 50 (OPRF event planning/hosting and more)
| https://discord.gg/2nxjb6y
|-
| Warbirds, WWII-era aircraft
| https://discord.gg/yJaP5Wn
|}

=== Country Specific Communities ===

{| class=wikitable
! Topic !! Invite link
|-
| FlightGear Australia (Scenery Development & Community)
| https://discord.gg/JzTEXsZ
|-
| FlightGear Italia (ITA Mercenaries)
| https://discord.gg/5RzyXRf
|-
| FlightGear Germany
| https://discord.gg/FNnpjCPSze
|-
| FlightGear Indian Community
| https://discord.gg/Tu7n5FmG5S
|-
| FlightGear Asia
| https://discord.gg/7saCkA2jQj
|-
| FlightGear Hong Kong
| https://discord.gg/9QVKcT6skU
|-
|FlightGear Myanmar
|https://discord.gg/VbT88KEGrk
|-
|FlightGear Poland (FlightGear Polska)
|https://discord.gg/gHEXsjB7b6
|}

=== Aircraft-specific ===
{| class=wikitable
! Aircraft !! Invite link
|-
| Aermacchi MB-339
| https://discord.gg/vNZ5ZPv
|-
| Airbus [[Airbus A320 Family|A320]] & A330 Development
| https://discord.gg/7kzg9Te
|-
| Airbus A350 Development
| https://discord.gg/vK5f2s6
|-
| Boeing F/A-18C Hornet
| https://discord.gg/8GzpdK4j8P
|-
| LincolnWorks (747 and A380)
| https://discord.gg/2DMVpnJ
|-
| F-111 Aardvark
| https://discord.gg/DSrSbmx
|-
| [[General Dynamics F-16 Fighting Falcon]]
| https://discord.gg/8RcYnjA
|-
| MD-11, MD-80, ITAF by Octal
| https://discord.gg/gxAhC3j
|-
| [[Mikoyan-Gurevich MiG-21bis]]
| https://discord.gg/bs8xyz3
|-
| [[Mirage 2000]]
| https://discord.gg/xZ3r2KR
|-
| Panavia Tornado
| https://discord.gg/26rvkr2
|-
| [[Saab 37 Viggen]]
| https://discord.gg/RJTwS9a
|-
| SEPECAT Jaguar
| https://discord.gg/G5q5XYN
|-
| FG-1000 Stealth Fighter
| https://discord.gg/3MFZauxyPW
|-
|Boeing 777
|https://discord.gg/8McTuYdK
|-
|A-10A Warthog
|https://discord.gg/RmtjmsT5vS
|}

== External links ==
* https://discord.com/ Official website

[[de:Discord]]

[[Category:Software]]
[[Category:Community]]
[[Category:Air Traffic Control]]

Ramp Marshall

2022-02-19T17:00:01Z

Thilo: /* Prototype for a Visual Docking Guidance System (VDGS), entirely written in xml */

A '''(ramp) marshaller''' is a person who guides [[aircraft]] using hand (and wand) signals at a parking ramp. This is a new feature that being worked on for a more generalized scale in [[FlightGear]]. Until this gets merged into the fgdata repository, you can get this from omega95's fgdata clone or the new Singapore Scenery development.

Currently, support can be added to airports with the [[UFO]], but soon ramp marshallers will be added automatically if a parking spot's flag is set to enable it. This will integrate FlightGear parking positions, ramp marshallers and other features that might come up related to parking ramps or gates.

These are videos of the first prototype of the ramp marshaller.

{{#ev:youtube | c_KEbyv_h5A}} {{#ev:youtube | Hz4WU8nsdls}}

== Installation ==

=== How to install the ramp marshaller ===

# Download [https://github.com/RenanMsV/ramp-marshall this GitHub] and unzip it.
# Download this [https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://gitorious.org/fg/omega95s-fgdata.git&path=Nasal '''ramp_marshall.nas''']
# Put the '''Ramp''' Folder (can be found under Models/Airports in the GitHub) in $FG-ROOT\Models\Airport
# Put the [https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://gitorious.org/fg/omega95s-fgdata.git&path=Nasal '''ramp_marshall.nas'''] and the '''addon-main.nas''' (can be found unter the GitHub) in $FG-ROOT\Nasal
# Put every File and Folder wich is left now from the GitHub in your addons folder (see: [[Addon|how to install addons in FlightGear]])

== Using the ramp marshaller ==
To use the ramp marshaller with a compatible aircraft at a compatible airport (scroll down to see how you can make aircraft and/or airports compatible), simply taxi to the gate/ramp you want to park at and click on the marshaller waiting at the ramp. His hands should move from rest position (both wands down by his sides) to direct you to the ramp. It's recommended to taxi to the ramp on the taxiway lines as long as you can see them and once they go out of view, follow the marshaller's instructions. Make sure that you're not taxiing faster than 5 to 10 kts at the ramp.

Currently, the ramp marshaller knows the following signals -
* Move forward
* Turn left
* Turn right
* Slow down and stop
* Immediate stop

But we're teaching him new signals. If you want to teach him a signal, scroll down to find out how. To find out what the signals look like, take a look at the videos above.

== Adding ramp marshalling support ==
=== Adding ramp marshalling compatibility to aircraft ===
[[File:A330-200 Ramp Marshall Compatibility - getting position with ac3D.png|thumb|270px|Demonstrating how to get x-position of nose gear with AC3D for ramp marshalling compatibility.]]

It's actually very simple to add ramp marshalling compatibility to an aircraft, the only file required to be edited is the aircraft's [[Aircraft-set.xml|<tt>-set.xml</tt> file]] (or common xml file for aircraft groups). The user is still required to use some kind of 3D modeling program to get the position.

# Open the aircraft's model file (containing the gears) with a 3D modeling program and get the '''x''' position of the center of the nose gear. (Or the position you want to rest at the ramp)
# Add the following code within the <code><sim> ... <model> ... </model></sim></code> tags in the aircraft's <tt>-set.xml</tt> file. (or common xml file for aircraft groups)
<syntaxhighlight lang="xml">
<ramp>
<x-m type="float">-15.9664</x-m>
<class type="string">2</class>
</ramp>
</syntaxhighlight>
:The '''x''' position from the 3D model is in the <code><x-m></code> tag and the aircraft class is in the <code><class></code> tag. With the current models, the aircraft classes are as follows -
:* 0 - 747s, 777-300s, A340s, A380s
:* 1 - 777-300s, A330-300s, 787s
:* 2 - A330-200s, 757s, 767s
:* 3 - A320s (includes A318s, A319s and A321s), 737s and other aircraft in general. This works for CRJs, E-jets etc.

This should be all! The ramp marshaller should be able to ''recognize'' the aircraft and guide it to the right position at the ramp!

=== Adding ramp marshallers to an airport ===

'''NOTE -''' In the future, this will change because ramp marshall positions are going to be connected to an airport's '''groundnet.xml''' file.

[[File:ramp-marshall-arpt-1.png|thumb|270px|Placing ramp marshaller using ufo]]
[[File:ramp-marshall-arpt-2.png|thumb|270px|Converting STG file to ramps XML]]

# Start up FlightGear with the UFO at the airport you want to place ramp marshallers.
# Hit the {{key press|L}} key on the keyboard to bring up the model selection dialog and select <tt>[[$FG_ROOT]]/Models/Airport/Ramp/ramp.xml</tt>. Using the ufo's scenery editing tools, place (and adjust) ramp marshallers everywhere you want. To make it simpler, click on the exact position you want the airplane to come to a stop. This will usually be at the end of a parking ramp's taxiway lines. Then, you will only have to change the heading.
# Once you've finished placing all the models, hit the {{key press|D}} key to dump the stg lines onto the console. (Do not close FlightGear yet) Copy the stg lines into a blank file. (name does not matter) And save it somewhere on your PC ($FG-HOME is a good place for that).
# Open up the Nasal console and execute the following function.
#: <syntaxhighlight lang="javascript">ramp_marshall.convert_stg();</syntaxhighlight>
# Choose the stg file you pasted the dumped stg lines in to convert the file into a readable xml ramp position file. If you get following error: <code>(unauthorized directory - authorization no longer follows symlinks; to authorize reading additional directories, pass them to --allow-nasal-read)</code>, type in Command line in the Launcher following phrase: <code>--allow-nasal-read=/path/to/directory</code>. The converted file can be found <tt>[[$FG_HOME]]/Export</tt> or under the Roaming folder in Windows.
# Copy the exported file (it will be called '''ramps-export.xml''') to <tt>[[$FG_ROOT]]/AI/Airports/<icao>/ramps.xml</tt>. For example, if you want these ramps at Singapore Changi Intl. Airport (WSSS), you'd put it in <tt>[[$FG_ROOT]]/AI/Airports/WSSS/ramps.xml</tt>. (you have to rename the '''ramps-export.xml''' into '''ramps.xml'''). If there is no folder for your Airport, just create a new one with the icao of your Airport.

== Contributing to the module ==

=== Teach the ramp marshaller new signals ===

The marshaller's signal positions are stored in the '''ramp_marhsall.nas''' Nasal file in a hash. This is so that the signals can be accessed easily by other functions.

<syntaxhighlight lang="javascript">
var pos = {
rest: rmPos.new(lA_x:80, rA_x:-80),
stop: rmPos.new(lA_x:-55, lAO_x:-70, rA_x:55, rAO_x:70),
fwd_out: rmPos.new(lA_z:-50, lAO_x:-30, rA_z:50, rAO_x:30),
fwd_in: rmPos.new(lA_z:-50, lAO_x:-120, rA_z:50, rAO_x:120),
left_in: rmPos.new(lAO_x:-120),
left_out: rmPos.new(lAO_x:-30),
right_in: rmPos.new(rAO_x:120),
right_out: rmPos.new(rAO_x:30)
};
</syntaxhighlight>

* lA_x - Left Arm (shoulder joint) x axis rotation
* lA_y - Left Arm (shoulder joint) y axis rotation
* lA_z - Left Arm (shoulder joint) z axis rotation
* lAO_x - Left Arm Outer (elbow joint) x axis rotation
* lH_x - Left Hand x axis rotation
* lH_y - Left Hand y axis rotation
* lH_z - Left Hand x axis rotation
* rA_x - Right Arm (shoulder joint) x axis rotation
* rA_y - Right Arm (shoulder joint) y axis rotation
* rA_z - Right Arm (shoulder joint) z axis rotation
* rAO_x - Right Arm Outer (elbow joint) x axis rotation
* rH_x - Right Hand x axis rotation
* rH_y - Right Hand y axis rotation
* rH_z - Right Hand x axis rotation

You can mess with the positions in a 3D modeling program or in FlightGear itself. Just look in the property tree under <tt>/airports/{icao}/ramps/ramp[n]</tt> (find the correct 'n' index for the person last clicked on by looking at the <tt>/airports/active-ramp</tt> property) and set the ramp marshaller's function to something random (so it isn't recognized) and change the values in the tree. Note: to get this to work properly, you first have to click on the nearest ramp marshaller, look up his index, and then click on a different marshaller so that the other marshaller's properties are not updated.

If you would like to add a new hand position (say both hands out stright), then you'd add this to the bottom of the '''pos''' hash.

<syntaxhighlight lang="javascript">
hands_out_front: rmPos.new(lA_z:-90, rA_z:90)
</syntaxhighlight>

Note that one only needs to specify the rotations that are non-zero using hash syntax (key:value) in the arguments to the rmPos.new function. Remember to put a comma after the line right before the new one you add, since each line needs to end with a comma.

Now, you can call this position as '''pos.hands_out_front''' to be used in the sequence function. Or if you'd like to get or set one of the position values.

To add the signal sequence, add a new '''if''' state at the end of the last '''if(me.function == "<function_name>"''' statement with the sequence. You can use me.phase to control the sequence phase/step.

Then, add the signal sequence.

HINT - To animate the marshaller to a position you specified and then to go to the next step when it's complete and be achieved like this:

<syntaxhighlight lang="javascript">
if(me.phase == 0) {
if(!check_pos(ramp_tree, pos.hands_out_front)) {
full_animate(ramp_tree, pos.hands_out_front, 100);
} else {
me.phase = 1;
}
}
</syntaxhighlight>

The above code checks if the marshallers is not in the '''hands_out_front''' pos already and if he isn't, he'll move his hands to that position. In the full_animate function, you can specify the speed his hands should move at in ''degrees per second''. In this case, he'll move his hands forward to the specified position at 100 degrees per second.

==== Useful internal functions ====

* '''rmPos.new(lA_x, lA_z, lAO_x, rA_x, rA_z, rAO_x)''' creates and returns a new instance of the rmPos hash. This hash is in the '''pos.<pos_name>''' format and can be used in the functions below.

* '''getDeviation(heading, target)''' returns the deviation to a target heading from your current heading. This is used by the marshaller to help guide you to the ramp.

* '''animate(property, target, rate)''' animates a property (slowly changes the property value) to a target value at the given rate. (Rate is in degrees per second)

* '''get_pos_values(ramp_tree)''' returns the current position of the marshaller's arms in a hash similar to that of the pos.<pos_name> hash.

* '''check_pos(ramp_tree, target) returns true if the marshaller is at a given position. '''target''' must be a hash similar to the '''pos.<pos_name>''' hash. It is best to simply send a position specified in the '''pos''' hash.

* '''full_animate(ramp_tree, pos_hash, rate) animates the ramp marshaller to the given position at the given rate.

* '''load_ramps(icao)''' loads all ramps (and marshallers) at the given airport.

'''NOTE -''' If any of the functions has '''ramp_tree''' as an argument and the function is being used within the ''main_loop'', the variable '''ramp_tree''' must be passed as an argument.

=== Using different models or textures ===

Soon, new features will becoming available which lets the ramp marshaller model be specified in the position config file.

{{WIP}}

== Further development ==

=== Visual Docking Guidance System ===

===Prototype for a Visual Docking Guidance System (VDGS), entirely written in xml===
{{#ev:youtube | fgG55zZQx-k}}

==Related content==
===Wiki articles===
*[[Walk view]]

===Forum topics===
*{{forum link|t=20572|title=Nasal based Independant Ramp Marshall}} (August 2013-Mars 2018)

===Source code===
*[https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://gitorious.org/fg/omega95s-fgdata.git Omega95's fgdata Gitorious archive] archived from the {{gitorious source|proj=fg|repo=omega95s-fgdata|text=original}} Mars 30, 2016.
*[https://archive.softwareheritage.org/browse/origin/?origin_url=https%3A%2F%2Fgitorious.org%2Ffg-singapore-scenery%2Ffg-singapore-devel.git FG Singapore Scenery Gitorious archive] archived from the {{gitorious source|proj=fg-singapore-scenery|repo=fg-singapore-devel|text=original}} Mars 30, 2016.

[[Category:Scenery enhancement]]
[[Category:Aircraft enhancement]]

Ramp Marshall

2022-02-17T20:07:41Z

Thilo:

A '''(ramp) marshaller''' is a person who guides [[aircraft]] using hand (and wand) signals at a parking ramp. This is a new feature that being worked on for a more generalized scale in [[FlightGear]]. Until this gets merged into the fgdata repository, you can get this from omega95's fgdata clone or the new Singapore Scenery development.

Currently, support can be added to airports with the [[UFO]], but soon ramp marshallers will be added automatically if a parking spot's flag is set to enable it. This will integrate FlightGear parking positions, ramp marshallers and other features that might come up related to parking ramps or gates.

These are videos of the first prototype of the ramp marshaller.

{{#ev:youtube | c_KEbyv_h5A}} {{#ev:youtube | Hz4WU8nsdls}}

== Installation ==

=== How to install the ramp marshaller ===

# Download [https://github.com/RenanMsV/ramp-marshall this GitHub] and unzip it.
# Download this [https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://gitorious.org/fg/omega95s-fgdata.git&path=Nasal '''ramp_marshall.nas''']
# Put the '''Ramp''' Folder (can be found under Models/Airports in the GitHub) in $FG-ROOT\Models\Airport
# Put the [https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://gitorious.org/fg/omega95s-fgdata.git&path=Nasal '''ramp_marshall.nas'''] and the '''addon-main.nas''' (can be found unter the GitHub) in $FG-ROOT\Nasal
# Put every File and Folder wich is left now from the GitHub in your addons folder (see: [[Addon|how to install addons in FlightGear]])

== Using the ramp marshaller ==
To use the ramp marshaller with a compatible aircraft at a compatible airport (scroll down to see how you can make aircraft and/or airports compatible), simply taxi to the gate/ramp you want to park at and click on the marshaller waiting at the ramp. His hands should move from rest position (both wands down by his sides) to direct you to the ramp. It's recommended to taxi to the ramp on the taxiway lines as long as you can see them and once they go out of view, follow the marshaller's instructions. Make sure that you're not taxiing faster than 5 to 10 kts at the ramp.

Currently, the ramp marshaller knows the following signals -
* Move forward
* Turn left
* Turn right
* Slow down and stop
* Immediate stop

But we're teaching him new signals. If you want to teach him a signal, scroll down to find out how. To find out what the signals look like, take a look at the videos above.

== Adding ramp marshalling support ==
=== Adding ramp marshalling compatibility to aircraft ===
[[File:A330-200 Ramp Marshall Compatibility - getting position with ac3D.png|thumb|270px|Demonstrating how to get x-position of nose gear with AC3D for ramp marshalling compatibility.]]

It's actually very simple to add ramp marshalling compatibility to an aircraft, the only file required to be edited is the aircraft's [[Aircraft-set.xml|<tt>-set.xml</tt> file]] (or common xml file for aircraft groups). The user is still required to use some kind of 3D modeling program to get the position.

# Open the aircraft's model file (containing the gears) with a 3D modeling program and get the '''x''' position of the center of the nose gear. (Or the position you want to rest at the ramp)
# Add the following code within the <code><sim> ... <model> ... </model></sim></code> tags in the aircraft's <tt>-set.xml</tt> file. (or common xml file for aircraft groups)
<syntaxhighlight lang="xml">
<ramp>
<x-m type="float">-15.9664</x-m>
<class type="string">2</class>
</ramp>
</syntaxhighlight>
:The '''x''' position from the 3D model is in the <code><x-m></code> tag and the aircraft class is in the <code><class></code> tag. With the current models, the aircraft classes are as follows -
:* 0 - 747s, 777-300s, A340s, A380s
:* 1 - 777-300s, A330-300s, 787s
:* 2 - A330-200s, 757s, 767s
:* 3 - A320s (includes A318s, A319s and A321s), 737s and other aircraft in general. This works for CRJs, E-jets etc.

This should be all! The ramp marshaller should be able to ''recognize'' the aircraft and guide it to the right position at the ramp!

=== Adding ramp marshallers to an airport ===

'''NOTE -''' In the future, this will change because ramp marshall positions are going to be connected to an airport's '''groundnet.xml''' file.

[[File:ramp-marshall-arpt-1.png|thumb|270px|Placing ramp marshaller using ufo]]
[[File:ramp-marshall-arpt-2.png|thumb|270px|Converting STG file to ramps XML]]

# Start up FlightGear with the UFO at the airport you want to place ramp marshallers.
# Hit the {{key press|L}} key on the keyboard to bring up the model selection dialog and select <tt>[[$FG_ROOT]]/Models/Airport/Ramp/ramp.xml</tt>. Using the ufo's scenery editing tools, place (and adjust) ramp marshallers everywhere you want. To make it simpler, click on the exact position you want the airplane to come to a stop. This will usually be at the end of a parking ramp's taxiway lines. Then, you will only have to change the heading.
# Once you've finished placing all the models, hit the {{key press|D}} key to dump the stg lines onto the console. (Do not close FlightGear yet) Copy the stg lines into a blank file. (name does not matter) And save it somewhere on your PC ($FG-HOME is a good place for that).
# Open up the Nasal console and execute the following function.
#: <syntaxhighlight lang="javascript">ramp_marshall.convert_stg();</syntaxhighlight>
# Choose the stg file you pasted the dumped stg lines in to convert the file into a readable xml ramp position file. If you get following error: <code>(unauthorized directory - authorization no longer follows symlinks; to authorize reading additional directories, pass them to --allow-nasal-read)</code>, type in Command line in the Launcher following phrase: <code>--allow-nasal-read=/path/to/directory</code>. The converted file can be found <tt>[[$FG_HOME]]/Export</tt> or under the Roaming folder in Windows.
# Copy the exported file (it will be called '''ramps-export.xml''') to <tt>[[$FG_ROOT]]/AI/Airports/<icao>/ramps.xml</tt>. For example, if you want these ramps at Singapore Changi Intl. Airport (WSSS), you'd put it in <tt>[[$FG_ROOT]]/AI/Airports/WSSS/ramps.xml</tt>. (you have to rename the '''ramps-export.xml''' into '''ramps.xml'''). If there is no folder for your Airport, just create a new one with the icao of your Airport.

== Contributing to the module ==

=== Teach the ramp marshaller new signals ===

The marshaller's signal positions are stored in the '''ramp_marhsall.nas''' Nasal file in a hash. This is so that the signals can be accessed easily by other functions.

<syntaxhighlight lang="javascript">
var pos = {
rest: rmPos.new(lA_x:80, rA_x:-80),
stop: rmPos.new(lA_x:-55, lAO_x:-70, rA_x:55, rAO_x:70),
fwd_out: rmPos.new(lA_z:-50, lAO_x:-30, rA_z:50, rAO_x:30),
fwd_in: rmPos.new(lA_z:-50, lAO_x:-120, rA_z:50, rAO_x:120),
left_in: rmPos.new(lAO_x:-120),
left_out: rmPos.new(lAO_x:-30),
right_in: rmPos.new(rAO_x:120),
right_out: rmPos.new(rAO_x:30)
};
</syntaxhighlight>

* lA_x - Left Arm (shoulder joint) x axis rotation
* lA_y - Left Arm (shoulder joint) y axis rotation
* lA_z - Left Arm (shoulder joint) z axis rotation
* lAO_x - Left Arm Outer (elbow joint) x axis rotation
* lH_x - Left Hand x axis rotation
* lH_y - Left Hand y axis rotation
* lH_z - Left Hand x axis rotation
* rA_x - Right Arm (shoulder joint) x axis rotation
* rA_y - Right Arm (shoulder joint) y axis rotation
* rA_z - Right Arm (shoulder joint) z axis rotation
* rAO_x - Right Arm Outer (elbow joint) x axis rotation
* rH_x - Right Hand x axis rotation
* rH_y - Right Hand y axis rotation
* rH_z - Right Hand x axis rotation

You can mess with the positions in a 3D modeling program or in FlightGear itself. Just look in the property tree under <tt>/airports/{icao}/ramps/ramp[n]</tt> (find the correct 'n' index for the person last clicked on by looking at the <tt>/airports/active-ramp</tt> property) and set the ramp marshaller's function to something random (so it isn't recognized) and change the values in the tree. Note: to get this to work properly, you first have to click on the nearest ramp marshaller, look up his index, and then click on a different marshaller so that the other marshaller's properties are not updated.

If you would like to add a new hand position (say both hands out stright), then you'd add this to the bottom of the '''pos''' hash.

<syntaxhighlight lang="javascript">
hands_out_front: rmPos.new(lA_z:-90, rA_z:90)
</syntaxhighlight>

Note that one only needs to specify the rotations that are non-zero using hash syntax (key:value) in the arguments to the rmPos.new function. Remember to put a comma after the line right before the new one you add, since each line needs to end with a comma.

Now, you can call this position as '''pos.hands_out_front''' to be used in the sequence function. Or if you'd like to get or set one of the position values.

To add the signal sequence, add a new '''if''' state at the end of the last '''if(me.function == "<function_name>"''' statement with the sequence. You can use me.phase to control the sequence phase/step.

Then, add the signal sequence.

HINT - To animate the marshaller to a position you specified and then to go to the next step when it's complete and be achieved like this:

<syntaxhighlight lang="javascript">
if(me.phase == 0) {
if(!check_pos(ramp_tree, pos.hands_out_front)) {
full_animate(ramp_tree, pos.hands_out_front, 100);
} else {
me.phase = 1;
}
}
</syntaxhighlight>

The above code checks if the marshallers is not in the '''hands_out_front''' pos already and if he isn't, he'll move his hands to that position. In the full_animate function, you can specify the speed his hands should move at in ''degrees per second''. In this case, he'll move his hands forward to the specified position at 100 degrees per second.

==== Useful internal functions ====

* '''rmPos.new(lA_x, lA_z, lAO_x, rA_x, rA_z, rAO_x)''' creates and returns a new instance of the rmPos hash. This hash is in the '''pos.<pos_name>''' format and can be used in the functions below.

* '''getDeviation(heading, target)''' returns the deviation to a target heading from your current heading. This is used by the marshaller to help guide you to the ramp.

* '''animate(property, target, rate)''' animates a property (slowly changes the property value) to a target value at the given rate. (Rate is in degrees per second)

* '''get_pos_values(ramp_tree)''' returns the current position of the marshaller's arms in a hash similar to that of the pos.<pos_name> hash.

* '''check_pos(ramp_tree, target) returns true if the marshaller is at a given position. '''target''' must be a hash similar to the '''pos.<pos_name>''' hash. It is best to simply send a position specified in the '''pos''' hash.

* '''full_animate(ramp_tree, pos_hash, rate) animates the ramp marshaller to the given position at the given rate.

* '''load_ramps(icao)''' loads all ramps (and marshallers) at the given airport.

'''NOTE -''' If any of the functions has '''ramp_tree''' as an argument and the function is being used within the ''main_loop'', the variable '''ramp_tree''' must be passed as an argument.

=== Using different models or textures ===

Soon, new features will becoming available which lets the ramp marshaller model be specified in the position config file.

{{WIP}}

== Further development ==

=== Visual Docking Guidance System ===

===Prototype for a Visual Docking Guidance System (VDGS), entirely written in xml===
{{#ev:youtube | 5YYo2jPAlIw}}

==Related content==
===Wiki articles===
*[[Walk view]]

===Forum topics===
*{{forum link|t=20572|title=Nasal based Independant Ramp Marshall}} (August 2013-Mars 2018)

===Source code===
*[https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://gitorious.org/fg/omega95s-fgdata.git Omega95's fgdata Gitorious archive] archived from the {{gitorious source|proj=fg|repo=omega95s-fgdata|text=original}} Mars 30, 2016.
*[https://archive.softwareheritage.org/browse/origin/?origin_url=https%3A%2F%2Fgitorious.org%2Ffg-singapore-scenery%2Ffg-singapore-devel.git FG Singapore Scenery Gitorious archive] archived from the {{gitorious source|proj=fg-singapore-scenery|repo=fg-singapore-devel|text=original}} Mars 30, 2016.

[[Category:Scenery enhancement]]
[[Category:Aircraft enhancement]]

Ramp Marshall

2022-02-17T20:05:37Z

Thilo: /* Prototype for a Visual Docking Guidance System (VDGS), entirely written in xml */

A '''(ramp) marshaller''' is a person who guides [[aircraft]] using hand (and wand) signals at a parking ramp. This is a new feature that being worked on for a more generalized scale in [[FlightGear]]. Until this gets merged into the fgdata repository, you can get this from omega95's fgdata clone or the new Singapore Scenery development.

Currently, support can be added to airports with the [[UFO]], but soon ramp marshallers will be added automatically if a parking spot's flag is set to enable it. This will integrate FlightGear parking positions, ramp marshallers and other features that might come up related to parking ramps or gates.

These are videos of the first prototype of the ramp marshaller.

{{#ev:youtube | c_KEbyv_h5A}} {{#ev:youtube | Hz4WU8nsdls}}

== Installation ==

=== How to install the ramp marshaller ===

# Download [https://github.com/RenanMsV/ramp-marshall this GitHub] and unzip it.
# Download this [https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://gitorious.org/fg/omega95s-fgdata.git&path=Nasal '''ramp_marshall.nas''']
# Put the '''Ramp''' Folder (can be found under Models/Airports in the GitHub) in $FG-ROOT\Models\Airport
# Put the [https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://gitorious.org/fg/omega95s-fgdata.git&path=Nasal '''ramp_marshall.nas'''] and the '''addon-main.nas''' (can be found unter the GitHub) in $FG-ROOT\Nasal
# Put every File and Folder wich is left now from the GitHub in your addons folder (see: [[Addon|how to install addons in FlightGear]])

== Using the ramp marshaller ==
To use the ramp marshaller with a compatible aircraft at a compatible airport (scroll down to see how you can make aircraft and/or airports compatible), simply taxi to the gate/ramp you want to park at and click on the marshaller waiting at the ramp. His hands should move from rest position (both wands down by his sides) to direct you to the ramp. It's recommended to taxi to the ramp on the taxiway lines as long as you can see them and once they go out of view, follow the marshaller's instructions. Make sure that you're not taxiing faster than 5 to 10 kts at the ramp.

Currently, the ramp marshaller knows the following signals -
* Move forward
* Turn left
* Turn right
* Slow down and stop
* Immediate stop

But we're teaching him new signals. If you want to teach him a signal, scroll down to find out how. To find out what the signals look like, take a look at the videos above.

== Adding ramp marshalling support ==
=== Adding ramp marshalling compatibility to aircraft ===
[[File:A330-200 Ramp Marshall Compatibility - getting position with ac3D.png|thumb|270px|Demonstrating how to get x-position of nose gear with AC3D for ramp marshalling compatibility.]]

It's actually very simple to add ramp marshalling compatibility to an aircraft, the only file required to be edited is the aircraft's [[Aircraft-set.xml|<tt>-set.xml</tt> file]] (or common xml file for aircraft groups). The user is still required to use some kind of 3D modeling program to get the position.

# Open the aircraft's model file (containing the gears) with a 3D modeling program and get the '''x''' position of the center of the nose gear. (Or the position you want to rest at the ramp)
# Add the following code within the <code><sim> ... <model> ... </model></sim></code> tags in the aircraft's <tt>-set.xml</tt> file. (or common xml file for aircraft groups)
<syntaxhighlight lang="xml">
<ramp>
<x-m type="float">-15.9664</x-m>
<class type="string">2</class>
</ramp>
</syntaxhighlight>
:The '''x''' position from the 3D model is in the <code><x-m></code> tag and the aircraft class is in the <code><class></code> tag. With the current models, the aircraft classes are as follows -
:* 0 - 747s, 777-300s, A340s, A380s
:* 1 - 777-300s, A330-300s, 787s
:* 2 - A330-200s, 757s, 767s
:* 3 - A320s (includes A318s, A319s and A321s), 737s and other aircraft in general. This works for CRJs, E-jets etc.

This should be all! The ramp marshaller should be able to ''recognize'' the aircraft and guide it to the right position at the ramp!

=== Adding ramp marshallers to an airport ===

'''NOTE -''' In the future, this will change because ramp marshall positions are going to be connected to an airport's '''groundnet.xml''' file.

[[File:ramp-marshall-arpt-1.png|thumb|270px|Placing ramp marshaller using ufo]]
[[File:ramp-marshall-arpt-2.png|thumb|270px|Converting STG file to ramps XML]]

# Start up FlightGear with the UFO at the airport you want to place ramp marshallers.
# Hit the {{key press|L}} key on the keyboard to bring up the model selection dialog and select <tt>[[$FG_ROOT]]/Models/Airport/Ramp/ramp.xml</tt>. Using the ufo's scenery editing tools, place (and adjust) ramp marshallers everywhere you want. To make it simpler, click on the exact position you want the airplane to come to a stop. This will usually be at the end of a parking ramp's taxiway lines. Then, you will only have to change the heading.
# Once you've finished placing all the models, hit the {{key press|D}} key to dump the stg lines onto the console. (Do not close FlightGear yet) Copy the stg lines into a blank file. (name does not matter) And save it somewhere on your PC ($FG-HOME is a good place for that).
# Open up the Nasal console and execute the following function.
#: <syntaxhighlight lang="javascript">ramp_marshall.convert_stg();</syntaxhighlight>
# Choose the stg file you pasted the dumped stg lines in to convert the file into a readable xml ramp position file. If you get following error: <code>(unauthorized directory - authorization no longer follows symlinks; to authorize reading additional directories, pass them to --allow-nasal-read)</code>, type in Command line in the Launcher following phrase: <code>--allow-nasal-read=/path/to/directory</code>. The converted file can be found <tt>[[$FG_HOME]]/Export</tt> or under the Roaming folder in Windows.
# Copy the exported file (it will be called '''ramps-export.xml''') to <tt>[[$FG_ROOT]]/AI/Airports/<icao>/ramps.xml</tt>. For example, if you want these ramps at Singapore Changi Intl. Airport (WSSS), you'd put it in <tt>[[$FG_ROOT]]/AI/Airports/WSSS/ramps.xml</tt>. (you have to rename the '''ramps-export.xml''' into '''ramps.xml'''). If there is no folder for your Airport, just create a new one with the icao of your Airport.

== Contributing to the module ==

=== Teach the ramp marshaller new signals ===

The marshaller's signal positions are stored in the '''ramp_marhsall.nas''' Nasal file in a hash. This is so that the signals can be accessed easily by other functions.

<syntaxhighlight lang="javascript">
var pos = {
rest: rmPos.new(lA_x:80, rA_x:-80),
stop: rmPos.new(lA_x:-55, lAO_x:-70, rA_x:55, rAO_x:70),
fwd_out: rmPos.new(lA_z:-50, lAO_x:-30, rA_z:50, rAO_x:30),
fwd_in: rmPos.new(lA_z:-50, lAO_x:-120, rA_z:50, rAO_x:120),
left_in: rmPos.new(lAO_x:-120),
left_out: rmPos.new(lAO_x:-30),
right_in: rmPos.new(rAO_x:120),
right_out: rmPos.new(rAO_x:30)
};
</syntaxhighlight>

* lA_x - Left Arm (shoulder joint) x axis rotation
* lA_y - Left Arm (shoulder joint) y axis rotation
* lA_z - Left Arm (shoulder joint) z axis rotation
* lAO_x - Left Arm Outer (elbow joint) x axis rotation
* lH_x - Left Hand x axis rotation
* lH_y - Left Hand y axis rotation
* lH_z - Left Hand x axis rotation
* rA_x - Right Arm (shoulder joint) x axis rotation
* rA_y - Right Arm (shoulder joint) y axis rotation
* rA_z - Right Arm (shoulder joint) z axis rotation
* rAO_x - Right Arm Outer (elbow joint) x axis rotation
* rH_x - Right Hand x axis rotation
* rH_y - Right Hand y axis rotation
* rH_z - Right Hand x axis rotation

You can mess with the positions in a 3D modeling program or in FlightGear itself. Just look in the property tree under <tt>/airports/{icao}/ramps/ramp[n]</tt> (find the correct 'n' index for the person last clicked on by looking at the <tt>/airports/active-ramp</tt> property) and set the ramp marshaller's function to something random (so it isn't recognized) and change the values in the tree. Note: to get this to work properly, you first have to click on the nearest ramp marshaller, look up his index, and then click on a different marshaller so that the other marshaller's properties are not updated.

If you would like to add a new hand position (say both hands out stright), then you'd add this to the bottom of the '''pos''' hash.

<syntaxhighlight lang="javascript">
hands_out_front: rmPos.new(lA_z:-90, rA_z:90)
</syntaxhighlight>

Note that one only needs to specify the rotations that are non-zero using hash syntax (key:value) in the arguments to the rmPos.new function. Remember to put a comma after the line right before the new one you add, since each line needs to end with a comma.

Now, you can call this position as '''pos.hands_out_front''' to be used in the sequence function. Or if you'd like to get or set one of the position values.

To add the signal sequence, add a new '''if''' state at the end of the last '''if(me.function == "<function_name>"''' statement with the sequence. You can use me.phase to control the sequence phase/step.

Then, add the signal sequence.

HINT - To animate the marshaller to a position you specified and then to go to the next step when it's complete and be achieved like this:

<syntaxhighlight lang="javascript">
if(me.phase == 0) {
if(!check_pos(ramp_tree, pos.hands_out_front)) {
full_animate(ramp_tree, pos.hands_out_front, 100);
} else {
me.phase = 1;
}
}
</syntaxhighlight>

The above code checks if the marshallers is not in the '''hands_out_front''' pos already and if he isn't, he'll move his hands to that position. In the full_animate function, you can specify the speed his hands should move at in ''degrees per second''. In this case, he'll move his hands forward to the specified position at 100 degrees per second.

==== Useful internal functions ====

* '''rmPos.new(lA_x, lA_z, lAO_x, rA_x, rA_z, rAO_x)''' creates and returns a new instance of the rmPos hash. This hash is in the '''pos.<pos_name>''' format and can be used in the functions below.

* '''getDeviation(heading, target)''' returns the deviation to a target heading from your current heading. This is used by the marshaller to help guide you to the ramp.

* '''animate(property, target, rate)''' animates a property (slowly changes the property value) to a target value at the given rate. (Rate is in degrees per second)

* '''get_pos_values(ramp_tree)''' returns the current position of the marshaller's arms in a hash similar to that of the pos.<pos_name> hash.

* '''check_pos(ramp_tree, target) returns true if the marshaller is at a given position. '''target''' must be a hash similar to the '''pos.<pos_name>''' hash. It is best to simply send a position specified in the '''pos''' hash.

* '''full_animate(ramp_tree, pos_hash, rate) animates the ramp marshaller to the given position at the given rate.

* '''load_ramps(icao)''' loads all ramps (and marshallers) at the given airport.

'''NOTE -''' If any of the functions has '''ramp_tree''' as an argument and the function is being used within the ''main_loop'', the variable '''ramp_tree''' must be passed as an argument.

=== Using different models or textures ===

Soon, new features will becoming available which lets the ramp marshaller model be specified in the position config file.

{{WIP}}

== Further development ==

=== Visual Docking Guidance System ===

===Prototype for a Visual Docking Guidance System (VDGS), entirely written in xml===
https://youtu.be/5YYo2jPAlIw

==Related content==
===Wiki articles===
*[[Walk view]]

===Forum topics===
*{{forum link|t=20572|title=Nasal based Independant Ramp Marshall}} (August 2013-Mars 2018)

===Source code===
*[https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://gitorious.org/fg/omega95s-fgdata.git Omega95's fgdata Gitorious archive] archived from the {{gitorious source|proj=fg|repo=omega95s-fgdata|text=original}} Mars 30, 2016.
*[https://archive.softwareheritage.org/browse/origin/?origin_url=https%3A%2F%2Fgitorious.org%2Ffg-singapore-scenery%2Ffg-singapore-devel.git FG Singapore Scenery Gitorious archive] archived from the {{gitorious source|proj=fg-singapore-scenery|repo=fg-singapore-devel|text=original}} Mars 30, 2016.

[[Category:Scenery enhancement]]
[[Category:Aircraft enhancement]]

Ramp Marshall

2022-02-17T20:01:03Z

Thilo:

A '''(ramp) marshaller''' is a person who guides [[aircraft]] using hand (and wand) signals at a parking ramp. This is a new feature that being worked on for a more generalized scale in [[FlightGear]]. Until this gets merged into the fgdata repository, you can get this from omega95's fgdata clone or the new Singapore Scenery development.

Currently, support can be added to airports with the [[UFO]], but soon ramp marshallers will be added automatically if a parking spot's flag is set to enable it. This will integrate FlightGear parking positions, ramp marshallers and other features that might come up related to parking ramps or gates.

These are videos of the first prototype of the ramp marshaller.

{{#ev:youtube | c_KEbyv_h5A}} {{#ev:youtube | Hz4WU8nsdls}}

== Installation ==

=== How to install the ramp marshaller ===

# Download [https://github.com/RenanMsV/ramp-marshall this GitHub] and unzip it.
# Download this [https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://gitorious.org/fg/omega95s-fgdata.git&path=Nasal '''ramp_marshall.nas''']
# Put the '''Ramp''' Folder (can be found under Models/Airports in the GitHub) in $FG-ROOT\Models\Airport
# Put the [https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://gitorious.org/fg/omega95s-fgdata.git&path=Nasal '''ramp_marshall.nas'''] and the '''addon-main.nas''' (can be found unter the GitHub) in $FG-ROOT\Nasal
# Put every File and Folder wich is left now from the GitHub in your addons folder (see: [[Addon|how to install addons in FlightGear]])

== Using the ramp marshaller ==
To use the ramp marshaller with a compatible aircraft at a compatible airport (scroll down to see how you can make aircraft and/or airports compatible), simply taxi to the gate/ramp you want to park at and click on the marshaller waiting at the ramp. His hands should move from rest position (both wands down by his sides) to direct you to the ramp. It's recommended to taxi to the ramp on the taxiway lines as long as you can see them and once they go out of view, follow the marshaller's instructions. Make sure that you're not taxiing faster than 5 to 10 kts at the ramp.

Currently, the ramp marshaller knows the following signals -
* Move forward
* Turn left
* Turn right
* Slow down and stop
* Immediate stop

But we're teaching him new signals. If you want to teach him a signal, scroll down to find out how. To find out what the signals look like, take a look at the videos above.

== Adding ramp marshalling support ==
=== Adding ramp marshalling compatibility to aircraft ===
[[File:A330-200 Ramp Marshall Compatibility - getting position with ac3D.png|thumb|270px|Demonstrating how to get x-position of nose gear with AC3D for ramp marshalling compatibility.]]

It's actually very simple to add ramp marshalling compatibility to an aircraft, the only file required to be edited is the aircraft's [[Aircraft-set.xml|<tt>-set.xml</tt> file]] (or common xml file for aircraft groups). The user is still required to use some kind of 3D modeling program to get the position.

# Open the aircraft's model file (containing the gears) with a 3D modeling program and get the '''x''' position of the center of the nose gear. (Or the position you want to rest at the ramp)
# Add the following code within the <code><sim> ... <model> ... </model></sim></code> tags in the aircraft's <tt>-set.xml</tt> file. (or common xml file for aircraft groups)
<syntaxhighlight lang="xml">
<ramp>
<x-m type="float">-15.9664</x-m>
<class type="string">2</class>
</ramp>
</syntaxhighlight>
:The '''x''' position from the 3D model is in the <code><x-m></code> tag and the aircraft class is in the <code><class></code> tag. With the current models, the aircraft classes are as follows -
:* 0 - 747s, 777-300s, A340s, A380s
:* 1 - 777-300s, A330-300s, 787s
:* 2 - A330-200s, 757s, 767s
:* 3 - A320s (includes A318s, A319s and A321s), 737s and other aircraft in general. This works for CRJs, E-jets etc.

This should be all! The ramp marshaller should be able to ''recognize'' the aircraft and guide it to the right position at the ramp!

=== Adding ramp marshallers to an airport ===

'''NOTE -''' In the future, this will change because ramp marshall positions are going to be connected to an airport's '''groundnet.xml''' file.

[[File:ramp-marshall-arpt-1.png|thumb|270px|Placing ramp marshaller using ufo]]
[[File:ramp-marshall-arpt-2.png|thumb|270px|Converting STG file to ramps XML]]

# Start up FlightGear with the UFO at the airport you want to place ramp marshallers.
# Hit the {{key press|L}} key on the keyboard to bring up the model selection dialog and select <tt>[[$FG_ROOT]]/Models/Airport/Ramp/ramp.xml</tt>. Using the ufo's scenery editing tools, place (and adjust) ramp marshallers everywhere you want. To make it simpler, click on the exact position you want the airplane to come to a stop. This will usually be at the end of a parking ramp's taxiway lines. Then, you will only have to change the heading.
# Once you've finished placing all the models, hit the {{key press|D}} key to dump the stg lines onto the console. (Do not close FlightGear yet) Copy the stg lines into a blank file. (name does not matter) And save it somewhere on your PC ($FG-HOME is a good place for that).
# Open up the Nasal console and execute the following function.
#: <syntaxhighlight lang="javascript">ramp_marshall.convert_stg();</syntaxhighlight>
# Choose the stg file you pasted the dumped stg lines in to convert the file into a readable xml ramp position file. If you get following error: <code>(unauthorized directory - authorization no longer follows symlinks; to authorize reading additional directories, pass them to --allow-nasal-read)</code>, type in Command line in the Launcher following phrase: <code>--allow-nasal-read=/path/to/directory</code>. The converted file can be found <tt>[[$FG_HOME]]/Export</tt> or under the Roaming folder in Windows.
# Copy the exported file (it will be called '''ramps-export.xml''') to <tt>[[$FG_ROOT]]/AI/Airports/<icao>/ramps.xml</tt>. For example, if you want these ramps at Singapore Changi Intl. Airport (WSSS), you'd put it in <tt>[[$FG_ROOT]]/AI/Airports/WSSS/ramps.xml</tt>. (you have to rename the '''ramps-export.xml''' into '''ramps.xml'''). If there is no folder for your Airport, just create a new one with the icao of your Airport.

== Contributing to the module ==

=== Teach the ramp marshaller new signals ===

The marshaller's signal positions are stored in the '''ramp_marhsall.nas''' Nasal file in a hash. This is so that the signals can be accessed easily by other functions.

<syntaxhighlight lang="javascript">
var pos = {
rest: rmPos.new(lA_x:80, rA_x:-80),
stop: rmPos.new(lA_x:-55, lAO_x:-70, rA_x:55, rAO_x:70),
fwd_out: rmPos.new(lA_z:-50, lAO_x:-30, rA_z:50, rAO_x:30),
fwd_in: rmPos.new(lA_z:-50, lAO_x:-120, rA_z:50, rAO_x:120),
left_in: rmPos.new(lAO_x:-120),
left_out: rmPos.new(lAO_x:-30),
right_in: rmPos.new(rAO_x:120),
right_out: rmPos.new(rAO_x:30)
};
</syntaxhighlight>

* lA_x - Left Arm (shoulder joint) x axis rotation
* lA_y - Left Arm (shoulder joint) y axis rotation
* lA_z - Left Arm (shoulder joint) z axis rotation
* lAO_x - Left Arm Outer (elbow joint) x axis rotation
* lH_x - Left Hand x axis rotation
* lH_y - Left Hand y axis rotation
* lH_z - Left Hand x axis rotation
* rA_x - Right Arm (shoulder joint) x axis rotation
* rA_y - Right Arm (shoulder joint) y axis rotation
* rA_z - Right Arm (shoulder joint) z axis rotation
* rAO_x - Right Arm Outer (elbow joint) x axis rotation
* rH_x - Right Hand x axis rotation
* rH_y - Right Hand y axis rotation
* rH_z - Right Hand x axis rotation

You can mess with the positions in a 3D modeling program or in FlightGear itself. Just look in the property tree under <tt>/airports/{icao}/ramps/ramp[n]</tt> (find the correct 'n' index for the person last clicked on by looking at the <tt>/airports/active-ramp</tt> property) and set the ramp marshaller's function to something random (so it isn't recognized) and change the values in the tree. Note: to get this to work properly, you first have to click on the nearest ramp marshaller, look up his index, and then click on a different marshaller so that the other marshaller's properties are not updated.

If you would like to add a new hand position (say both hands out stright), then you'd add this to the bottom of the '''pos''' hash.

<syntaxhighlight lang="javascript">
hands_out_front: rmPos.new(lA_z:-90, rA_z:90)
</syntaxhighlight>

Note that one only needs to specify the rotations that are non-zero using hash syntax (key:value) in the arguments to the rmPos.new function. Remember to put a comma after the line right before the new one you add, since each line needs to end with a comma.

Now, you can call this position as '''pos.hands_out_front''' to be used in the sequence function. Or if you'd like to get or set one of the position values.

To add the signal sequence, add a new '''if''' state at the end of the last '''if(me.function == "<function_name>"''' statement with the sequence. You can use me.phase to control the sequence phase/step.

Then, add the signal sequence.

HINT - To animate the marshaller to a position you specified and then to go to the next step when it's complete and be achieved like this:

<syntaxhighlight lang="javascript">
if(me.phase == 0) {
if(!check_pos(ramp_tree, pos.hands_out_front)) {
full_animate(ramp_tree, pos.hands_out_front, 100);
} else {
me.phase = 1;
}
}
</syntaxhighlight>

The above code checks if the marshallers is not in the '''hands_out_front''' pos already and if he isn't, he'll move his hands to that position. In the full_animate function, you can specify the speed his hands should move at in ''degrees per second''. In this case, he'll move his hands forward to the specified position at 100 degrees per second.

==== Useful internal functions ====

* '''rmPos.new(lA_x, lA_z, lAO_x, rA_x, rA_z, rAO_x)''' creates and returns a new instance of the rmPos hash. This hash is in the '''pos.<pos_name>''' format and can be used in the functions below.

* '''getDeviation(heading, target)''' returns the deviation to a target heading from your current heading. This is used by the marshaller to help guide you to the ramp.

* '''animate(property, target, rate)''' animates a property (slowly changes the property value) to a target value at the given rate. (Rate is in degrees per second)

* '''get_pos_values(ramp_tree)''' returns the current position of the marshaller's arms in a hash similar to that of the pos.<pos_name> hash.

* '''check_pos(ramp_tree, target) returns true if the marshaller is at a given position. '''target''' must be a hash similar to the '''pos.<pos_name>''' hash. It is best to simply send a position specified in the '''pos''' hash.

* '''full_animate(ramp_tree, pos_hash, rate) animates the ramp marshaller to the given position at the given rate.

* '''load_ramps(icao)''' loads all ramps (and marshallers) at the given airport.

'''NOTE -''' If any of the functions has '''ramp_tree''' as an argument and the function is being used within the ''main_loop'', the variable '''ramp_tree''' must be passed as an argument.

=== Using different models or textures ===

Soon, new features will becoming available which lets the ramp marshaller model be specified in the position config file.

{{WIP}}

== Further development ==

=== Visual Docking Guidance System ===

===Prototype for a Visual Docking Guidance System (VDGS), entirely written in xml===
{{Youtube embed video simple v1|youtube_url_or_video_ID_from_youtube_url_required}}=https://youtu.be/5YYo2jPAlIw}}{{WIP}}

==Related content==
===Wiki articles===
*[[Walk view]]

===Forum topics===
*{{forum link|t=20572|title=Nasal based Independant Ramp Marshall}} (August 2013-Mars 2018)

===Source code===
*[https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://gitorious.org/fg/omega95s-fgdata.git Omega95's fgdata Gitorious archive] archived from the {{gitorious source|proj=fg|repo=omega95s-fgdata|text=original}} Mars 30, 2016.
*[https://archive.softwareheritage.org/browse/origin/?origin_url=https%3A%2F%2Fgitorious.org%2Ffg-singapore-scenery%2Ffg-singapore-devel.git FG Singapore Scenery Gitorious archive] archived from the {{gitorious source|proj=fg-singapore-scenery|repo=fg-singapore-devel|text=original}} Mars 30, 2016.

[[Category:Scenery enhancement]]
[[Category:Aircraft enhancement]]

Ramp Marshall

2022-02-17T19:56:34Z

Thilo:

A '''(ramp) marshaller''' is a person who guides [[aircraft]] using hand (and wand) signals at a parking ramp. This is a new feature that being worked on for a more generalized scale in [[FlightGear]]. Until this gets merged into the fgdata repository, you can get this from omega95's fgdata clone or the new Singapore Scenery development.

Currently, support can be added to airports with the [[UFO]], but soon ramp marshallers will be added automatically if a parking spot's flag is set to enable it. This will integrate FlightGear parking positions, ramp marshallers and other features that might come up related to parking ramps or gates.

These are videos of the first prototype of the ramp marshaller.

{{#ev:youtube | c_KEbyv_h5A}} {{#ev:youtube | Hz4WU8nsdls}}

== Installation ==

=== How to install the ramp marshaller ===

# Download [https://github.com/RenanMsV/ramp-marshall this GitHub] and unzip it.
# Download this [https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://gitorious.org/fg/omega95s-fgdata.git&path=Nasal '''ramp_marshall.nas''']
# Put the '''Ramp''' Folder (can be found under Models/Airports in the GitHub) in $FG-ROOT\Models\Airport
# Put the [https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://gitorious.org/fg/omega95s-fgdata.git&path=Nasal '''ramp_marshall.nas'''] and the '''addon-main.nas''' (can be found unter the GitHub) in $FG-ROOT\Nasal
# Put every File and Folder wich is left now from the GitHub in your addons folder (see: [[Addon|how to install addons in FlightGear]])

== Using the ramp marshaller ==
To use the ramp marshaller with a compatible aircraft at a compatible airport (scroll down to see how you can make aircraft and/or airports compatible), simply taxi to the gate/ramp you want to park at and click on the marshaller waiting at the ramp. His hands should move from rest position (both wands down by his sides) to direct you to the ramp. It's recommended to taxi to the ramp on the taxiway lines as long as you can see them and once they go out of view, follow the marshaller's instructions. Make sure that you're not taxiing faster than 5 to 10 kts at the ramp.

Currently, the ramp marshaller knows the following signals -
* Move forward
* Turn left
* Turn right
* Slow down and stop
* Immediate stop

But we're teaching him new signals. If you want to teach him a signal, scroll down to find out how. To find out what the signals look like, take a look at the videos above.

== Adding ramp marshalling support ==
=== Adding ramp marshalling compatibility to aircraft ===
[[File:A330-200 Ramp Marshall Compatibility - getting position with ac3D.png|thumb|270px|Demonstrating how to get x-position of nose gear with AC3D for ramp marshalling compatibility.]]

It's actually very simple to add ramp marshalling compatibility to an aircraft, the only file required to be edited is the aircraft's [[Aircraft-set.xml|<tt>-set.xml</tt> file]] (or common xml file for aircraft groups). The user is still required to use some kind of 3D modeling program to get the position.

# Open the aircraft's model file (containing the gears) with a 3D modeling program and get the '''x''' position of the center of the nose gear. (Or the position you want to rest at the ramp)
# Add the following code within the <code><sim> ... <model> ... </model></sim></code> tags in the aircraft's <tt>-set.xml</tt> file. (or common xml file for aircraft groups)
<syntaxhighlight lang="xml">
<ramp>
<x-m type="float">-15.9664</x-m>
<class type="string">2</class>
</ramp>
</syntaxhighlight>
:The '''x''' position from the 3D model is in the <code><x-m></code> tag and the aircraft class is in the <code><class></code> tag. With the current models, the aircraft classes are as follows -
:* 0 - 747s, 777-300s, A340s, A380s
:* 1 - 777-300s, A330-300s, 787s
:* 2 - A330-200s, 757s, 767s
:* 3 - A320s (includes A318s, A319s and A321s), 737s and other aircraft in general. This works for CRJs, E-jets etc.

This should be all! The ramp marshaller should be able to ''recognize'' the aircraft and guide it to the right position at the ramp!

=== Adding ramp marshallers to an airport ===

'''NOTE -''' In the future, this will change because ramp marshall positions are going to be connected to an airport's '''groundnet.xml''' file.

[[File:ramp-marshall-arpt-1.png|thumb|270px|Placing ramp marshaller using ufo]]
[[File:ramp-marshall-arpt-2.png|thumb|270px|Converting STG file to ramps XML]]

# Start up FlightGear with the UFO at the airport you want to place ramp marshallers.
# Hit the {{key press|L}} key on the keyboard to bring up the model selection dialog and select <tt>[[$FG_ROOT]]/Models/Airport/Ramp/ramp.xml</tt>. Using the ufo's scenery editing tools, place (and adjust) ramp marshallers everywhere you want. To make it simpler, click on the exact position you want the airplane to come to a stop. This will usually be at the end of a parking ramp's taxiway lines. Then, you will only have to change the heading.
# Once you've finished placing all the models, hit the {{key press|D}} key to dump the stg lines onto the console. (Do not close FlightGear yet) Copy the stg lines into a blank file. (name does not matter) And save it somewhere on your PC ($FG-HOME is a good place for that).
# Open up the Nasal console and execute the following function.
#: <syntaxhighlight lang="javascript">ramp_marshall.convert_stg();</syntaxhighlight>
# Choose the stg file you pasted the dumped stg lines in to convert the file into a readable xml ramp position file. If you get following error: <code>(unauthorized directory - authorization no longer follows symlinks; to authorize reading additional directories, pass them to --allow-nasal-read)</code>, type in Command line in the Launcher following phrase: <code>--allow-nasal-read=/path/to/directory</code>. The converted file can be found <tt>[[$FG_HOME]]/Export</tt> or under the Roaming folder in Windows.
# Copy the exported file (it will be called '''ramps-export.xml''') to <tt>[[$FG_ROOT]]/AI/Airports/<icao>/ramps.xml</tt>. For example, if you want these ramps at Singapore Changi Intl. Airport (WSSS), you'd put it in <tt>[[$FG_ROOT]]/AI/Airports/WSSS/ramps.xml</tt>. (you have to rename the '''ramps-export.xml''' into '''ramps.xml'''). If there is no folder for your Airport, just create a new one with the icao of your Airport.

== Contributing to the module ==

=== Teach the ramp marshaller new signals ===

The marshaller's signal positions are stored in the '''ramp_marhsall.nas''' Nasal file in a hash. This is so that the signals can be accessed easily by other functions.

<syntaxhighlight lang="javascript">
var pos = {
rest: rmPos.new(lA_x:80, rA_x:-80),
stop: rmPos.new(lA_x:-55, lAO_x:-70, rA_x:55, rAO_x:70),
fwd_out: rmPos.new(lA_z:-50, lAO_x:-30, rA_z:50, rAO_x:30),
fwd_in: rmPos.new(lA_z:-50, lAO_x:-120, rA_z:50, rAO_x:120),
left_in: rmPos.new(lAO_x:-120),
left_out: rmPos.new(lAO_x:-30),
right_in: rmPos.new(rAO_x:120),
right_out: rmPos.new(rAO_x:30)
};
</syntaxhighlight>

* lA_x - Left Arm (shoulder joint) x axis rotation
* lA_y - Left Arm (shoulder joint) y axis rotation
* lA_z - Left Arm (shoulder joint) z axis rotation
* lAO_x - Left Arm Outer (elbow joint) x axis rotation
* lH_x - Left Hand x axis rotation
* lH_y - Left Hand y axis rotation
* lH_z - Left Hand x axis rotation
* rA_x - Right Arm (shoulder joint) x axis rotation
* rA_y - Right Arm (shoulder joint) y axis rotation
* rA_z - Right Arm (shoulder joint) z axis rotation
* rAO_x - Right Arm Outer (elbow joint) x axis rotation
* rH_x - Right Hand x axis rotation
* rH_y - Right Hand y axis rotation
* rH_z - Right Hand x axis rotation

You can mess with the positions in a 3D modeling program or in FlightGear itself. Just look in the property tree under <tt>/airports/{icao}/ramps/ramp[n]</tt> (find the correct 'n' index for the person last clicked on by looking at the <tt>/airports/active-ramp</tt> property) and set the ramp marshaller's function to something random (so it isn't recognized) and change the values in the tree. Note: to get this to work properly, you first have to click on the nearest ramp marshaller, look up his index, and then click on a different marshaller so that the other marshaller's properties are not updated.

If you would like to add a new hand position (say both hands out stright), then you'd add this to the bottom of the '''pos''' hash.

<syntaxhighlight lang="javascript">
hands_out_front: rmPos.new(lA_z:-90, rA_z:90)
</syntaxhighlight>

Note that one only needs to specify the rotations that are non-zero using hash syntax (key:value) in the arguments to the rmPos.new function. Remember to put a comma after the line right before the new one you add, since each line needs to end with a comma.

Now, you can call this position as '''pos.hands_out_front''' to be used in the sequence function. Or if you'd like to get or set one of the position values.

To add the signal sequence, add a new '''if''' state at the end of the last '''if(me.function == "<function_name>"''' statement with the sequence. You can use me.phase to control the sequence phase/step.

Then, add the signal sequence.

HINT - To animate the marshaller to a position you specified and then to go to the next step when it's complete and be achieved like this:

<syntaxhighlight lang="javascript">
if(me.phase == 0) {
if(!check_pos(ramp_tree, pos.hands_out_front)) {
full_animate(ramp_tree, pos.hands_out_front, 100);
} else {
me.phase = 1;
}
}
</syntaxhighlight>

The above code checks if the marshallers is not in the '''hands_out_front''' pos already and if he isn't, he'll move his hands to that position. In the full_animate function, you can specify the speed his hands should move at in ''degrees per second''. In this case, he'll move his hands forward to the specified position at 100 degrees per second.

==== Useful internal functions ====

* '''rmPos.new(lA_x, lA_z, lAO_x, rA_x, rA_z, rAO_x)''' creates and returns a new instance of the rmPos hash. This hash is in the '''pos.<pos_name>''' format and can be used in the functions below.

* '''getDeviation(heading, target)''' returns the deviation to a target heading from your current heading. This is used by the marshaller to help guide you to the ramp.

* '''animate(property, target, rate)''' animates a property (slowly changes the property value) to a target value at the given rate. (Rate is in degrees per second)

* '''get_pos_values(ramp_tree)''' returns the current position of the marshaller's arms in a hash similar to that of the pos.<pos_name> hash.

* '''check_pos(ramp_tree, target) returns true if the marshaller is at a given position. '''target''' must be a hash similar to the '''pos.<pos_name>''' hash. It is best to simply send a position specified in the '''pos''' hash.

* '''full_animate(ramp_tree, pos_hash, rate) animates the ramp marshaller to the given position at the given rate.

* '''load_ramps(icao)''' loads all ramps (and marshallers) at the given airport.

'''NOTE -''' If any of the functions has '''ramp_tree''' as an argument and the function is being used within the ''main_loop'', the variable '''ramp_tree''' must be passed as an argument.

=== Using different models or textures ===

Soon, new features will becoming available which lets the ramp marshaller model be specified in the position config file.

{{WIP}}

== Further development ==

=== Visual Docking Guidance System ===

===Prototype for a Visual Docking Guidance System (VDGS), entirely written in xml===

{{Https://youtu.be/5YYo2jPAlIw}}{{WIP}}

==Related content==
===Wiki articles===
*[[Walk view]]

===Forum topics===
*{{forum link|t=20572|title=Nasal based Independant Ramp Marshall}} (August 2013-Mars 2018)

===Source code===
*[https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://gitorious.org/fg/omega95s-fgdata.git Omega95's fgdata Gitorious archive] archived from the {{gitorious source|proj=fg|repo=omega95s-fgdata|text=original}} Mars 30, 2016.
*[https://archive.softwareheritage.org/browse/origin/?origin_url=https%3A%2F%2Fgitorious.org%2Ffg-singapore-scenery%2Ffg-singapore-devel.git FG Singapore Scenery Gitorious archive] archived from the {{gitorious source|proj=fg-singapore-scenery|repo=fg-singapore-devel|text=original}} Mars 30, 2016.

[[Category:Scenery enhancement]]
[[Category:Aircraft enhancement]]

Ramp Marshall

2022-02-17T19:53:53Z

Thilo: /* Visual Docking Guidance System */

A '''(ramp) marshaller''' is a person who guides [[aircraft]] using hand (and wand) signals at a parking ramp. This is a new feature that being worked on for a more generalized scale in [[FlightGear]]. Until this gets merged into the fgdata repository, you can get this from omega95's fgdata clone or the new Singapore Scenery development.

Currently, support can be added to airports with the [[UFO]], but soon ramp marshallers will be added automatically if a parking spot's flag is set to enable it. This will integrate FlightGear parking positions, ramp marshallers and other features that might come up related to parking ramps or gates.

These are videos of the first prototype of the ramp marshaller.

{{#ev:youtube | c_KEbyv_h5A}} {{#ev:youtube | Hz4WU8nsdls}}

== Installation ==

=== How to install the ramp marshaller ===

# Download [https://github.com/RenanMsV/ramp-marshall this GitHub] and unzip it.
# Download this [https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://gitorious.org/fg/omega95s-fgdata.git&path=Nasal '''ramp_marshall.nas''']
# Put the '''Ramp''' Folder (can be found under Models/Airports in the GitHub) in $FG-ROOT\Models\Airport
# Put the [https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://gitorious.org/fg/omega95s-fgdata.git&path=Nasal '''ramp_marshall.nas'''] and the '''addon-main.nas''' (can be found unter the GitHub) in $FG-ROOT\Nasal
# Put every File and Folder wich is left now from the GitHub in your addons folder (see: [[Addon|how to install addons in FlightGear]])

== Using the ramp marshaller ==
To use the ramp marshaller with a compatible aircraft at a compatible airport (scroll down to see how you can make aircraft and/or airports compatible), simply taxi to the gate/ramp you want to park at and click on the marshaller waiting at the ramp. His hands should move from rest position (both wands down by his sides) to direct you to the ramp. It's recommended to taxi to the ramp on the taxiway lines as long as you can see them and once they go out of view, follow the marshaller's instructions. Make sure that you're not taxiing faster than 5 to 10 kts at the ramp.

Currently, the ramp marshaller knows the following signals -
* Move forward
* Turn left
* Turn right
* Slow down and stop
* Immediate stop

But we're teaching him new signals. If you want to teach him a signal, scroll down to find out how. To find out what the signals look like, take a look at the videos above.

== Adding ramp marshalling support ==
=== Adding ramp marshalling compatibility to aircraft ===
[[File:A330-200 Ramp Marshall Compatibility - getting position with ac3D.png|thumb|270px|Demonstrating how to get x-position of nose gear with AC3D for ramp marshalling compatibility.]]

It's actually very simple to add ramp marshalling compatibility to an aircraft, the only file required to be edited is the aircraft's [[Aircraft-set.xml|<tt>-set.xml</tt> file]] (or common xml file for aircraft groups). The user is still required to use some kind of 3D modeling program to get the position.

# Open the aircraft's model file (containing the gears) with a 3D modeling program and get the '''x''' position of the center of the nose gear. (Or the position you want to rest at the ramp)
# Add the following code within the <code><sim> ... <model> ... </model></sim></code> tags in the aircraft's <tt>-set.xml</tt> file. (or common xml file for aircraft groups)
<syntaxhighlight lang="xml">
<ramp>
<x-m type="float">-15.9664</x-m>
<class type="string">2</class>
</ramp>
</syntaxhighlight>
:The '''x''' position from the 3D model is in the <code><x-m></code> tag and the aircraft class is in the <code><class></code> tag. With the current models, the aircraft classes are as follows -
:* 0 - 747s, 777-300s, A340s, A380s
:* 1 - 777-300s, A330-300s, 787s
:* 2 - A330-200s, 757s, 767s
:* 3 - A320s (includes A318s, A319s and A321s), 737s and other aircraft in general. This works for CRJs, E-jets etc.

This should be all! The ramp marshaller should be able to ''recognize'' the aircraft and guide it to the right position at the ramp!

=== Adding ramp marshallers to an airport ===

'''NOTE -''' In the future, this will change because ramp marshall positions are going to be connected to an airport's '''groundnet.xml''' file.

[[File:ramp-marshall-arpt-1.png|thumb|270px|Placing ramp marshaller using ufo]]
[[File:ramp-marshall-arpt-2.png|thumb|270px|Converting STG file to ramps XML]]

# Start up FlightGear with the UFO at the airport you want to place ramp marshallers.
# Hit the {{key press|L}} key on the keyboard to bring up the model selection dialog and select <tt>[[$FG_ROOT]]/Models/Airport/Ramp/ramp.xml</tt>. Using the ufo's scenery editing tools, place (and adjust) ramp marshallers everywhere you want. To make it simpler, click on the exact position you want the airplane to come to a stop. This will usually be at the end of a parking ramp's taxiway lines. Then, you will only have to change the heading.
# Once you've finished placing all the models, hit the {{key press|D}} key to dump the stg lines onto the console. (Do not close FlightGear yet) Copy the stg lines into a blank file. (name does not matter) And save it somewhere on your PC ($FG-HOME is a good place for that).
# Open up the Nasal console and execute the following function.
#: <syntaxhighlight lang="javascript">ramp_marshall.convert_stg();</syntaxhighlight>
# Choose the stg file you pasted the dumped stg lines in to convert the file into a readable xml ramp position file. If you get following error: <code>(unauthorized directory - authorization no longer follows symlinks; to authorize reading additional directories, pass them to --allow-nasal-read)</code>, type in Command line in the Launcher following phrase: <code>--allow-nasal-read=/path/to/directory</code>. The converted file can be found <tt>[[$FG_HOME]]/Export</tt> or under the Roaming folder in Windows.
# Copy the exported file (it will be called '''ramps-export.xml''') to <tt>[[$FG_ROOT]]/AI/Airports/<icao>/ramps.xml</tt>. For example, if you want these ramps at Singapore Changi Intl. Airport (WSSS), you'd put it in <tt>[[$FG_ROOT]]/AI/Airports/WSSS/ramps.xml</tt>. (you have to rename the '''ramps-export.xml''' into '''ramps.xml'''). If there is no folder for your Airport, just create a new one with the icao of your Airport.

== Contributing to the module ==

=== Teach the ramp marshaller new signals ===

The marshaller's signal positions are stored in the '''ramp_marhsall.nas''' Nasal file in a hash. This is so that the signals can be accessed easily by other functions.

<syntaxhighlight lang="javascript">
var pos = {
rest: rmPos.new(lA_x:80, rA_x:-80),
stop: rmPos.new(lA_x:-55, lAO_x:-70, rA_x:55, rAO_x:70),
fwd_out: rmPos.new(lA_z:-50, lAO_x:-30, rA_z:50, rAO_x:30),
fwd_in: rmPos.new(lA_z:-50, lAO_x:-120, rA_z:50, rAO_x:120),
left_in: rmPos.new(lAO_x:-120),
left_out: rmPos.new(lAO_x:-30),
right_in: rmPos.new(rAO_x:120),
right_out: rmPos.new(rAO_x:30)
};
</syntaxhighlight>

* lA_x - Left Arm (shoulder joint) x axis rotation
* lA_y - Left Arm (shoulder joint) y axis rotation
* lA_z - Left Arm (shoulder joint) z axis rotation
* lAO_x - Left Arm Outer (elbow joint) x axis rotation
* lH_x - Left Hand x axis rotation
* lH_y - Left Hand y axis rotation
* lH_z - Left Hand x axis rotation
* rA_x - Right Arm (shoulder joint) x axis rotation
* rA_y - Right Arm (shoulder joint) y axis rotation
* rA_z - Right Arm (shoulder joint) z axis rotation
* rAO_x - Right Arm Outer (elbow joint) x axis rotation
* rH_x - Right Hand x axis rotation
* rH_y - Right Hand y axis rotation
* rH_z - Right Hand x axis rotation

You can mess with the positions in a 3D modeling program or in FlightGear itself. Just look in the property tree under <tt>/airports/{icao}/ramps/ramp[n]</tt> (find the correct 'n' index for the person last clicked on by looking at the <tt>/airports/active-ramp</tt> property) and set the ramp marshaller's function to something random (so it isn't recognized) and change the values in the tree. Note: to get this to work properly, you first have to click on the nearest ramp marshaller, look up his index, and then click on a different marshaller so that the other marshaller's properties are not updated.

If you would like to add a new hand position (say both hands out stright), then you'd add this to the bottom of the '''pos''' hash.

<syntaxhighlight lang="javascript">
hands_out_front: rmPos.new(lA_z:-90, rA_z:90)
</syntaxhighlight>

Note that one only needs to specify the rotations that are non-zero using hash syntax (key:value) in the arguments to the rmPos.new function. Remember to put a comma after the line right before the new one you add, since each line needs to end with a comma.

Now, you can call this position as '''pos.hands_out_front''' to be used in the sequence function. Or if you'd like to get or set one of the position values.

To add the signal sequence, add a new '''if''' state at the end of the last '''if(me.function == "<function_name>"''' statement with the sequence. You can use me.phase to control the sequence phase/step.

Then, add the signal sequence.

HINT - To animate the marshaller to a position you specified and then to go to the next step when it's complete and be achieved like this:

<syntaxhighlight lang="javascript">
if(me.phase == 0) {
if(!check_pos(ramp_tree, pos.hands_out_front)) {
full_animate(ramp_tree, pos.hands_out_front, 100);
} else {
me.phase = 1;
}
}
</syntaxhighlight>

The above code checks if the marshallers is not in the '''hands_out_front''' pos already and if he isn't, he'll move his hands to that position. In the full_animate function, you can specify the speed his hands should move at in ''degrees per second''. In this case, he'll move his hands forward to the specified position at 100 degrees per second.

==== Useful internal functions ====

* '''rmPos.new(lA_x, lA_z, lAO_x, rA_x, rA_z, rAO_x)''' creates and returns a new instance of the rmPos hash. This hash is in the '''pos.<pos_name>''' format and can be used in the functions below.

* '''getDeviation(heading, target)''' returns the deviation to a target heading from your current heading. This is used by the marshaller to help guide you to the ramp.

* '''animate(property, target, rate)''' animates a property (slowly changes the property value) to a target value at the given rate. (Rate is in degrees per second)

* '''get_pos_values(ramp_tree)''' returns the current position of the marshaller's arms in a hash similar to that of the pos.<pos_name> hash.

* '''check_pos(ramp_tree, target) returns true if the marshaller is at a given position. '''target''' must be a hash similar to the '''pos.<pos_name>''' hash. It is best to simply send a position specified in the '''pos''' hash.

* '''full_animate(ramp_tree, pos_hash, rate) animates the ramp marshaller to the given position at the given rate.

* '''load_ramps(icao)''' loads all ramps (and marshallers) at the given airport.

'''NOTE -''' If any of the functions has '''ramp_tree''' as an argument and the function is being used within the ''main_loop'', the variable '''ramp_tree''' must be passed as an argument.

=== Using different models or textures ===

Soon, new features will becoming available which lets the ramp marshaller model be specified in the position config file.

{{WIP}}

== Further development ==

=== Visual Docking Guidance System ===

===Prototype for a Visual Docking Guidance System (VDGS), entirely written in xml===

<iframe width="1264" height="711" src="https://www.youtube.com/embed/5YYo2jPAlIw" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>{{WIP}}

==Related content==
===Wiki articles===
*[[Walk view]]

===Forum topics===
*{{forum link|t=20572|title=Nasal based Independant Ramp Marshall}} (August 2013-Mars 2018)

===Source code===
*[https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://gitorious.org/fg/omega95s-fgdata.git Omega95's fgdata Gitorious archive] archived from the {{gitorious source|proj=fg|repo=omega95s-fgdata|text=original}} Mars 30, 2016.
*[https://archive.softwareheritage.org/browse/origin/?origin_url=https%3A%2F%2Fgitorious.org%2Ffg-singapore-scenery%2Ffg-singapore-devel.git FG Singapore Scenery Gitorious archive] archived from the {{gitorious source|proj=fg-singapore-scenery|repo=fg-singapore-devel|text=original}} Mars 30, 2016.

[[Category:Scenery enhancement]]
[[Category:Aircraft enhancement]]

Discord

2022-01-25T13:17:22Z

Thilo:

'''Discord''' is used in the FlightGear community as an alternative to [[Mumble]], [[TeamSpeak]], [[FGCom]] or [[Ventrilo]].

Discord is a free voice and chat software that can be downloaded as an app or used in a browser.

== Invite links ==
{{note|1=Its advised that you create a permanent account, instead of creating guest accounts as some people create duplicate accounts which clogs up the member logs and makes it more difficult to @mention people.}}

Furthermore many other FlightGear servers exist that you may need an personal invite to join. The easiest way to find them is to go to the FlightGear server and ask or ask in forums.

== FlightGear Communities on Discord ==

=== General, Help and Support, Communities ===

{| class=wikitable
! Topic !! Invite link
|-
| FlightGear
| https://discord.gg/rzuV2DR
|-
| FlightGear FDM School
| https://discord.gg/Uyrtsar
|-
| FlightGear Air Race League
| https://discord.gg/HCAuU9D
|-
| FlightGear Virtual Alliance
| https://discord.gg/VqzTG2N
|-
| FG Events
| https://discord.gg/GY4N6Cu
|-
| FG FDM School
| https://discord.gg/U5KXyMU
|-
| FlightGear Republic, A friendly community about FlightGear.
| https://discord.gg/sBJy46Uq7z
|}

=== Military Aviation Communities ===

{| class=wikitable
! Topic !! Invite link
|-
| Operation Red Flag military FG community (OPRF)
| https://discord.gg/ptVapkE
|-
| Combined Joint Task Force 50 (OPRF event planning/hosting and more)
| https://discord.gg/2nxjb6y
|-
| Warbirds, WWII-era aircraft
| https://discord.gg/yJaP5Wn
|}

=== Country Specific Communities ===

{| class=wikitable
! Topic !! Invite link
|-
| FlightGear Australia (Scenery Development & Community)
| https://discord.gg/JzTEXsZ
|-
| FlightGear Italia (ITA Mercenaries)
| https://discord.gg/5RzyXRf
|-
| FlightGear Germany
| https://discord.gg/FNnpjCPSze
|-
| FlightGear Indian Community
| https://discord.gg/Tu7n5FmG5S
|-
| FlightGear Asia
| https://discord.gg/7saCkA2jQj
|-
| FlightGear Hong Kong
| https://discord.gg/9QVKcT6skU
|-
|FlightGear Myanmar
|https://discord.gg/VbT88KEGrk
|}

=== Aircraft-specific ===
{| class=wikitable
! Aircraft !! Invite link
|-
| Aermacchi MB-339
| https://discord.gg/vNZ5ZPv
|-
| Airbus [[Airbus A320 Family|A320]] & A330 Development
| https://discord.gg/7kzg9Te
|-
| Airbus A350 Development
| https://discord.gg/vK5f2s6
|-
| Boeing F/A-18C Hornet
| https://discord.gg/8GzpdK4j8P
|-
| LincolnWorks (747 and A380)
| https://discord.gg/2DMVpnJ
|-
| F-111 Aardvark
| https://discord.gg/DSrSbmx
|-
| [[General Dynamics F-16 Fighting Falcon]]
| https://discord.gg/8RcYnjA
|-
| MD-11 and Autoflight by Octal
| https://discord.gg/gxAhC3j
|-
| [[Mikoyan-Gurevich MiG-21bis]]
| https://discord.gg/bs8xyz3
|-
| [[Mirage 2000]]
| https://discord.gg/xZ3r2KR
|-
| Panavia Tornado
| https://discord.gg/26rvkr2
|-
| [[Saab 37 Viggen]]
| https://discord.gg/RJTwS9a
|-
| SEPECAT Jaguar
| https://discord.gg/G5q5XYN
|-
| FG-1000 Stealth Fighter
| https://discord.gg/3MFZauxyPW
|-
|Boeing 777
|https://discord.gg/8McTuYdK
|-
|A-10A Warthog
|https://discord.gg/RmtjmsT5vS
|}

== External links ==
* https://discord.com/ Official website

[[de:Discord]]

[[Category:Software]]
[[Category:Community]]
[[Category:Air Traffic Control]]

Discord

2022-01-17T13:04:23Z

Thilo: added ULM school

'''Discord''' is used in the FlightGear community as an alternative to [[Mumble]], [[TeamSpeak]], [[FGCom]] or [[Ventrilo]].

Discord is a free voice and chat software that can be downloaded as an app or used in a browser.

== Invite links ==
{{note|1=Its advised that you create a permanent account, instead of creating guest accounts as some people create duplicate accounts which clogs up the member logs and makes it more difficult to @mention people.}}

Furthermore many other FlightGear servers exist that you may need an personal invite to join. The easiest way to find them is to go to the FlightGear server and ask or ask in forums.

== FlightGear Communities on Discord ==

=== General, Help and Support, Communities ===

{| class=wikitable
! Topic !! Invite link
|-
| FlightGear
| https://discord.gg/rzuV2DR
|-
| FlightGear FDM School
| https://discord.gg/Uyrtsar
|-
| FlightGear Air Race League
| https://discord.gg/HCAuU9D
|-
| FlightGear Virtual Alliance
| https://discord.gg/VqzTG2N
|-
| FG Events
| https://discord.gg/GY4N6Cu
|-
| FG FDM School
| https://discord.gg/U5KXyMU
|-
| FlightGear Republic, A friendly community about FlightGear.
| https://discord.gg/sBJy46Uq7z
|-
|FlightGear ULM (Ultralight Aircraft) Flightschool
|https://discord.gg/ECFhEWNBrv
|}

=== Military Aviation Communities ===

{| class=wikitable
! Topic !! Invite link
|-
| Operation Red Flag military FG community (OPRF)
| https://discord.gg/ptVapkE
|-
| Combined Joint Task Force 50 (OPRF event planning/hosting and more)
| https://discord.gg/2nxjb6y
|-
| Warbirds, WWII-era aircraft
| https://discord.gg/yJaP5Wn
|}

=== Country Specific Communities ===

{| class=wikitable
! Topic !! Invite link
|-
| FlightGear Australia (Scenery Development & Community)
| https://discord.gg/JzTEXsZ
|-
| FlightGear Italia (ITA Mercenaries)
| https://discord.gg/5RzyXRf
|-
| FlightGear Germany
| https://discord.gg/FNnpjCPSze
|-
| FlightGear Indian Community
| https://discord.gg/Tu7n5FmG5S
|-
| FlightGear Asia
| https://discord.gg/7saCkA2jQj
|-
| FlightGear Hong Kong
| https://discord.gg/9QVKcT6skU
|-
|FlightGear Myanmar
|https://discord.gg/VbT88KEGrk
|}

=== Aircraft-specific ===
{| class=wikitable
! Aircraft !! Invite link
|-
| Aermacchi MB-339
| https://discord.gg/vNZ5ZPv
|-
| Airbus [[Airbus A320 Family|A320]] & A330 Development
| https://discord.gg/7kzg9Te
|-
| Airbus A350 Development
| https://discord.gg/vK5f2s6
|-
| Boeing F/A-18C Hornet
| https://discord.gg/8GzpdK4j8P
|-
| LincolnWorks (747 and A380)
| https://discord.gg/2DMVpnJ
|-
| F-111 Aardvark
| https://discord.gg/DSrSbmx
|-
| [[General Dynamics F-16 Fighting Falcon]]
| https://discord.gg/8RcYnjA
|-
| MD-11 and Autoflight by Octal
| https://discord.gg/gxAhC3j
|-
| [[Mikoyan-Gurevich MiG-21bis]]
| https://discord.gg/bs8xyz3
|-
| [[Mirage 2000]]
| https://discord.gg/xZ3r2KR
|-
| Panavia Tornado
| https://discord.gg/26rvkr2
|-
| [[Saab 37 Viggen]]
| https://discord.gg/RJTwS9a
|-
| SEPECAT Jaguar
| https://discord.gg/G5q5XYN
|-
| FG-1000 Stealth Fighter
| https://discord.gg/3MFZauxyPW
|-
|Boeing 777
|https://discord.gg/8McTuYdK
|-
|A-10A Warthog
|https://discord.gg/RmtjmsT5vS
|}

== External links ==
* https://discord.com/ Official website

[[de:Discord]]

[[Category:Software]]
[[Category:Community]]
[[Category:Air Traffic Control]]

Ramp Marshall

2021-04-27T10:50:51Z

Thilo: Some updates in the installation page

A '''(ramp) marshaller''' is a person who guides [[aircraft]] using hand (and wand) signals at a parking ramp. This is a new feature that being worked on for a more generalized scale in [[FlightGear]]. Until this gets merged into the fgdata repository, you can get this from omega95's fgdata clone or the new Singapore Scenery development.

Currently, support can be added to airports with the [[UFO]], but soon ramp marshallers will be added automatically if a parking spot's flag is set to enable it. This will integrate FlightGear parking positions, ramp marshallers and other features that might come up related to parking ramps or gates.

These are videos of the first prototype of the ramp marshaller.

{{#ev:youtube | c_KEbyv_h5A}} {{#ev:youtube | Hz4WU8nsdls}}

== Installation ==

=== How to install the ramp marshaller ===

# Download [https://github.com/RenanMsV/ramp-marshall this GitHub] and unzip it.
# Download this [https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://gitorious.org/fg/omega95s-fgdata.git&path=Nasal '''ramp_marshall.nas''']
# Put the '''Ramp''' Folder (can be found under Models/Airports in the GitHub) in $FG-ROOT\Models\Airport
# Put the [https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://gitorious.org/fg/omega95s-fgdata.git&path=Nasal '''ramp_marshall.nas'''] and the '''addon-main.nas''' (can be found unter the GitHub) in $FG-ROOT\Nasal
# Put every File and Folder wich is left now from the GitHub in your addons folder (see: [[Addon|how to install addons in FlightGear]])

== Using the ramp marshaller ==
To use the ramp marshaller with a compatible aircraft at a compatible airport (scroll down to see how you can make aircraft and/or airports compatible), simply taxi to the gate/ramp you want to park at and click on the marshaller waiting at the ramp. His hands should move from rest position (both wands down by his sides) to direct you to the ramp. It's recommended to taxi to the ramp on the taxiway lines as long as you can see them and once they go out of view, follow the marshaller's instructions. Make sure that you're not taxiing faster than 5 to 10 kts at the ramp.

Currently, the ramp marshaller knows the following signals -
* Move forward
* Turn left
* Turn right
* Slow down and stop
* Immediate stop

But we're teaching him new signals. If you want to teach him a signal, scroll down to find out how. To find out what the signals look like, take a look at the videos above.

== Adding ramp marshalling support ==
=== Adding ramp marshalling compatibility to aircraft ===
[[File:A330-200 Ramp Marshall Compatibility - getting position with ac3D.png|thumb|270px|Demonstrating how to get x-position of nose gear with AC3D for ramp marshalling compatibility.]]

It's actually very simple to add ramp marshalling compatibility to an aircraft, the only file required to be edited is the aircraft's [[Aircraft-set.xml|<tt>-set.xml</tt> file]] (or common xml file for aircraft groups). The user is still required to use some kind of 3D modeling program to get the position.

# Open the aircraft's model file (containing the gears) with a 3D modeling program and get the '''x''' position of the center of the nose gear. (Or the position you want to rest at the ramp)
# Add the following code within the <code><sim> ... <model> ... </model></sim></code> tags in the aircraft's <tt>-set.xml</tt> file. (or common xml file for aircraft groups)
<syntaxhighlight lang="xml">
<ramp>
<x-m type="float">-15.9664</x-m>
<class type="string">2</class>
</ramp>
</syntaxhighlight>
:The '''x''' position from the 3D model is in the <code><x-m></code> tag and the aircraft class is in the <code><class></code> tag. With the current models, the aircraft classes are as follows -
:* 0 - 747s, 777-300s, A340s, A380s
:* 1 - 777-300s, A330-300s, 787s
:* 2 - A330-200s, 757s, 767s
:* 3 - A320s (includes A318s, A319s and A321s), 737s and other aircraft in general. This works for CRJs, E-jets etc.

This should be all! The ramp marshaller should be able to ''recognize'' the aircraft and guide it to the right position at the ramp!

=== Adding ramp marshallers to an airport ===

'''NOTE -''' In the future, this will change because ramp marshall positions are going to be connected to an airport's '''groundnet.xml''' file.

[[File:ramp-marshall-arpt-1.png|thumb|270px|Placing ramp marshaller using ufo]]
[[File:ramp-marshall-arpt-2.png|thumb|270px|Converting STG file to ramps XML]]

# Start up FlightGear with the UFO at the airport you want to place ramp marshallers.
# Hit the {{key press|L}} key on the keyboard to bring up the model selection dialog and select <tt>[[$FG_ROOT]]/Models/Airport/Ramp/ramp.xml</tt>. Using the ufo's scenery editing tools, place (and adjust) ramp marshallers everywhere you want. To make it simpler, click on the exact position you want the airplane to come to a stop. This will usually be at the end of a parking ramp's taxiway lines. Then, you will only have to change the heading.
# Once you've finished placing all the models, hit the {{key press|D}} key to dump the stg lines onto the console. (Do not close FlightGear yet) Copy the stg lines into a blank file. (name does not matter) And save it somewhere on your PC ($FG-HOME is a good place for that).
# Open up the Nasal console and execute the following function.
#: <syntaxhighlight lang="javascript">ramp_marshall.convert_stg();</syntaxhighlight>
# Choose the stg file you pasted the dumped stg lines in to convert the file into a readable xml ramp position file. If you get following error: <code>(unauthorized directory - authorization no longer follows symlinks; to authorize reading additional directories, pass them to --allow-nasal-read)</code>, type in Command line in the Launcher following phrase: <code>--allow-nasal-read=/path/to/directory</code>. The converted file can be found <tt>[[$FG_HOME]]/Export</tt> or under the Roaming folder in Windows.
# Copy the exported file (it will be called '''ramps-export.xml''') to <tt>[[$FG_ROOT]]/AI/Airports/<icao>/ramps.xml</tt>. For example, if you want these ramps at Singapore Changi Intl. Airport (WSSS), you'd put it in <tt>[[$FG_ROOT]]/AI/Airports/WSSS/ramps.xml</tt>. (you have to rename the '''ramps-export.xml''' into '''ramps.xml'''). If there is no folder for your Airport, just create a new one with the icao of your Airport.

== Contributing to the module ==

=== Teach the ramp marshaller new signals ===

The marshaller's signal positions are stored in the '''ramp_marhsall.nas''' Nasal file in a hash. This is so that the signals can be accessed easily by other functions.

<syntaxhighlight lang="javascript">
var pos = {
rest: rmPos.new(lA_x:80, rA_x:-80),
stop: rmPos.new(lA_x:-55, lAO_x:-70, rA_x:55, rAO_x:70),
fwd_out: rmPos.new(lA_z:-50, lAO_x:-30, rA_z:50, rAO_x:30),
fwd_in: rmPos.new(lA_z:-50, lAO_x:-120, rA_z:50, rAO_x:120),
left_in: rmPos.new(lAO_x:-120),
left_out: rmPos.new(lAO_x:-30),
right_in: rmPos.new(rAO_x:120),
right_out: rmPos.new(rAO_x:30)
};
</syntaxhighlight>

* lA_x - Left Arm (shoulder joint) x axis rotation
* lA_y - Left Arm (shoulder joint) y axis rotation
* lA_z - Left Arm (shoulder joint) z axis rotation
* lAO_x - Left Arm Outer (elbow joint) x axis rotation
* lH_x - Left Hand x axis rotation
* lH_y - Left Hand y axis rotation
* lH_z - Left Hand x axis rotation
* rA_x - Right Arm (shoulder joint) x axis rotation
* rA_y - Right Arm (shoulder joint) y axis rotation
* rA_z - Right Arm (shoulder joint) z axis rotation
* rAO_x - Right Arm Outer (elbow joint) x axis rotation
* rH_x - Right Hand x axis rotation
* rH_y - Right Hand y axis rotation
* rH_z - Right Hand x axis rotation

You can mess with the positions in a 3D modeling program or in FlightGear itself. Just look in the property tree under <tt>/airports/{icao}/ramps/ramp[n]</tt> (find the correct 'n' index for the person last clicked on by looking at the <tt>/airports/active-ramp</tt> property) and set the ramp marshaller's function to something random (so it isn't recognized) and change the values in the tree. Note: to get this to work properly, you first have to click on the nearest ramp marshaller, look up his index, and then click on a different marshaller so that the other marshaller's properties are not updated.

If you would like to add a new hand position (say both hands out stright), then you'd add this to the bottom of the '''pos''' hash.

<syntaxhighlight lang="javascript">
hands_out_front: rmPos.new(lA_z:-90, rA_z:90)
</syntaxhighlight>

Note that one only needs to specify the rotations that are non-zero using hash syntax (key:value) in the arguments to the rmPos.new function. Remember to put a comma after the line right before the new one you add, since each line needs to end with a comma.

Now, you can call this position as '''pos.hands_out_front''' to be used in the sequence function. Or if you'd like to get or set one of the position values.

To add the signal sequence, add a new '''if''' state at the end of the last '''if(me.function == "<function_name>"''' statement with the sequence. You can use me.phase to control the sequence phase/step.

Then, add the signal sequence.

HINT - To animate the marshaller to a position you specified and then to go to the next step when it's complete and be achieved like this:

<syntaxhighlight lang="javascript">
if(me.phase == 0) {
if(!check_pos(ramp_tree, pos.hands_out_front)) {
full_animate(ramp_tree, pos.hands_out_front, 100);
} else {
me.phase = 1;
}
}
</syntaxhighlight>

The above code checks if the marshallers is not in the '''hands_out_front''' pos already and if he isn't, he'll move his hands to that position. In the full_animate function, you can specify the speed his hands should move at in ''degrees per second''. In this case, he'll move his hands forward to the specified position at 100 degrees per second.

==== Useful internal functions ====

* '''rmPos.new(lA_x, lA_z, lAO_x, rA_x, rA_z, rAO_x)''' creates and returns a new instance of the rmPos hash. This hash is in the '''pos.<pos_name>''' format and can be used in the functions below.

* '''getDeviation(heading, target)''' returns the deviation to a target heading from your current heading. This is used by the marshaller to help guide you to the ramp.

* '''animate(property, target, rate)''' animates a property (slowly changes the property value) to a target value at the given rate. (Rate is in degrees per second)

* '''get_pos_values(ramp_tree)''' returns the current position of the marshaller's arms in a hash similar to that of the pos.<pos_name> hash.

* '''check_pos(ramp_tree, target) returns true if the marshaller is at a given position. '''target''' must be a hash similar to the '''pos.<pos_name>''' hash. It is best to simply send a position specified in the '''pos''' hash.

* '''full_animate(ramp_tree, pos_hash, rate) animates the ramp marshaller to the given position at the given rate.

* '''load_ramps(icao)''' loads all ramps (and marshallers) at the given airport.

'''NOTE -''' If any of the functions has '''ramp_tree''' as an argument and the function is being used within the ''main_loop'', the variable '''ramp_tree''' must be passed as an argument.

=== Using different models or textures ===

Soon, new features will becoming available which lets the ramp marshaller model be specified in the position config file.

{{WIP}}

== Further development ==

=== Visual Docking Guidance System ===

{{WIP}}

== Related content ==
=== Wiki articles ===
* [[Walk view]]

=== Forum topics ===
* {{forum link|t=20572|title=Nasal based Independant Ramp Marshall}} (August 2013-Mars 2018)

=== Source code ===
* [https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://gitorious.org/fg/omega95s-fgdata.git Omega95's fgdata Gitorious archive] archived from the {{gitorious source|proj=fg|repo=omega95s-fgdata|text=original}} Mars 30, 2016.
* [https://archive.softwareheritage.org/browse/origin/?origin_url=https%3A%2F%2Fgitorious.org%2Ffg-singapore-scenery%2Ffg-singapore-devel.git FG Singapore Scenery Gitorious archive] archived from the {{gitorious source|proj=fg-singapore-scenery|repo=fg-singapore-devel|text=original}} Mars 30, 2016.

[[Category:Scenery enhancement]]
[[Category:Aircraft enhancement]]

Ramp Marshall

2021-04-27T10:27:39Z

Thilo: Some updates in the installation page

A '''(ramp) marshaller''' is a person who guides [[aircraft]] using hand (and wand) signals at a parking ramp. This is a new feature that being worked on for a more generalized scale in [[FlightGear]]. Until this gets merged into the fgdata repository, you can get this from omega95's fgdata clone or the new Singapore Scenery development.

Currently, support can be added to airports with the [[UFO]], but soon ramp marshallers will be added automatically if a parking spot's flag is set to enable it. This will integrate FlightGear parking positions, ramp marshallers and other features that might come up related to parking ramps or gates.

These are videos of the first prototype of the ramp marshaller.

{{#ev:youtube | c_KEbyv_h5A}} {{#ev:youtube | Hz4WU8nsdls}}

== Installation ==

=== How to install the ramp marshaller ===

# Download [https://github.com/RenanMsV/ramp-marshall this GitHub] and unzip it.
# Download this [https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://gitorious.org/fg/omega95s-fgdata.git&path=Nasal '''ramp_marshall.nas''']
# Put the '''Ramp''' Folder (can be found under Models/Airports in the GitHub) in $FG-ROOT\Models\Airport
# Put every File and Folder wich is left now (inclusive the [https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://gitorious.org/fg/omega95s-fgdata.git&path=Nasal ramp_marshall.nas]) of the GitHub in your addons folder (see: [[Addon|how to install addons in FlightGear]])

== Using the ramp marshaller ==
To use the ramp marshaller with a compatible aircraft at a compatible airport (scroll down to see how you can make aircraft and/or airports compatible), simply taxi to the gate/ramp you want to park at and click on the marshaller waiting at the ramp. His hands should move from rest position (both wands down by his sides) to direct you to the ramp. It's recommended to taxi to the ramp on the taxiway lines as long as you can see them and once they go out of view, follow the marshaller's instructions. Make sure that you're not taxiing faster than 5 to 10 kts at the ramp.

Currently, the ramp marshaller knows the following signals -
* Move forward
* Turn left
* Turn right
* Slow down and stop
* Immediate stop

But we're teaching him new signals. If you want to teach him a signal, scroll down to find out how. To find out what the signals look like, take a look at the videos above.

== Adding ramp marshalling support ==
=== Adding ramp marshalling compatibility to aircraft ===
[[File:A330-200 Ramp Marshall Compatibility - getting position with ac3D.png|thumb|270px|Demonstrating how to get x-position of nose gear with AC3D for ramp marshalling compatibility.]]

It's actually very simple to add ramp marshalling compatibility to an aircraft, the only file required to be edited is the aircraft's [[Aircraft-set.xml|<tt>-set.xml</tt> file]] (or common xml file for aircraft groups). The user is still required to use some kind of 3D modeling program to get the position.

# Open the aircraft's model file (containing the gears) with a 3D modeling program and get the '''x''' position of the center of the nose gear. (Or the position you want to rest at the ramp)
# Add the following code within the <code><sim> ... <model> ... </model></sim></code> tags in the aircraft's <tt>-set.xml</tt> file. (or common xml file for aircraft groups)
<syntaxhighlight lang="xml">
<ramp>
<x-m type="float">-15.9664</x-m>
<class type="string">2</class>
</ramp>
</syntaxhighlight>
:The '''x''' position from the 3D model is in the <code><x-m></code> tag and the aircraft class is in the <code><class></code> tag. With the current models, the aircraft classes are as follows -
:* 0 - 747s, 777-300s, A340s, A380s
:* 1 - 777-300s, A330-300s, 787s
:* 2 - A330-200s, 757s, 767s
:* 3 - A320s (includes A318s, A319s and A321s), 737s and other aircraft in general. This works for CRJs, E-jets etc.

This should be all! The ramp marshaller should be able to ''recognize'' the aircraft and guide it to the right position at the ramp!

=== Adding ramp marshallers to an airport ===

'''NOTE -''' In the future, this will change because ramp marshall positions are going to be connected to an airport's '''groundnet.xml''' file.

[[File:ramp-marshall-arpt-1.png|thumb|270px|Placing ramp marshaller using ufo]]
[[File:ramp-marshall-arpt-2.png|thumb|270px|Converting STG file to ramps XML]]

# Start up FlightGear with the UFO at the airport you want to place ramp marshallers.
# Hit the {{key press|L}} key on the keyboard to bring up the model selection dialog and select <tt>[[$FG_ROOT]]/Models/Airport/Ramp/ramp.xml</tt>. Using the ufo's scenery editing tools, place (and adjust) ramp marshallers everywhere you want. To make it simpler, click on the exact position you want the airplane to come to a stop. This will usually be at the end of a parking ramp's taxiway lines. Then, you will only have to change the heading.
# Once you've finished placing all the models, hit the {{key press|D}} key to dump the stg lines onto the console. (Do not close FlightGear yet) Copy the stg lines into a blank file. (name does not matter) And save it somewhere on your PC ($FG-HOME is a good place for that).
# Open up the Nasal console and execute the following function.
#: <syntaxhighlight lang="javascript">ramp_marshall.convert_stg();</syntaxhighlight>
# Choose the stg file you pasted the dumped stg lines in to convert the file into a readable xml ramp position file. If you get following error: <code>(unauthorized directory - authorization no longer follows symlinks; to authorize reading additional directories, pass them to --allow-nasal-read)</code>, type in Command line in the Launcher following phrase: <code>--allow-nasal-read=/path/to/directory</code>. The converted file can be found <tt>[[$FG_HOME]]/Export</tt> or under the Roaming folder in Windows.
# Copy the exported file (it will be called '''ramps-export.xml''') to <tt>[[$FG_ROOT]]/AI/Airports/<icao>/ramps.xml</tt>. For example, if you want these ramps at Singapore Changi Intl. Airport (WSSS), you'd put it in <tt>[[$FG_ROOT]]/AI/Airports/WSSS/ramps.xml</tt>. (you have to rename the '''ramps-export.xml''' into '''ramps.xml'''). If there is no folder for your Airport, just create a new one with the icao of your Airport.

== Contributing to the module ==

=== Teach the ramp marshaller new signals ===

The marshaller's signal positions are stored in the '''ramp_marhsall.nas''' Nasal file in a hash. This is so that the signals can be accessed easily by other functions.

<syntaxhighlight lang="javascript">
var pos = {
rest: rmPos.new(lA_x:80, rA_x:-80),
stop: rmPos.new(lA_x:-55, lAO_x:-70, rA_x:55, rAO_x:70),
fwd_out: rmPos.new(lA_z:-50, lAO_x:-30, rA_z:50, rAO_x:30),
fwd_in: rmPos.new(lA_z:-50, lAO_x:-120, rA_z:50, rAO_x:120),
left_in: rmPos.new(lAO_x:-120),
left_out: rmPos.new(lAO_x:-30),
right_in: rmPos.new(rAO_x:120),
right_out: rmPos.new(rAO_x:30)
};
</syntaxhighlight>

* lA_x - Left Arm (shoulder joint) x axis rotation
* lA_y - Left Arm (shoulder joint) y axis rotation
* lA_z - Left Arm (shoulder joint) z axis rotation
* lAO_x - Left Arm Outer (elbow joint) x axis rotation
* lH_x - Left Hand x axis rotation
* lH_y - Left Hand y axis rotation
* lH_z - Left Hand x axis rotation
* rA_x - Right Arm (shoulder joint) x axis rotation
* rA_y - Right Arm (shoulder joint) y axis rotation
* rA_z - Right Arm (shoulder joint) z axis rotation
* rAO_x - Right Arm Outer (elbow joint) x axis rotation
* rH_x - Right Hand x axis rotation
* rH_y - Right Hand y axis rotation
* rH_z - Right Hand x axis rotation

You can mess with the positions in a 3D modeling program or in FlightGear itself. Just look in the property tree under <tt>/airports/{icao}/ramps/ramp[n]</tt> (find the correct 'n' index for the person last clicked on by looking at the <tt>/airports/active-ramp</tt> property) and set the ramp marshaller's function to something random (so it isn't recognized) and change the values in the tree. Note: to get this to work properly, you first have to click on the nearest ramp marshaller, look up his index, and then click on a different marshaller so that the other marshaller's properties are not updated.

If you would like to add a new hand position (say both hands out stright), then you'd add this to the bottom of the '''pos''' hash.

<syntaxhighlight lang="javascript">
hands_out_front: rmPos.new(lA_z:-90, rA_z:90)
</syntaxhighlight>

Note that one only needs to specify the rotations that are non-zero using hash syntax (key:value) in the arguments to the rmPos.new function. Remember to put a comma after the line right before the new one you add, since each line needs to end with a comma.

Now, you can call this position as '''pos.hands_out_front''' to be used in the sequence function. Or if you'd like to get or set one of the position values.

To add the signal sequence, add a new '''if''' state at the end of the last '''if(me.function == "<function_name>"''' statement with the sequence. You can use me.phase to control the sequence phase/step.

Then, add the signal sequence.

HINT - To animate the marshaller to a position you specified and then to go to the next step when it's complete and be achieved like this:

<syntaxhighlight lang="javascript">
if(me.phase == 0) {
if(!check_pos(ramp_tree, pos.hands_out_front)) {
full_animate(ramp_tree, pos.hands_out_front, 100);
} else {
me.phase = 1;
}
}
</syntaxhighlight>

The above code checks if the marshallers is not in the '''hands_out_front''' pos already and if he isn't, he'll move his hands to that position. In the full_animate function, you can specify the speed his hands should move at in ''degrees per second''. In this case, he'll move his hands forward to the specified position at 100 degrees per second.

==== Useful internal functions ====

* '''rmPos.new(lA_x, lA_z, lAO_x, rA_x, rA_z, rAO_x)''' creates and returns a new instance of the rmPos hash. This hash is in the '''pos.<pos_name>''' format and can be used in the functions below.

* '''getDeviation(heading, target)''' returns the deviation to a target heading from your current heading. This is used by the marshaller to help guide you to the ramp.

* '''animate(property, target, rate)''' animates a property (slowly changes the property value) to a target value at the given rate. (Rate is in degrees per second)

* '''get_pos_values(ramp_tree)''' returns the current position of the marshaller's arms in a hash similar to that of the pos.<pos_name> hash.

* '''check_pos(ramp_tree, target) returns true if the marshaller is at a given position. '''target''' must be a hash similar to the '''pos.<pos_name>''' hash. It is best to simply send a position specified in the '''pos''' hash.

* '''full_animate(ramp_tree, pos_hash, rate) animates the ramp marshaller to the given position at the given rate.

* '''load_ramps(icao)''' loads all ramps (and marshallers) at the given airport.

'''NOTE -''' If any of the functions has '''ramp_tree''' as an argument and the function is being used within the ''main_loop'', the variable '''ramp_tree''' must be passed as an argument.

=== Using different models or textures ===

Soon, new features will becoming available which lets the ramp marshaller model be specified in the position config file.

{{WIP}}

== Further development ==

=== Visual Docking Guidance System ===

{{WIP}}

== Related content ==
=== Wiki articles ===
* [[Walk view]]

=== Forum topics ===
* {{forum link|t=20572|title=Nasal based Independant Ramp Marshall}} (August 2013-Mars 2018)

=== Source code ===
* [https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://gitorious.org/fg/omega95s-fgdata.git Omega95's fgdata Gitorious archive] archived from the {{gitorious source|proj=fg|repo=omega95s-fgdata|text=original}} Mars 30, 2016.
* [https://archive.softwareheritage.org/browse/origin/?origin_url=https%3A%2F%2Fgitorious.org%2Ffg-singapore-scenery%2Ffg-singapore-devel.git FG Singapore Scenery Gitorious archive] archived from the {{gitorious source|proj=fg-singapore-scenery|repo=fg-singapore-devel|text=original}} Mars 30, 2016.

[[Category:Scenery enhancement]]
[[Category:Aircraft enhancement]]

Ramp Marshall

2021-04-27T10:18:06Z

Thilo: Added a Installation page and added some more phrases for more clarification

A '''(ramp) marshaller''' is a person who guides [[aircraft]] using hand (and wand) signals at a parking ramp. This is a new feature that being worked on for a more generalized scale in [[FlightGear]]. Until this gets merged into the fgdata repository, you can get this from omega95's fgdata clone or the new Singapore Scenery development.

Currently, support can be added to airports with the [[UFO]], but soon ramp marshallers will be added automatically if a parking spot's flag is set to enable it. This will integrate FlightGear parking positions, ramp marshallers and other features that might come up related to parking ramps or gates.

These are videos of the first prototype of the ramp marshaller.

{{#ev:youtube | c_KEbyv_h5A}} {{#ev:youtube | Hz4WU8nsdls}}

== Installation ==

=== How to install the ramp marshaller ===

# Download [https://github.com/RenanMsV/ramp-marshall this GitHub] and unzip it.
# Download this [https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://gitorious.org/fg/omega95s-fgdata.git&path=Nasal '''ramp_marshall.nas''']
# Put the '''Ramp''' Folder (can be found under Models/Airports in the GitHub) in $FG-ROOT\Models\Airport
# Put the '''ramp-marshall-dlg.xml''' (can be found under gui/dialogs in the GitHub) into $FG-ROOT\gui\dialogs
# Put every File which is not under any folder in the GitHub in your addons folder (see: [[Addon|how to install addons in FlightGear]])
# Now put the [https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://gitorious.org/fg/omega95s-fgdata.git&path=Nasal '''ramp_marhsall.nas'''] and the '''addon-main.nas''' (which can be found under the GitHub) in $FG-ROOT\Nasal

== Using the ramp marshaller ==
To use the ramp marshaller with a compatible aircraft at a compatible airport (scroll down to see how you can make aircraft and/or airports compatible), simply taxi to the gate/ramp you want to park at and click on the marshaller waiting at the ramp. His hands should move from rest position (both wands down by his sides) to direct you to the ramp. It's recommended to taxi to the ramp on the taxiway lines as long as you can see them and once they go out of view, follow the marshaller's instructions. Make sure that you're not taxiing faster than 5 to 10 kts at the ramp.

Currently, the ramp marshaller knows the following signals -
* Move forward
* Turn left
* Turn right
* Slow down and stop
* Immediate stop

But we're teaching him new signals. If you want to teach him a signal, scroll down to find out how. To find out what the signals look like, take a look at the videos above.

== Adding ramp marshalling support ==
=== Adding ramp marshalling compatibility to aircraft ===
[[File:A330-200 Ramp Marshall Compatibility - getting position with ac3D.png|thumb|270px|Demonstrating how to get x-position of nose gear with AC3D for ramp marshalling compatibility.]]

It's actually very simple to add ramp marshalling compatibility to an aircraft, the only file required to be edited is the aircraft's [[Aircraft-set.xml|<tt>-set.xml</tt> file]] (or common xml file for aircraft groups). The user is still required to use some kind of 3D modeling program to get the position.

# Open the aircraft's model file (containing the gears) with a 3D modeling program and get the '''x''' position of the center of the nose gear. (Or the position you want to rest at the ramp)
# Add the following code within the <code><sim> ... <model> ... </model></sim></code> tags in the aircraft's <tt>-set.xml</tt> file. (or common xml file for aircraft groups)
<syntaxhighlight lang="xml">
<ramp>
<x-m type="float">-15.9664</x-m>
<class type="string">2</class>
</ramp>
</syntaxhighlight>
:The '''x''' position from the 3D model is in the <code><x-m></code> tag and the aircraft class is in the <code><class></code> tag. With the current models, the aircraft classes are as follows -
:* 0 - 747s, 777-300s, A340s, A380s
:* 1 - 777-300s, A330-300s, 787s
:* 2 - A330-200s, 757s, 767s
:* 3 - A320s (includes A318s, A319s and A321s), 737s and other aircraft in general. This works for CRJs, E-jets etc.

This should be all! The ramp marshaller should be able to ''recognize'' the aircraft and guide it to the right position at the ramp!

=== Adding ramp marshallers to an airport ===

'''NOTE -''' In the future, this will change because ramp marshall positions are going to be connected to an airport's '''groundnet.xml''' file.

[[File:ramp-marshall-arpt-1.png|thumb|270px|Placing ramp marshaller using ufo]]
[[File:ramp-marshall-arpt-2.png|thumb|270px|Converting STG file to ramps XML]]

# Start up FlightGear with the UFO at the airport you want to place ramp marshallers.
# Hit the {{key press|L}} key on the keyboard to bring up the model selection dialog and select <tt>[[$FG_ROOT]]/Models/Airport/Ramp/ramp.xml</tt>. Using the ufo's scenery editing tools, place (and adjust) ramp marshallers everywhere you want. To make it simpler, click on the exact position you want the airplane to come to a stop. This will usually be at the end of a parking ramp's taxiway lines. Then, you will only have to change the heading.
# Once you've finished placing all the models, hit the {{key press|D}} key to dump the stg lines onto the console. (Do not close FlightGear yet) Copy the stg lines into a blank file. (name does not matter) And save it somewhere on your PC ($FG-HOME is a good place for that).
# Open up the Nasal console and execute the following function.
#: <syntaxhighlight lang="javascript">ramp_marshall.convert_stg();</syntaxhighlight>
# Choose the stg file you pasted the dumped stg lines in to convert the file into a readable xml ramp position file. If you get following error: <code>(unauthorized directory - authorization no longer follows symlinks; to authorize reading additional directories, pass them to --allow-nasal-read)</code>, type in Command line in the Launcher following phrase: <code>--allow-nasal-read=/path/to/directory</code>. The converted file can be found <tt>[[$FG_HOME]]/Export</tt> or under the Roaming folder in Windows.
# Copy the exported file (it will be called '''ramps-export.xml''') to <tt>[[$FG_ROOT]]/AI/Airports/<icao>/ramps.xml</tt>. For example, if you want these ramps at Singapore Changi Intl. Airport (WSSS), you'd put it in <tt>[[$FG_ROOT]]/AI/Airports/WSSS/ramps.xml</tt>. (you have to rename the '''ramps-export.xml''' into '''ramps.xml'''). If there is no folder for your Airport, just create a new one with the icao of your Airport.

== Contributing to the module ==

=== Teach the ramp marshaller new signals ===

The marshaller's signal positions are stored in the '''ramp_marhsall.nas''' Nasal file in a hash. This is so that the signals can be accessed easily by other functions.

<syntaxhighlight lang="javascript">
var pos = {
rest: rmPos.new(lA_x:80, rA_x:-80),
stop: rmPos.new(lA_x:-55, lAO_x:-70, rA_x:55, rAO_x:70),
fwd_out: rmPos.new(lA_z:-50, lAO_x:-30, rA_z:50, rAO_x:30),
fwd_in: rmPos.new(lA_z:-50, lAO_x:-120, rA_z:50, rAO_x:120),
left_in: rmPos.new(lAO_x:-120),
left_out: rmPos.new(lAO_x:-30),
right_in: rmPos.new(rAO_x:120),
right_out: rmPos.new(rAO_x:30)
};
</syntaxhighlight>

* lA_x - Left Arm (shoulder joint) x axis rotation
* lA_y - Left Arm (shoulder joint) y axis rotation
* lA_z - Left Arm (shoulder joint) z axis rotation
* lAO_x - Left Arm Outer (elbow joint) x axis rotation
* lH_x - Left Hand x axis rotation
* lH_y - Left Hand y axis rotation
* lH_z - Left Hand x axis rotation
* rA_x - Right Arm (shoulder joint) x axis rotation
* rA_y - Right Arm (shoulder joint) y axis rotation
* rA_z - Right Arm (shoulder joint) z axis rotation
* rAO_x - Right Arm Outer (elbow joint) x axis rotation
* rH_x - Right Hand x axis rotation
* rH_y - Right Hand y axis rotation
* rH_z - Right Hand x axis rotation

You can mess with the positions in a 3D modeling program or in FlightGear itself. Just look in the property tree under <tt>/airports/{icao}/ramps/ramp[n]</tt> (find the correct 'n' index for the person last clicked on by looking at the <tt>/airports/active-ramp</tt> property) and set the ramp marshaller's function to something random (so it isn't recognized) and change the values in the tree. Note: to get this to work properly, you first have to click on the nearest ramp marshaller, look up his index, and then click on a different marshaller so that the other marshaller's properties are not updated.

If you would like to add a new hand position (say both hands out stright), then you'd add this to the bottom of the '''pos''' hash.

<syntaxhighlight lang="javascript">
hands_out_front: rmPos.new(lA_z:-90, rA_z:90)
</syntaxhighlight>

Note that one only needs to specify the rotations that are non-zero using hash syntax (key:value) in the arguments to the rmPos.new function. Remember to put a comma after the line right before the new one you add, since each line needs to end with a comma.

Now, you can call this position as '''pos.hands_out_front''' to be used in the sequence function. Or if you'd like to get or set one of the position values.

To add the signal sequence, add a new '''if''' state at the end of the last '''if(me.function == "<function_name>"''' statement with the sequence. You can use me.phase to control the sequence phase/step.

Then, add the signal sequence.

HINT - To animate the marshaller to a position you specified and then to go to the next step when it's complete and be achieved like this:

<syntaxhighlight lang="javascript">
if(me.phase == 0) {
if(!check_pos(ramp_tree, pos.hands_out_front)) {
full_animate(ramp_tree, pos.hands_out_front, 100);
} else {
me.phase = 1;
}
}
</syntaxhighlight>

The above code checks if the marshallers is not in the '''hands_out_front''' pos already and if he isn't, he'll move his hands to that position. In the full_animate function, you can specify the speed his hands should move at in ''degrees per second''. In this case, he'll move his hands forward to the specified position at 100 degrees per second.

==== Useful internal functions ====

* '''rmPos.new(lA_x, lA_z, lAO_x, rA_x, rA_z, rAO_x)''' creates and returns a new instance of the rmPos hash. This hash is in the '''pos.<pos_name>''' format and can be used in the functions below.

* '''getDeviation(heading, target)''' returns the deviation to a target heading from your current heading. This is used by the marshaller to help guide you to the ramp.

* '''animate(property, target, rate)''' animates a property (slowly changes the property value) to a target value at the given rate. (Rate is in degrees per second)

* '''get_pos_values(ramp_tree)''' returns the current position of the marshaller's arms in a hash similar to that of the pos.<pos_name> hash.

* '''check_pos(ramp_tree, target) returns true if the marshaller is at a given position. '''target''' must be a hash similar to the '''pos.<pos_name>''' hash. It is best to simply send a position specified in the '''pos''' hash.

* '''full_animate(ramp_tree, pos_hash, rate) animates the ramp marshaller to the given position at the given rate.

* '''load_ramps(icao)''' loads all ramps (and marshallers) at the given airport.

'''NOTE -''' If any of the functions has '''ramp_tree''' as an argument and the function is being used within the ''main_loop'', the variable '''ramp_tree''' must be passed as an argument.

=== Using different models or textures ===

Soon, new features will becoming available which lets the ramp marshaller model be specified in the position config file.

{{WIP}}

== Further development ==

=== Visual Docking Guidance System ===

{{WIP}}

== Related content ==
=== Wiki articles ===
* [[Walk view]]

=== Forum topics ===
* {{forum link|t=20572|title=Nasal based Independant Ramp Marshall}} (August 2013-Mars 2018)

=== Source code ===
* [https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://gitorious.org/fg/omega95s-fgdata.git Omega95's fgdata Gitorious archive] archived from the {{gitorious source|proj=fg|repo=omega95s-fgdata|text=original}} Mars 30, 2016.
* [https://archive.softwareheritage.org/browse/origin/?origin_url=https%3A%2F%2Fgitorious.org%2Ffg-singapore-scenery%2Ffg-singapore-devel.git FG Singapore Scenery Gitorious archive] archived from the {{gitorious source|proj=fg-singapore-scenery|repo=fg-singapore-devel|text=original}} Mars 30, 2016.

[[Category:Scenery enhancement]]
[[Category:Aircraft enhancement]]