MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2023-05-05 08:58:01 +00:00
parent 80b11134db
commit 3ea3924af0
26 changed files with 996 additions and 715 deletions

View File

@@ -2450,6 +2450,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).IsDay">COORDINATE:IsDay(Clock)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if it is day, i.e.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(COORDINATE).IsInFlatArea">COORDINATE:IsInFlatArea(Radius, Minelevation)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Function to check if a coordinate is in a flat (&lt;8% elevation) area of the map</p>
</td>
</tr>
<tr class="w3-border">
@@ -2462,6 +2468,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).IsInSphere">COORDINATE:IsInSphere(ToCoordinate, Radius, Coordinate)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns if a Coordinate is in a certain radius of this Coordinate in 3D space using the X, Y and Z axis.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(COORDINATE).IsInSteepArea">COORDINATE:IsInSteepArea(Radius, Minelevation)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Function to check if a coordinate is in a steep (>8% elevation) area of the map</p>
</td>
</tr>
<tr class="w3-border">
@@ -4224,6 +4236,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).IsDay">POINT_VEC2:IsDay(Clock)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if it is day, i.e.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(POINT_VEC2).IsInFlatArea">POINT_VEC2:IsInFlatArea(Radius, Minelevation)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Function to check if a coordinate is in a flat (&lt;8% elevation) area of the map</p>
</td>
</tr>
<tr class="w3-border">
@@ -4236,6 +4254,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).IsInSphere">POINT_VEC2:IsInSphere(ToCoordinate, Radius, Coordinate)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns if a Coordinate is in a certain radius of this Coordinate in 3D space using the X, Y and Z axis.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(POINT_VEC2).IsInSteepArea">POINT_VEC2:IsInSteepArea(Radius, Minelevation)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Function to check if a coordinate is in a steep (>8% elevation) area of the map</p>
</td>
</tr>
<tr class="w3-border">
@@ -9588,6 +9612,71 @@ 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).IsInFlatArea" ><strong>COORDINATE:IsInFlatArea(Radius, Minelevation)</strong></a></h2>
</div>
<p>Function to check if a coordinate is in a flat (&lt;8% elevation) area of the map</p>
<div id= "#Functions##IsInFlatArea" 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>
#number
<strong><strong>Radius</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Radius to check around the coordinate, defaults to 50m (100m diameter)</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Minelevation</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Elevation from which on a area is defined as steep, defaults to 8% (8m height gain across 100 meters)</p>
</div>
</div>
<h2><strong>Return values:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(boolen)">#boolen</a>:</p>
</div>
<div class="w3-half">
<p>IsFlat If true, area is flat</p>
</div>
<div class="w3-half">
<p>#number:</p>
</div>
<div class="w3-half">
<p>MaxElevation Elevation in meters measured over 100m</p>
</div>
</div>
</div>
</div>
</div>
@@ -9715,6 +9804,71 @@ 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).IsInSteepArea" ><strong>COORDINATE:IsInSteepArea(Radius, Minelevation)</strong></a></h2>
</div>
<p>Function to check if a coordinate is in a steep (>8% elevation) area of the map</p>
<div id= "#Functions##IsInSteepArea" 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>
#number
<strong><strong>Radius</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Radius to check around the coordinate, defaults to 50m (100m diameter)</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Minelevation</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Elevation from which on a area is defined as steep, defaults to 8% (8m height gain across 100 meters)</p>
</div>
</div>
<h2><strong>Return values:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(boolen)">#boolen</a>:</p>
</div>
<div class="w3-half">
<p>IsSteep If true, area is steep</p>
</div>
<div class="w3-half">
<p>#number:</p>
</div>
<div class="w3-half">
<p>MaxElevation Elevation in meters measured over 100m</p>
</div>
</div>
</div>
</div>
</div>
@@ -17880,6 +18034,17 @@ When moose is loading dynamically (for moose class development), tracing is swit
<p>the y coordinate in meters.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(POINT_VEC2).z" ><strong>POINT_VEC2.z</strong></a>
</div>
</div>
@@ -18678,6 +18843,17 @@ When moose is loading dynamically (for moose class development), tracing is swit
<p>the y coordinate in meters.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(POINT_VEC2).z" ><strong>POINT_VEC2.z</strong></a>
</div>
</div>
@@ -22704,6 +22880,71 @@ 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).IsInFlatArea" ><strong>POINT_VEC2:IsInFlatArea(Radius, Minelevation)</strong></a></h2>
</div>
<p>Function to check if a coordinate is in a flat (&lt;8% elevation) area of the map</p>
<div id= "#Functions##IsInFlatArea" 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>
#number
<strong><strong>Radius</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Radius to check around the coordinate, defaults to 50m (100m diameter)</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Minelevation</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Elevation from which on a area is defined as steep, defaults to 8% (8m height gain across 100 meters)</p>
</div>
</div>
<h2><strong>Return values:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(boolen)">#boolen</a>:</p>
</div>
<div class="w3-half">
<p>IsFlat If true, area is flat</p>
</div>
<div class="w3-half">
<p>#number:</p>
</div>
<div class="w3-half">
<p>MaxElevation Elevation in meters measured over 100m</p>
</div>
</div>
</div>
</div>
</div>
@@ -22831,6 +23072,71 @@ 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).IsInSteepArea" ><strong>POINT_VEC2:IsInSteepArea(Radius, Minelevation)</strong></a></h2>
</div>
<p>Function to check if a coordinate is in a steep (>8% elevation) area of the map</p>
<div id= "#Functions##IsInSteepArea" 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>
#number
<strong><strong>Radius</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Radius to check around the coordinate, defaults to 50m (100m diameter)</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Minelevation</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Elevation from which on a area is defined as steep, defaults to 8% (8m height gain across 100 meters)</p>
</div>
</div>
<h2><strong>Return values:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(boolen)">#boolen</a>:</p>
</div>
<div class="w3-half">
<p>IsSteep If true, area is steep</p>
</div>
<div class="w3-half">
<p>#number:</p>
</div>
<div class="w3-half">
<p>MaxElevation Elevation in meters measured over 100m</p>
</div>
</div>
</div>
</div>
</div>
@@ -27284,6 +27590,17 @@ Creates a line on the F10 map from one point to another.</p>
<p>the y coordinate in meters.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(POINT_VEC2).z" ><strong>POINT_VEC2.z</strong></a>
</div>
</div>