MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2021-04-21 07:59:54 +00:00
parent 02cddf5ae3
commit 8879373892
25 changed files with 2100 additions and 420 deletions
+602
View File
@@ -1835,6 +1835,12 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(COORDINATE).BigSmokeSmall">COORDINATE:BigSmokeSmall(density)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Small smoke at the coordinate.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(COORDINATE).CircleToAll">COORDINATE:CircleToAll(Center, Radius, Coalition, LineType, Color, Alpha, FillColor, FillAlpha, ReadOnly, Text)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Circle to all.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2243,6 +2249,12 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(COORDINATE).IsSurfaceTypeWater">COORDINATE:IsSurfaceTypeWater()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Checks if the surface type is water.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(COORDINATE).LineToAll">COORDINATE:LineToAll(Endpoint, Coalition, LineType, Color, Alpha, ReadOnly, Text)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Line to all.</p>
</td>
</tr>
<tr class="w3-border">
@@ -3328,6 +3340,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(POINT_VEC2).BigSmokeSmall">POINT_VEC2:BigSmokeSmall(density)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Small smoke at the coordinate.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(POINT_VEC2).CircleToAll">POINT_VEC2:CircleToAll(Center, Radius, Coalition, LineType, Color, Alpha, FillColor, FillAlpha, ReadOnly, Text)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Circle to all.</p>
</td>
</tr>
<tr class="w3-border">
@@ -3736,6 +3754,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(POINT_VEC2).IsSurfaceTypeWater">POINT_VEC2:IsSurfaceTypeWater()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Checks if the surface type is water.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(POINT_VEC2).LineToAll">POINT_VEC2:LineToAll(Endpoint, Coalition, LineType, Color, Alpha, ReadOnly, Text)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Line to all.</p>
</td>
</tr>
<tr class="w3-border">
@@ -5218,6 +5242,170 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(COORDINATE).CircleToAll" ><strong>COORDINATE:CircleToAll(Center, Radius, Coalition, LineType, Color, Alpha, FillColor, FillAlpha, ReadOnly, Text)</strong></a></h2>
</div>
<p>Circle to all.</p>
<p>Creates a circle on the map with a given radius, color, fill color, and outline.</p>
<div id= "#Functions##CircleToAll" 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>COORDINATE</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="##(COORDINATE)">#COORDINATE</a>
<strong><strong>Center</strong></strong>
</p>
</div>
<div class="w3-half">
<p>COORDIANTE of the center of the circle.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="##(numberr)">#numberr</a>
<strong><strong>Radius</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Radius in meters. Default 1000 m.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Coalition</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Coalition: All=-1, Neutral=0, Red=1, Blue=2. Default -1=All.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>LineType</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Line type: 0=No line, 1=Solid, 2=Dashed, 3=Dotted, 4=Dot dash, 5=Long dash, 6=Two dash. Default 1=Solid.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>Color</strong></strong>
</p>
</div>
<div class="w3-half">
<p>RGB color table {r, g, b}, e.g. {1,0,0} for red (default).</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Alpha</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Transparency [0,1]. Default 1.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>FillColor</strong></strong>
</p>
</div>
<div class="w3-half">
<p>RGB color table {r, g, b}, e.g. {1,0,0} for red (default).</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>FillAlpha</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Transparency [0,1]. Default 0.5.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>ReadOnly</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Mark is readonly and cannot be removed by users. Default false.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Text</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Text displayed when mark is added. Default none.</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>The resulting Mark ID which is a number.</p>
</div>
</div>
</div>
</div>
</div>
@@ -8567,6 +8755,131 @@ By default, the last point is the closest point on road of the ToCoord. Hence, t
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(COORDINATE).LineToAll" ><strong>COORDINATE:LineToAll(Endpoint, Coalition, LineType, Color, Alpha, ReadOnly, Text)</strong></a></h2>
</div>
<p>Line to all.</p>
<p>Creates a line on the F10 map from one point to another.</p>
<div id= "#Functions##LineToAll" 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>COORDINATE</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="##(COORDINATE)">#COORDINATE</a>
<strong><strong>Endpoint</strong></strong>
</p>
</div>
<div class="w3-half">
<p>COORDIANTE to where the line is drawn.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Coalition</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Coalition: All=-1, Neutral=0, Red=1, Blue=2. Default -1=All.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>LineType</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Line type: 0=No line, 1=Solid, 2=Dashed, 3=Dotted, 4=Dot dash, 5=Long dash, 6=Two dash. Default 1=Solid.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>Color</strong></strong>
</p>
</div>
<div class="w3-half">
<p>RGB color table {r, g, b}, e.g. {1,0,0} for red (default).</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Alpha</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Transparency [0,1]. Default 1.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>ReadOnly</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Mark is readonly and cannot be removed by users. Default false.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Text</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Text displayed when mark is added. Default none.</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>The resulting Mark ID which is a number.</p>
</div>
</div>
</div>
</div>
</div>
@@ -16019,6 +16332,170 @@ BASE:TraceOnOff( false )</code></pre>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(POINT_VEC2).CircleToAll" ><strong>POINT_VEC2:CircleToAll(Center, Radius, Coalition, LineType, Color, Alpha, FillColor, FillAlpha, ReadOnly, Text)</strong></a></h2>
</div>
<p>Circle to all.</p>
<p>Creates a circle on the map with a given radius, color, fill color, and outline.</p>
<div id= "#Functions##CircleToAll" 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><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a></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="##(COORDINATE)">#COORDINATE</a>
<strong><strong>Center</strong></strong>
</p>
</div>
<div class="w3-half">
<p>COORDIANTE of the center of the circle.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="##(numberr)">#numberr</a>
<strong><strong>Radius</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Radius in meters. Default 1000 m.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Coalition</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Coalition: All=-1, Neutral=0, Red=1, Blue=2. Default -1=All.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>LineType</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Line type: 0=No line, 1=Solid, 2=Dashed, 3=Dotted, 4=Dot dash, 5=Long dash, 6=Two dash. Default 1=Solid.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>Color</strong></strong>
</p>
</div>
<div class="w3-half">
<p>RGB color table {r, g, b}, e.g. {1,0,0} for red (default).</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Alpha</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Transparency [0,1]. Default 1.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>FillColor</strong></strong>
</p>
</div>
<div class="w3-half">
<p>RGB color table {r, g, b}, e.g. {1,0,0} for red (default).</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>FillAlpha</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Transparency [0,1]. Default 0.5.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>ReadOnly</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Mark is readonly and cannot be removed by users. Default false.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Text</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Text displayed when mark is added. Default none.</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>The resulting Mark ID which is a number.</p>
</div>
</div>
</div>
</div>
</div>
@@ -19368,6 +19845,131 @@ By default, the last point is the closest point on road of the ToCoord. Hence, t
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(POINT_VEC2).LineToAll" ><strong>POINT_VEC2:LineToAll(Endpoint, Coalition, LineType, Color, Alpha, ReadOnly, Text)</strong></a></h2>
</div>
<p>Line to all.</p>
<p>Creates a line on the F10 map from one point to another.</p>
<div id= "#Functions##LineToAll" 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><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a></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="##(COORDINATE)">#COORDINATE</a>
<strong><strong>Endpoint</strong></strong>
</p>
</div>
<div class="w3-half">
<p>COORDIANTE to where the line is drawn.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Coalition</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Coalition: All=-1, Neutral=0, Red=1, Blue=2. Default -1=All.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>LineType</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Line type: 0=No line, 1=Solid, 2=Dashed, 3=Dotted, 4=Dot dash, 5=Long dash, 6=Two dash. Default 1=Solid.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>Color</strong></strong>
</p>
</div>
<div class="w3-half">
<p>RGB color table {r, g, b}, e.g. {1,0,0} for red (default).</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Alpha</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Transparency [0,1]. Default 1.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>ReadOnly</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Mark is readonly and cannot be removed by users. Default false.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Text</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Text displayed when mark is added. Default none.</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>The resulting Mark ID which is a number.</p>
</div>
</div>
</div>
</div>
</div>