MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2023-01-03 09:27:39 +00:00
parent bdaa4f1ba7
commit 8a201a505b
31 changed files with 9721 additions and 1196 deletions

View File

@@ -3601,6 +3601,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="##(ZONE_POLYGON_BASE).GetBoundingSquare">ZONE_POLYGON_BASE:GetBoundingSquare()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the bounding square the zone.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_POLYGON_BASE).GetBoundingVec2">ZONE_POLYGON_BASE:GetBoundingVec2()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the bounding 2D vectors of the polygon.</p>
</td>
</tr>
<tr class="w3-border">
@@ -3667,6 +3673,18 @@ 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="##(ZONE_POLYGON_BASE).GetVerticiesVec3">ZONE_POLYGON_BASE:GetVerticiesVec3()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get a list of verticies of the polygon.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_POLYGON_BASE).GetZoneQuad">ZONE_POLYGON_BASE:GetZoneQuad(ZoneName, DoNotRegisterZone)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the smallest rectangular zone encompassing all points points of the polygon zone. </p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_POLYGON_BASE).GetZoneRadius">ZONE_POLYGON_BASE:GetZoneRadius(ZoneName, DoNotRegisterZone)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the smallest circular zone encompassing all points points of the polygon zone. </p>
</td>
</tr>
<tr class="w3-border">
@@ -13349,6 +13367,44 @@ Note that <strong>only after</strong> a zone has been scanned, the zone can be e
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(ZONE_POLYGON_BASE).GetBoundingVec2" ><strong>ZONE_POLYGON_BASE:GetBoundingVec2()</strong></a></h2>
</div>
<p>Get the bounding 2D vectors of the polygon.</p>
<div id= "#Functions##GetBoundingVec2" 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>ZONE_POLYGON_BASE</p>
</div>
<h2><strong>Return values:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="DCS.html##(Vec2)">DCS#Vec2</a>:</p>
</div>
<div class="w3-half">
<p>Coordinates of western-southern-lower vertex of the box.</p>
</div>
<div class="w3-half">
<p><a href="DCS.html##(Vec2)">DCS#Vec2</a>:</p>
</div>
<div class="w3-half">
<p>Coordinates of eastern-northern-upper vertex of the box.</p>
</div>
</div>
</div>
</div>
</div>
@@ -13718,6 +13774,120 @@ Note that <strong>only after</strong> a zone has been scanned, the zone can be e
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(ZONE_POLYGON_BASE).GetZoneQuad" ><strong>ZONE_POLYGON_BASE:GetZoneQuad(ZoneName, DoNotRegisterZone)</strong></a></h2>
</div>
<p>Get the smallest rectangular zone encompassing all points points of the polygon zone. </p>
<div id= "#Functions##GetZoneQuad" 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>ZONE_POLYGON_BASE</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>
#string
<strong><strong>ZoneName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Name of the zone. Default is the name of the polygon zone.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DoNotRegisterZone</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <code>true</code>, zone is not registered.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(ZONE_POLYGON)">#ZONE_POLYGON</a>:</p>
</div>
<div class="w3-half">
<p>The rectangular zone.</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="#(ZONE_POLYGON_BASE).GetZoneRadius" ><strong>ZONE_POLYGON_BASE:GetZoneRadius(ZoneName, DoNotRegisterZone)</strong></a></h2>
</div>
<p>Get the smallest circular zone encompassing all points points of the polygon zone. </p>
<div id= "#Functions##GetZoneRadius" 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>ZONE_POLYGON_BASE</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>
#string
<strong><strong>ZoneName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Name of the zone. Default is the name of the polygon zone.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DoNotRegisterZone</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <code>true</code>, zone is not registered.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(ZONE_RADIUS)">#ZONE_RADIUS</a>:</p>
</div>
<div class="w3-half">
<p>The circular zone.</p>
</div>
</div>
</div>
</div>
</div>