weyne/MOOSE_DOCS
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE_DOCS.git synced 2025-08-15 10:37:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

MOOSE generated documentation [skip ci]

Browse Source
This commit is contained in:
Applevangelist
2021-10-01 13:06:27 +00:00
parent 077ccb6192
commit d74e874e4d
23 changed files with 749 additions and 563 deletions
Download Patch File Download Diff File Expand all files Collapse all files

298
Documentation/Utils.html
View File

@@ -1504,7 +1504,7 @@ Controls a network of short range air/missile defense groups.</p>
<h3>Contributions:</h3>
<ul>
<li>FlightControl : Rework to OO framework </li>
<li>FlightControl : Rework to OO framework.</li>
</ul>
@@ -2138,6 +2138,24 @@ Controls a network of short range air/missile defense groups.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).IsLoadingDoorOpen">UTILS.IsLoadingDoorOpen(unit_name)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p> (Helicopter) Check if one loading door is open.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).KiloMetersToFeet">UTILS.KiloMetersToFeet(kilometers)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).KiloMetersToNM">UTILS.KiloMetersToNM(kilometers)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).KiloMetersToSM">UTILS.KiloMetersToSM(kilometers)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -2210,6 +2228,12 @@ Controls a network of short range air/missile defense groups.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).MpsToMiph">UTILS.MpsToMiph(mps)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Convert meters per second to miles per hour.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).NMToKiloMeters">UTILS.NMToKiloMeters(NM)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -2245,7 +2269,7 @@ Controls a network of short range air/missile defense groups.</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).ReplaceIllegalCharacters">UTILS.ReplaceIllegalCharacters(Text, ReplaceBy)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Replace illegal characters [&lt;>|/?*:\] in a string. </p>
<p>Replace illegal characters [&lt;>|/?*:\] in a string.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2312,19 +2336,31 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).VecAdd">UTILS.VecAdd(a, b)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Calculate the total vector of two 3D vectors by adding the x,y,z components of each other. </p>
<p>Calculate the total vector of two 3D vectors by adding the x,y,z components of each other.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).VecAngle">UTILS.VecAngle(a, b)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Calculate the angle between two 3D vectors. </p>
<p>Calculate the angle between two 3D vectors.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).VecCross">UTILS.VecCross(a, b)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Calculate the <a href="https://en.wikipedia.org/wiki/Cross_product">cross product</a> of two 3D vectors.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).VecDist2D">UTILS.VecDist2D(a, b)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Calculate the distance between two 2D vectors.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).VecDist3D">UTILS.VecDist3D(a, b)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Calculate the distance between two 3D vectors.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2348,7 +2384,7 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).VecSubstract">UTILS.VecSubstract(a, b)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Calculate the difference between two 3D vectors by substracting the x,y,z components from each other. </p>
<p>Calculate the difference between two 3D vectors by substracting the x,y,z components from each other.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2903,7 +2939,7 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
</div>
<div class="w3-half">
<p>If true, print to DCS log file. </p>
<p>If true, print to DCS log file.</p>
</div>
</div>
@@ -2914,7 +2950,7 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
</div>
<div class="w3-half">
<p>Memory usage in kByte. </p>
<p>Memory usage in kByte.</p>
</div>
</div>
@@ -4519,6 +4555,96 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(UTILS).KiloMetersToFeet" ><strong>UTILS.KiloMetersToFeet(kilometers)</strong></a></h2>
</div>
<div id= "#Functions##KiloMetersToFeet" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>UTILS</p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>kilometers</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(UTILS).KiloMetersToNM" ><strong>UTILS.KiloMetersToNM(kilometers)</strong></a></h2>
</div>
<div id= "#Functions##KiloMetersToNM" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>UTILS</p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>kilometers</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(UTILS).KiloMetersToSM" ><strong>UTILS.KiloMetersToSM(kilometers)</strong></a></h2>
</div>
<div id= "#Functions##KiloMetersToSM" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>UTILS</p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>kilometers</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
</div>
@@ -4951,6 +5077,36 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(UTILS).NMToKiloMeters" ><strong>UTILS.NMToKiloMeters(NM)</strong></a></h2>
</div>
<div id= "#Functions##NMToKiloMeters" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>UTILS</p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>NM</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
</div>
@@ -5254,7 +5410,7 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
<h2><a id="#(UTILS).ReplaceIllegalCharacters" ><strong>UTILS.ReplaceIllegalCharacters(Text, ReplaceBy)</strong></a></h2>
</div>
<p>Replace illegal characters [&lt;>|/?*:\] in a string. </p>
<p>Replace illegal characters [&lt;>|/?*:\] in a string.</p>
<div id= "#Functions##ReplaceIllegalCharacters" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -5314,7 +5470,7 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
<p>Rotate 3D vector in the 2D (x,z) plane.</p>
<p>y-component (usually altitude) unchanged. </p>
<p>y-component (usually altitude) unchanged.</p>
<div id= "#Functions##Rotate2D" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -5760,7 +5916,7 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
<h2><a id="#(UTILS).VecAdd" ><strong>UTILS.VecAdd(a, b)</strong></a></h2>
</div>
<p>Calculate the total vector of two 3D vectors by adding the x,y,z components of each other. </p>
<p>Calculate the total vector of two 3D vectors by adding the x,y,z components of each other.</p>
<div id= "#Functions##VecAdd" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -5817,7 +5973,7 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
<h2><a id="#(UTILS).VecAngle" ><strong>UTILS.VecAngle(a, b)</strong></a></h2>
</div>
<p>Calculate the angle between two 3D vectors. </p>
<p>Calculate the angle between two 3D vectors.</p>
<div id= "#Functions##VecAngle" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -5859,7 +6015,7 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
</div>
<div class="w3-half">
<p>Angle alpha between and b in degrees. alpha=acos(a<em>b)/(|a||b|), (</em> denotes the dot product). </p>
<p>Angle alpha between and b in degrees. alpha=acos(a<em>b)/(|a||b|), (</em> denotes the dot product).</p>
</div>
</div>
@@ -5925,6 +6081,120 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(UTILS).VecDist2D" ><strong>UTILS.VecDist2D(a, b)</strong></a></h2>
</div>
<p>Calculate the distance between two 2D vectors.</p>
<div id= "#Functions##VecDist2D" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>UTILS</p>
</div>
<h2><strong>Parameters:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="DCS.html##(Vec2)">DCS#Vec2</a>
<strong><strong>a</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Vector in 3D with x, y components.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="DCS.html##(Vec2)">DCS#Vec2</a>
<strong><strong>b</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Vector in 3D with x, y components.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#number:</p>
</div>
<div class="w3-half">
<p>Distance between the vectors.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(UTILS).VecDist3D" ><strong>UTILS.VecDist3D(a, b)</strong></a></h2>
</div>
<p>Calculate the distance between two 3D vectors.</p>
<div id= "#Functions##VecDist3D" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>UTILS</p>
</div>
<h2><strong>Parameters:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="DCS.html##(Vec3)">DCS#Vec3</a>
<strong><strong>a</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Vector in 3D with x, y, z components.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="DCS.html##(Vec3)">DCS#Vec3</a>
<strong><strong>b</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Vector in 3D with x, y, z components.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#number:</p>
</div>
<div class="w3-half">
<p>Distance between the vectors.</p>
</div>
</div>
</div>
</div>
</div>
@@ -6082,7 +6352,7 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
<h2><a id="#(UTILS).VecSubstract" ><strong>UTILS.VecSubstract(a, b)</strong></a></h2>
</div>
<p>Calculate the difference between two 3D vectors by substracting the x,y,z components from each other. </p>
<p>Calculate the difference between two 3D vectors by substracting the x,y,z components from each other.</p>
<div id= "#Functions##VecSubstract" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -6142,7 +6412,7 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
<p>Translate 3D vector in the 2D (x,z) plane.</p>
<p>y-component (usually altitude) unchanged. </p>
<p>y-component (usually altitude) unchanged.</p>
<div id= "#Functions##VecTranslate" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">