FlightControl-Master/MOOSE
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE.git synced 2025-10-29 16:58:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updates in POSITIONABLE

Browse Source 
-- Added :GetBoundingBox()
-- Added :GetHeight()
-- Updated documentation
This commit is contained in:
FlightControl
2017-05-13 06:36:13 +02:00
parent bd75743800
commit 4359831423
14 changed files with 218 additions and 99 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/Documentation/AI_Patrol.html
View File

@@ -953,6 +953,9 @@ Use the method <a href="##(AI_PATROL_ZONE).ManageDamage">AI<em>PATROL</em>ZONE.M
<p> This table contains the targets detected during patrol.</p>
</dd>
</dl>
<dl class="function">

2
docs/Documentation/Cargo.html
View File

@@ -2921,6 +2921,7 @@ The range till cargo will board.</p>
<dl class="function">
<dt>
<em></em>
<a id="#(CARGO_UNIT).CargoCarrier" >
<strong>CARGO_UNIT.CargoCarrier</strong>
</a>
@@ -3046,7 +3047,6 @@ The range till cargo will board.</p>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(CARGO_UNIT).RunCount" >
<strong>CARGO_UNIT.RunCount</strong>
</a>

1
docs/Documentation/Designate.html
View File

@@ -892,7 +892,6 @@ function below will use the range 1-7 just in case</p>
<dl class="function">
<dt>
<em></em>
<a id="#(DESIGNATE).LaserCodes" >
<strong>DESIGNATE.LaserCodes</strong>
</a>

2
docs/Documentation/Detection.html
View File

@@ -2324,7 +2324,6 @@ The index of the DetectedItem.</p>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(DETECTION_BASE).DetectedItemCount" >
<strong>DETECTION_BASE.DetectedItemCount</strong>
</a>
@@ -2338,7 +2337,6 @@ The index of the DetectedItem.</p>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(DETECTION_BASE).DetectedItemMax" >
<strong>DETECTION_BASE.DetectedItemMax</strong>
</a>

3
docs/Documentation/Fsm.html
View File

@@ -1624,7 +1624,7 @@ A string defining the start state.</p>
<dl class="function">
<dt>
<em>#string</em>
<em></em>
<a id="#(FSM)._StartState" >
<strong>FSM._StartState</strong>
</a>
@@ -1923,6 +1923,7 @@ A string defining the start state.</p>
<dl class="function">
<dt>
<em></em>
<a id="#(FSM).current" >
<strong>FSM.current</strong>
</a>

4
docs/Documentation/Movement.html
View File

@@ -215,6 +215,7 @@ on defined intervals (currently every minute).</p>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(MOVEMENT).AliveUnits" >
<strong>MOVEMENT.AliveUnits</strong>
</a>
@@ -223,6 +224,9 @@ on defined intervals (currently every minute).</p>
<p> Contains the counter how many units are currently alive</p>
</dd>
</dl>
<dl class="function">

151
docs/Documentation/Positionable.html
View File

@@ -97,34 +97,10 @@
<div id="content">
<h1>Module <code>Positionable</code></h1>
<p>This module contains the POSITIONABLE class.</p>
<p><strong>Wrapper</strong> -- This module contains the POSITIONABLE class.</p>
<h1>1) <a href="Positionable.html##(POSITIONABLE)">Positionable#POSITIONABLE</a> class, extends <a href="Identifiable.html##(IDENTIFIABLE)">Identifiable#IDENTIFIABLE</a></h1>
<p>The <a href="Positionable.html##(POSITIONABLE)">Positionable#POSITIONABLE</a> class is a wrapper class to handle the POSITIONABLE objects:</p>
<ul>
<li>Support all DCS APIs.</li>
<li>Enhance with POSITIONABLE specific APIs not in the DCS API set.</li>
<li>Manage the "state" of the POSITIONABLE.</li>
</ul>
<h2>1.1) POSITIONABLE constructor:</h2>
<p>The POSITIONABLE class provides the following functions to construct a POSITIONABLE instance:</p>
<ul>
<li><a href="Positionable.html##(POSITIONABLE).New">Positionable#POSITIONABLE.New</a>(): Create a POSITIONABLE instance.</li>
</ul>
<h2>1.2) POSITIONABLE methods:</h2>
<p>The following methods can be used to identify an measurable object:</p>
<ul>
<li><a href="Positionable.html##(POSITIONABLE).GetID">Positionable#POSITIONABLE.GetID</a>(): Returns the ID of the measurable object.</li>
<li><a href="Positionable.html##(POSITIONABLE).GetName">Positionable#POSITIONABLE.GetName</a>(): Returns the name of the measurable object.</li>
</ul>
<hr/>
@@ -133,7 +109,13 @@
<tr>
<td class="name" nowrap="nowrap"><a href="#POSITIONABLE">POSITIONABLE</a></td>
<td class="summary">
<h1>POSITIONABLE class, extends <a href="Identifiable.html##(IDENTIFIABLE)">Identifiable#IDENTIFIABLE</a></h1>
<p>The POSITIONABLE class is a wrapper class to handle the POSITIONABLE objects:</p>
<ul>
<li>Support all DCS APIs.</li>
</ul>
</td>
</tr>
</table>
@@ -150,12 +132,6 @@
<h2><a id="#(POSITIONABLE)">Type <code>POSITIONABLE</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).ClassName">POSITIONABLE.ClassName</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetAltitude">POSITIONABLE:GetAltitude()</a></td>
<td class="summary">
<p>Returns the altitude of the POSITIONABLE.</p>
@@ -165,6 +141,12 @@
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetBeacon">POSITIONABLE:GetBeacon()</a></td>
<td class="summary">
<p>Create a <a href="Radio.html##(BEACON)">Radio#BEACON</a>, to allow this POSITIONABLE to broadcast beacon signals</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetBoundingBox">POSITIONABLE:GetBoundingBox()</a></td>
<td class="summary">
<p>Get the bounding box of the underlying POSITIONABLE DCS Object.</p>
</td>
</tr>
<tr>
@@ -177,6 +159,12 @@
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetHeading">POSITIONABLE:GetHeading()</a></td>
<td class="summary">
<p>Returns the POSITIONABLE heading in degrees.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetHeight">POSITIONABLE:GetHeight()</a></td>
<td class="summary">
<p>Returns the POSITIONABLE height in meters.</p>
</td>
</tr>
<tr>
@@ -372,6 +360,37 @@
</dt>
<dd>
<h1>POSITIONABLE class, extends <a href="Identifiable.html##(IDENTIFIABLE)">Identifiable#IDENTIFIABLE</a></h1>
<p>The POSITIONABLE class is a wrapper class to handle the POSITIONABLE objects:</p>
<ul>
<li>Support all DCS APIs.</li>
</ul>
<ul>
<li>Enhance with POSITIONABLE specific APIs not in the DCS API set.</li>
<li>Manage the "state" of the POSITIONABLE.</li>
</ul>
<h2>POSITIONABLE constructor</h2>
<p>The POSITIONABLE class provides the following functions to construct a POSITIONABLE instance:</p>
<ul>
<li><a href="Positionable.html##(POSITIONABLE).New">Positionable#POSITIONABLE.New</a>(): Create a POSITIONABLE instance.</li>
</ul>
<h2>POSITIONABLE methods</h2>
<p>The following methods can be used to identify an measurable object:</p>
<ul>
<li><a href="Positionable.html##(POSITIONABLE).GetID">Positionable#POSITIONABLE.GetID</a>(): Returns the ID of the measurable object.</li>
<li><a href="Positionable.html##(POSITIONABLE).GetName">Positionable#POSITIONABLE.GetName</a>(): Returns the name of the measurable object.</li>
</ul>
</dd>
@@ -405,20 +424,6 @@
<dl class="function">
<dt>
<em>#string</em>
<a id="#(POSITIONABLE).ClassName" >
<strong>POSITIONABLE.ClassName</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetAltitude" >
<strong>POSITIONABLE:GetAltitude()</strong>
</a>
@@ -465,6 +470,34 @@ Radio</p>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetBoundingBox" >
<strong>POSITIONABLE:GetBoundingBox()</strong>
</a>
</dt>
<dd>
<p>Get the bounding box of the underlying POSITIONABLE DCS Object.</p>
<h3>Return values</h3>
<ol>
<li>
<p><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a>:</em>
The bounding box of the POSITIONABLE.</p>
</li>
<li>
<p><em>#nil:</em>
The POSITIONABLE is not existing or alive. </p>
</li>
</ol>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetCoordinate" >
<strong>POSITIONABLE:GetCoordinate()</strong>
</a>
@@ -521,6 +554,34 @@ The POSITIONABLE is not existing or alive.</p>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetHeight" >
<strong>POSITIONABLE:GetHeight()</strong>
</a>
</dt>
<dd>
<p>Returns the POSITIONABLE height in meters.</p>
<h3>Return values</h3>
<ol>
<li>
<p><em><a href="Dcs.DCSTypes.html##(Vec3)">Dcs.DCSTypes#Vec3</a>:</em>
The height of the positionable.</p>
</li>
<li>
<p><em>#nil:</em>
The POSITIONABLE is not existing or alive. </p>
</li>
</ol>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetLaserCode" >
<strong>POSITIONABLE:GetLaserCode()</strong>
</a>

2
docs/Documentation/Spawn.html
View File

@@ -2944,7 +2944,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
<p> When the first Spawn executes, all the Groups need to be made visible before start.</p>
<p> Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.</p>
</dd>
</dl>

4
docs/Documentation/Spot.html
View File

@@ -763,7 +763,6 @@ true if it is lasing</p>
<dl class="function">
<dt>
<em></em>
<a id="#(SPOT).ScheduleID" >
<strong>SPOT.ScheduleID</strong>
</a>
@@ -777,7 +776,6 @@ true if it is lasing</p>
<dl class="function">
<dt>
<em></em>
<a id="#(SPOT).SpotIR" >
<strong>SPOT.SpotIR</strong>
</a>
@@ -791,7 +789,6 @@ true if it is lasing</p>
<dl class="function">
<dt>
<em></em>
<a id="#(SPOT).SpotLaser" >
<strong>SPOT.SpotLaser</strong>
</a>
@@ -805,7 +802,6 @@ true if it is lasing</p>
<dl class="function">
<dt>
<em></em>
<a id="#(SPOT).Target" >
<strong>SPOT.Target</strong>
</a>

3
docs/Documentation/Task_Cargo.html
View File

@@ -503,7 +503,7 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
<dl class="function">
<dt>
<em><a href="Core.Cargo.html##(CARGO_GROUP)">Core.Cargo#CARGO_GROUP</a></em>
<em></em>
<a id="#(FSM_PROCESS).Cargo" >
<strong>FSM_PROCESS.Cargo</strong>
</a>
@@ -517,7 +517,6 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
<dl class="function">
<dt>
<em></em>
<a id="#(FSM_PROCESS).DeployZone" >
<strong>FSM_PROCESS.DeployZone</strong>
</a>

8
docs/Documentation/Zone.html
View File

@@ -97,10 +97,6 @@
<div id="content">
<h1>Module <code>Zone</code></h1>
<p><strong>Core</strong> - ZONE classes define <strong>zones</strong> within your mission of <strong>various forms</strong>, with <strong>various capabilities</strong>.</p>
<p><img src="..\Presentations\ZONE\Dia1.JPG" alt="Banner Image"/></p>
<hr/>
@@ -109,6 +105,10 @@
<ul>
<li>Test if an object is within the zone boundaries.</li>
</ul>
<ul>
<li>Provide the zone behaviour. Some zones are static, while others are moveable.</li>
</ul>

12
docs/Documentation/index.html
View File

@@ -433,7 +433,7 @@ are design patterns allowing efficient (long-lasting) processes and workflows.</
<tr>
<td class="name" nowrap="nowrap"><a href="Positionable.html">Positionable</a></td>
<td class="summary">
<p>This module contains the POSITIONABLE class.</p>
<p><strong>Wrapper</strong> -- This module contains the POSITIONABLE class.</p>
</td>
</tr>
<tr>
@@ -586,7 +586,15 @@ which are excellent tools to be reused in an OO environment!.</p>
<tr>
<td class="name" nowrap="nowrap"><a href="Zone.html">Zone</a></td>
<td class="summary">
<p><strong>Core</strong> - ZONE classes define <strong>zones</strong> within your mission of <strong>various forms</strong>, with <strong>various capabilities</strong>.</p>
<p><img src="..\Presentations\ZONE\Dia1.JPG" alt="Banner Image"/></p>
<hr/>
<p>There are essentially two core functions that zones accomodate:</p>
<ul>
<li>Test if an object is within the zone boundaries.</li>
</ul>
</td>
</tr>
<tr>