mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-08-15 10:47:21 +00:00
Updates in POSITIONABLE
-- Added :GetBoundingBox() -- Added :GetHeight() -- Updated documentation
This commit is contained in:
FlightControl
@@ -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>
|
||||
|
||||
Reference in New Issue
Block a user