weyne/MOOSE
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE.git synced 2025-08-15 10:47:21 +00:00
Code Issues Packages Projects Releases Wiki Activity
MOOSE/docs/Documentation/Point.html
FlightControl 8edbb5ca23 Progress, a lot is working already.
2017-02-28 14:01:38 +01:00

2236 lines
49 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<link rel="stylesheet" href="stylesheet.css" type="text/css"/>
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div>
<div id="main">
<div id="navigation">
<h2>Modules</h2>
<ul><li>
<a href="index.html">index</a>
</li></ul>
<ul>
<li><a href="AI_Balancer.html">AI_Balancer</a></li>
<li><a href="AI_Cap.html">AI_Cap</a></li>
<li><a href="AI_Cas.html">AI_Cas</a></li>
<li><a href="AI_Patrol.html">AI_Patrol</a></li>
<li><a href="Account.html">Account</a></li>
<li><a href="Airbase.html">Airbase</a></li>
<li><a href="AirbasePolice.html">AirbasePolice</a></li>
<li><a href="Assign.html">Assign</a></li>
<li><a href="Base.html">Base</a></li>
<li><a href="Cargo.html">Cargo</a></li>
<li><a href="CleanUp.html">CleanUp</a></li>
<li><a href="Client.html">Client</a></li>
<li><a href="CommandCenter.html">CommandCenter</a></li>
<li><a href="Controllable.html">Controllable</a></li>
<li><a href="Database.html">Database</a></li>
<li><a href="Detection.html">Detection</a></li>
<li><a href="DetectionManager.html">DetectionManager</a></li>
<li><a href="Escort.html">Escort</a></li>
<li><a href="Event.html">Event</a></li>
<li><a href="Fsm.html">Fsm</a></li>
<li><a href="Group.html">Group</a></li>
<li><a href="Identifiable.html">Identifiable</a></li>
<li><a href="MOVEMENT.html">MOVEMENT</a></li>
<li><a href="Menu.html">Menu</a></li>
<li><a href="Message.html">Message</a></li>
<li><a href="MissileTrainer.html">MissileTrainer</a></li>
<li><a href="Mission.html">Mission</a></li>
<li><a href="Object.html">Object</a></li>
<li>Point</li>
<li><a href="Positionable.html">Positionable</a></li>
<li><a href="Process_JTAC.html">Process_JTAC</a></li>
<li><a href="Process_Pickup.html">Process_Pickup</a></li>
<li><a href="Route.html">Route</a></li>
<li><a href="Scenery.html">Scenery</a></li>
<li><a href="ScheduleDispatcher.html">ScheduleDispatcher</a></li>
<li><a href="Scheduler.html">Scheduler</a></li>
<li><a href="Scoring.html">Scoring</a></li>
<li><a href="Sead.html">Sead</a></li>
<li><a href="Set.html">Set</a></li>
<li><a href="Smoke.html">Smoke</a></li>
<li><a href="Spawn.html">Spawn</a></li>
<li><a href="Static.html">Static</a></li>
<li><a href="Task.html">Task</a></li>
<li><a href="Task_A2G.html">Task_A2G</a></li>
<li><a href="Task_PICKUP.html">Task_PICKUP</a></li>
<li><a href="Task_SEAD.html">Task_SEAD</a></li>
<li><a href="Unit.html">Unit</a></li>
<li><a href="Utils.html">Utils</a></li>
<li><a href="Zone.html">Zone</a></li>
<li><a href="routines.html">routines</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>Point</code></h1>
<p>This module contains the POINT classes.</p>
<h1>1) <a href="Point.html##(POINT_VEC3)">Point#POINT_VEC3</a> class, extends <a href="Base.html##(BASE)">Base#BASE</a></h1>
<p>The <a href="Point.html##(POINT_VEC3)">Point#POINT_VEC3</a> class defines a 3D point in the simulator.</p>
<p><strong>Important Note:</strong> Most of the functions in this section were taken from MIST, and reworked to OO concepts.
In order to keep the credibility of the the author, I want to emphasize that the of the MIST framework was created by Grimes, who you can find on the Eagle Dynamics Forums.</p>
<h2>1.1) POINT_VEC3 constructor</h2>
<p>A new POINT_VEC3 instance can be created with:</p>
<ul>
<li><a href="Point.html##(POINT_VEC3).New">Point#POINT_VEC3.New</a>(): a 3D point.</li>
<li><a href="Point.html##(POINT_VEC3).NewFromVec3">Point#POINT_VEC3.NewFromVec3</a>(): a 3D point created from a <a href="DCSTypes.html##(Vec3)">DCSTypes#Vec3</a>.</li>
</ul>
<h1>2) <a href="Point.html##(POINT_VEC2)">Point#POINT_VEC2</a> class, extends <a href="Point.html##(POINT_VEC3)">Point#POINT_VEC3</a></h1>
<p>The <a href="Point.html##(POINT_VEC2)">Point#POINT_VEC2</a> class defines a 2D point in the simulator. The height coordinate (if needed) will be the land height + an optional added height specified.</p>
<h2>2.1) POINT_VEC2 constructor</h2>
<p>A new POINT_VEC2 instance can be created with:</p>
<ul>
<li><a href="Point.html##(POINT_VEC2).New">Point#POINT_VEC2.New</a>(): a 2D point, taking an additional height parameter.</li>
<li><a href="Point.html##(POINT_VEC2).NewFromVec2">Point#POINT_VEC2.NewFromVec2</a>(): a 2D point created from a <a href="DCSTypes.html##(Vec2)">DCSTypes#Vec2</a>.</li>
</ul>
<hr/>
<h1><strong>API CHANGE HISTORY</strong></h1>
<p>The underlying change log documents the API changes. Please read this carefully. The following notation is used:</p>
<ul>
<li><strong>Added</strong> parts are expressed in bold type face.</li>
<li><em>Removed</em> parts are expressed in italic type face.</li>
</ul>
<p>Hereby the change log:</p>
<p>2017-02-18: POINT_VEC3:<strong>NewFromVec2( Vec2, LandHeightAdd )</strong> added.</p>
<p>2016-08-12: POINT_VEC3:<strong>Translate( Distance, Angle )</strong> added.</p>
<p>2016-08-06: Made PointVec3 and Vec3, PointVec2 and Vec2 terminology used in the code consistent.</p>
<ul>
<li>Replaced method <em>Point</em>Vec3() to <strong>Vec3</strong>() where the code manages a Vec3. Replaced all references to the method.</li>
<li>Replaced method <em>Point</em>Vec2() to <strong>Vec2</strong>() where the code manages a Vec2. Replaced all references to the method.</li>
<li>Replaced method Random<em>Point</em>Vec3() to <strong>RandomVec3</strong>() where the code manages a Vec3. Replaced all references to the method.
.</li>
</ul>
<h3>Authors:</h3>
<ul>
<li>FlightControl : Design &amp; Programming</li>
</ul>
<h3>Contributions:</h3>
<h2>Global(s)</h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="#POINT_VEC2">POINT_VEC2</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="#POINT_VEC3">POINT_VEC3</a></td>
<td class="summary">
</td>
</tr>
</table>
<h2><a id="#(POINT_VEC2)">Type <code>POINT_VEC2</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC2).ClassName">POINT_VEC2.ClassName</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC2).DistanceFromPointVec2">POINT_VEC2:DistanceFromPointVec2(PointVec2Reference)</a></td>
<td class="summary">
<p>Calculate the distance from a reference <a href="##(POINT_VEC2)">#POINT_VEC2</a>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC2).DistanceFromVec2">POINT_VEC2:DistanceFromVec2(Vec2Reference)</a></td>
<td class="summary">
<p>Calculate the distance from a reference <a href="DCSTypes.html##(Vec2)">DCSTypes#Vec2</a>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC2).GetAlt">POINT_VEC2:GetAlt()</a></td>
<td class="summary">
<p>Return the altitude of the land at the POINT_VEC2.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC2).GetAltitudeText">POINT_VEC2:GetAltitudeText()</a></td>
<td class="summary">
<p>Return no text for the altitude of the POINT_VEC2.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC2).GetX">POINT_VEC2:GetX()</a></td>
<td class="summary">
<p>Return the x coordinate of the POINT_VEC2.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC2).GetY">POINT_VEC2:GetY()</a></td>
<td class="summary">
<p>Return the y coordinate of the POINT_VEC2.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC2).New">POINT_VEC2:New(x, y, LandHeightAdd)</a></td>
<td class="summary">
<p>POINT_VEC2 constructor.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC2).NewFromVec2">POINT_VEC2:NewFromVec2(Vec2, LandHeightAdd)</a></td>
<td class="summary">
<p>Create a new POINT_VEC2 object from Vec2 coordinates.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC2).NewFromVec3">POINT_VEC2:NewFromVec3(Vec3)</a></td>
<td class="summary">
<p>Create a new POINT_VEC2 object from Vec3 coordinates.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC2).SetX">POINT_VEC2.SetX(x, self)</a></td>
<td class="summary">
<p>Set the x coordinate of the POINT_VEC2.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC2).SetY">POINT_VEC2.SetY(y, self)</a></td>
<td class="summary">
<p>Set the y coordinate of the POINT_VEC2.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC2).Translate">POINT_VEC2:Translate(Distance, Angle)</a></td>
<td class="summary">
<p>Add a Distance in meters from the POINT<em>VEC2 orthonormal plane, with the given angle, and calculate the new POINT</em>VEC2.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC2).x">POINT_VEC2.x</a></td>
<td class="summary">
<p>The x coordinate in meters.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC2).y">POINT_VEC2.y</a></td>
<td class="summary">
<p>the y coordinate in meters.</p>
</td>
</tr>
</table>
<h2><a id="#(POINT_VEC3)">Type <code>POINT_VEC3</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).ClassName">POINT_VEC3.ClassName</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).Flare">POINT_VEC3:Flare(FlareColor, (, Azimuth)</a></td>
<td class="summary">
<p>Flares the point in a color.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).FlareColor">POINT_VEC3.FlareColor</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).FlareGreen">POINT_VEC3:FlareGreen((, Azimuth)</a></td>
<td class="summary">
<p>Flare the POINT_VEC3 Green.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).FlareRed">POINT_VEC3:FlareRed(Azimuth)</a></td>
<td class="summary">
<p>Flare the POINT_VEC3 Red.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).FlareWhite">POINT_VEC3:FlareWhite((, Azimuth)</a></td>
<td class="summary">
<p>Flare the POINT_VEC3 White.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).FlareYellow">POINT_VEC3:FlareYellow((, Azimuth)</a></td>
<td class="summary">
<p>Flare the POINT_VEC3 Yellow.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).Get2DDistance">POINT_VEC3:Get2DDistance(TargetPointVec3)</a></td>
<td class="summary">
<p>Return the 2D distance in meters between the target POINT<em>VEC3 and the POINT</em>VEC3.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).Get3DDistance">POINT_VEC3:Get3DDistance(TargetPointVec3)</a></td>
<td class="summary">
<p>Return the 3D distance in meters between the target POINT<em>VEC3 and the POINT</em>VEC3.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).GetAltitudeText">POINT_VEC3:GetAltitudeText()</a></td>
<td class="summary">
<p>Return the altitude text of the POINT_VEC3.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).GetBRText">POINT_VEC3:GetBRText(TargetPointVec3)</a></td>
<td class="summary">
<p>Return a BR string from a POINT<em>VEC3 to the POINT</em>VEC3.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).GetDirectionRadians">POINT_VEC3:GetDirectionRadians(DirectionVec3)</a></td>
<td class="summary">
<p>Return a direction in radians from the POINT_VEC3 using a direction vector in Vec3 format.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).GetDirectionVec3">POINT_VEC3:GetDirectionVec3(TargetPointVec3)</a></td>
<td class="summary">
<p>Return a direction vector Vec3 from POINT<em>VEC3 to the POINT</em>VEC3.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).GetNorthCorrectionRadians">POINT_VEC3:GetNorthCorrectionRadians()</a></td>
<td class="summary">
<p>Get a correction in radians of the real magnetic north of the POINT_VEC3.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).GetRandomPointVec2InRadius">POINT_VEC3:GetRandomPointVec2InRadius(OuterRadius, InnerRadius)</a></td>
<td class="summary">
<p>Return a random POINT<em>VEC2 within an Outer Radius and optionally NOT within an Inner Radius of the POINT</em>VEC3.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).GetRandomPointVec3InRadius">POINT_VEC3:GetRandomPointVec3InRadius(OuterRadius, InnerRadius)</a></td>
<td class="summary">
<p>Return a random POINT<em>VEC3 within an Outer Radius and optionally NOT within an Inner Radius of the POINT</em>VEC3.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).GetRandomVec2InRadius">POINT_VEC3:GetRandomVec2InRadius(OuterRadius, InnerRadius)</a></td>
<td class="summary">
<p>Return a random Vec2 within an Outer Radius and optionally NOT within an Inner Radius of the POINT_VEC3.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).GetRandomVec3InRadius">POINT_VEC3:GetRandomVec3InRadius(OuterRadius, InnerRadius)</a></td>
<td class="summary">
<p>Return a random Vec3 within an Outer Radius and optionally NOT within an Inner Radius of the POINT_VEC3.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).GetVec2">POINT_VEC3:GetVec2()</a></td>
<td class="summary">
<p>Return the coordinates of the POINT_VEC3 in Vec2 format.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).GetVec3">POINT_VEC3:GetVec3()</a></td>
<td class="summary">
<p>Return the coordinates of the POINT_VEC3 in Vec3 format.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).GetX">POINT_VEC3:GetX()</a></td>
<td class="summary">
<p>Return the x coordinate of the POINT_VEC3.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).GetY">POINT_VEC3:GetY()</a></td>
<td class="summary">
<p>Return the y coordinate of the POINT_VEC3.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).GetZ">POINT_VEC3:GetZ()</a></td>
<td class="summary">
<p>Return the z coordinate of the POINT_VEC3.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).IsMetric">POINT_VEC3:IsMetric()</a></td>
<td class="summary">
<p>Gets if the POINT_VEC3 is metric or NM.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).Metric">POINT_VEC3.Metric</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).New">POINT_VEC3:New(x, y, z)</a></td>
<td class="summary">
<p>Create a new POINT_VEC3 object.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).NewFromVec2">POINT_VEC3:NewFromVec2(Vec2, LandHeightAdd)</a></td>
<td class="summary">
<p>Create a new POINT_VEC3 object from Vec2 coordinates.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).NewFromVec3">POINT_VEC3:NewFromVec3(Vec3)</a></td>
<td class="summary">
<p>Create a new POINT_VEC3 object from Vec3 coordinates.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).RoutePointAction">POINT_VEC3.RoutePointAction</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).RoutePointAir">POINT_VEC3:RoutePointAir(AltType, Type, Action, Speed, SpeedLocked)</a></td>
<td class="summary">
<p>Build an air type route point.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).RoutePointAltType">POINT_VEC3.RoutePointAltType</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).RoutePointGround">POINT_VEC3:RoutePointGround(Speed, Formation)</a></td>
<td class="summary">
<p>Build an ground type route point.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).RoutePointType">POINT_VEC3.RoutePointType</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).SetMetric">POINT_VEC3:SetMetric(Metric)</a></td>
<td class="summary">
<p>Sets the POINT_VEC3 metric or NM.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).SetX">POINT_VEC3.SetX(x, self)</a></td>
<td class="summary">
<p>Set the x coordinate of the POINT_VEC3.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).SetY">POINT_VEC3.SetY(y, self)</a></td>
<td class="summary">
<p>Set the y coordinate of the POINT_VEC3.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).SetZ">POINT_VEC3.SetZ(z, self)</a></td>
<td class="summary">
<p>Set the z coordinate of the POINT_VEC3.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).Smoke">POINT_VEC3:Smoke(SmokeColor)</a></td>
<td class="summary">
<p>Smokes the point in a color.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).SmokeBlue">POINT_VEC3:SmokeBlue()</a></td>
<td class="summary">
<p>Smoke the POINT_VEC3 Blue.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).SmokeColor">POINT_VEC3.SmokeColor</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).SmokeGreen">POINT_VEC3:SmokeGreen()</a></td>
<td class="summary">
<p>Smoke the POINT_VEC3 Green.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).SmokeOrange">POINT_VEC3:SmokeOrange()</a></td>
<td class="summary">
<p>Smoke the POINT_VEC3 Orange.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).SmokeRed">POINT_VEC3:SmokeRed()</a></td>
<td class="summary">
<p>Smoke the POINT_VEC3 Red.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).SmokeWhite">POINT_VEC3:SmokeWhite()</a></td>
<td class="summary">
<p>Smoke the POINT_VEC3 White.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).ToStringBR">POINT_VEC3:ToStringBR(AngleRadians, Distance)</a></td>
<td class="summary">
<p>Provides a Bearing / Range string</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).ToStringLL">POINT_VEC3:ToStringLL(AngleRadians, Distance, acc, DMS)</a></td>
<td class="summary">
<p>Provides a Bearing / Range string</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).Translate">POINT_VEC3:Translate(Distance, Angle)</a></td>
<td class="summary">
<p>Add a Distance in meters from the POINT<em>VEC3 horizontal plane, with the given angle, and calculate the new POINT</em>VEC3.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).x">POINT_VEC3.x</a></td>
<td class="summary">
<p>The x coordinate in 3D space.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).y">POINT_VEC3.y</a></td>
<td class="summary">
<p>The y coordinate in 3D space.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).z">POINT_VEC3.z</a></td>
<td class="summary">
<p>The z coordiante in 3D space.</p>
</td>
</tr>
</table>
<h2><a id="#(POINT_VEC3.RoutePointAction)">Type <code>POINT_VEC3.RoutePointAction</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3.RoutePointAction).FromParkingArea">POINT_VEC3.RoutePointAction.FromParkingArea</a></td>
<td class="summary">
<p>"From Parking Area"</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3.RoutePointAction).TurningPoint">POINT_VEC3.RoutePointAction.TurningPoint</a></td>
<td class="summary">
<p>"Turning Point"</p>
</td>
</tr>
</table>
<h2><a id="#(POINT_VEC3.RoutePointAltType)">Type <code>POINT_VEC3.RoutePointAltType</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3.RoutePointAltType).BARO">POINT_VEC3.RoutePointAltType.BARO</a></td>
<td class="summary">
<p>"BARO"</p>
</td>
</tr>
</table>
<h2><a id="#(POINT_VEC3.RoutePointType)">Type <code>POINT_VEC3.RoutePointType</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3.RoutePointType).TakeOffParking">POINT_VEC3.RoutePointType.TakeOffParking</a></td>
<td class="summary">
<p>"TakeOffParking"</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3.RoutePointType).TurningPoint">POINT_VEC3.RoutePointType.TurningPoint</a></td>
<td class="summary">
<p>"Turning Point"</p>
</td>
</tr>
</table>
<h2>Global(s)</h2>
<dl class="function">
<dt>
<em><a href="##(POINT_VEC2)">#POINT_VEC2</a></em>
<a id="POINT_VEC2" >
<strong>POINT_VEC2</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="##(POINT_VEC3)">#POINT_VEC3</a></em>
<a id="POINT_VEC3" >
<strong>POINT_VEC3</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<h2><a id="#(Point)" >Type <code>Point</code></a></h2>
<h2><a id="#(POINT_VEC2)" >Type <code>POINT_VEC2</code></a></h2>
<p>The POINT_VEC2 class</p>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(POINT_VEC2).ClassName" >
<strong>POINT_VEC2.ClassName</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC2).DistanceFromPointVec2" >
<strong>POINT_VEC2:DistanceFromPointVec2(PointVec2Reference)</strong>
</a>
</dt>
<dd>
<p>Calculate the distance from a reference <a href="##(POINT_VEC2)">#POINT_VEC2</a>.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="##(POINT_VEC2)">#POINT_VEC2</a> PointVec2Reference </em></code>:
The reference <a href="##(POINT_VEC2)">#POINT_VEC2</a>.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a>:</em>
The distance from the reference <a href="##(POINT_VEC2)">#POINT_VEC2</a> in meters.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC2).DistanceFromVec2" >
<strong>POINT_VEC2:DistanceFromVec2(Vec2Reference)</strong>
</a>
</dt>
<dd>
<p>Calculate the distance from a reference <a href="DCSTypes.html##(Vec2)">DCSTypes#Vec2</a>.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Vec2)">Dcs.DCSTypes#Vec2</a> Vec2Reference </em></code>:
The reference <a href="DCSTypes.html##(Vec2)">DCSTypes#Vec2</a>.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a>:</em>
The distance from the reference <a href="DCSTypes.html##(Vec2)">DCSTypes#Vec2</a> in meters.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC2).GetAlt" >
<strong>POINT_VEC2:GetAlt()</strong>
</a>
</dt>
<dd>
<p>Return the altitude of the land at the POINT_VEC2.</p>
<h3>Return value</h3>
<p><em>#number:</em>
The land altitude.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC2).GetAltitudeText" >
<strong>POINT_VEC2:GetAltitudeText()</strong>
</a>
</dt>
<dd>
<p>Return no text for the altitude of the POINT_VEC2.</p>
<h3>Return value</h3>
<p><em>#string:</em>
Empty string.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC2).GetX" >
<strong>POINT_VEC2:GetX()</strong>
</a>
</dt>
<dd>
<p>Return the x coordinate of the POINT_VEC2.</p>
<h3>Return value</h3>
<p><em>#number:</em>
The x coodinate.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC2).GetY" >
<strong>POINT_VEC2:GetY()</strong>
</a>
</dt>
<dd>
<p>Return the y coordinate of the POINT_VEC2.</p>
<h3>Return value</h3>
<p><em>#number:</em>
The y coodinate.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC2).New" >
<strong>POINT_VEC2:New(x, y, LandHeightAdd)</strong>
</a>
</dt>
<dd>
<p>POINT_VEC2 constructor.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a> x </em></code>:
The x coordinate of the Vec3 point, pointing to the North.</p>
</li>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a> y </em></code>:
The y coordinate of the Vec3 point, pointing to the Right.</p>
</li>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a> LandHeightAdd </em></code>:
(optional) The default height if required to be evaluated will be the land height of the x, y coordinate. You can specify an extra height to be added to the land height.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC2).NewFromVec2" >
<strong>POINT_VEC2:NewFromVec2(Vec2, LandHeightAdd)</strong>
</a>
</dt>
<dd>
<p>Create a new POINT_VEC2 object from Vec2 coordinates.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Vec2)">Dcs.DCSTypes#Vec2</a> Vec2 </em></code>:
The Vec2 point.</p>
</li>
<li>
<p><code><em> LandHeightAdd </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC2).NewFromVec3" >
<strong>POINT_VEC2:NewFromVec3(Vec3)</strong>
</a>
</dt>
<dd>
<p>Create a new POINT_VEC2 object from Vec3 coordinates.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Vec3)">Dcs.DCSTypes#Vec3</a> Vec3 </em></code>:
The Vec3 point.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC2).SetX" >
<strong>POINT_VEC2.SetX(x, self)</strong>
</a>
</dt>
<dd>
<p>Set the x coordinate of the POINT_VEC2.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#number x </em></code>:
The x coordinate.</p>
</li>
<li>
<p><code><em> self </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC2).SetY" >
<strong>POINT_VEC2.SetY(y, self)</strong>
</a>
</dt>
<dd>
<p>Set the y coordinate of the POINT_VEC2.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#number y </em></code>:
The y coordinate.</p>
</li>
<li>
<p><code><em> self </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC2).Translate" >
<strong>POINT_VEC2:Translate(Distance, Angle)</strong>
</a>
</dt>
<dd>
<p>Add a Distance in meters from the POINT<em>VEC2 orthonormal plane, with the given angle, and calculate the new POINT</em>VEC2.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a> Distance </em></code>:
The Distance to be added in meters.</p>
</li>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Angle)">Dcs.DCSTypes#Angle</a> Angle </em></code>:
The Angle in degrees.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(POINT_VEC2)">#POINT_VEC2</a>:</em>
The new calculated POINT_VEC2.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a></em>
<a id="#(POINT_VEC2).x" >
<strong>POINT_VEC2.x</strong>
</a>
</dt>
<dd>
<p>The x coordinate in meters.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a></em>
<a id="#(POINT_VEC2).y" >
<strong>POINT_VEC2.y</strong>
</a>
</dt>
<dd>
<p>the y coordinate in meters.</p>
</dd>
</dl>
<h2><a id="#(POINT_VEC3)" >Type <code>POINT_VEC3</code></a></h2>
<p>The POINT_VEC3 class</p>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(POINT_VEC3).ClassName" >
<strong>POINT_VEC3.ClassName</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).Flare" >
<strong>POINT_VEC3:Flare(FlareColor, (, Azimuth)</strong>
</a>
</dt>
<dd>
<p>Flares the point in a color.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Utilities.Utils.html##(FLARECOLOR)">Utilities.Utils#FLARECOLOR</a> FlareColor </em></code>: </p>
</li>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Azimuth)">Dcs.DCSTypes#Azimuth</a> ( </em></code>:
ptional) Azimuth The azimuth of the flare direction. The default azimuth is 0.</p>
</li>
<li>
<p><code><em> Azimuth </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Utilities.Utils.html##(FLARECOLOR)">Utilities.Utils#FLARECOLOR</a></em>
<a id="#(POINT_VEC3).FlareColor" >
<strong>POINT_VEC3.FlareColor</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).FlareGreen" >
<strong>POINT_VEC3:FlareGreen((, Azimuth)</strong>
</a>
</dt>
<dd>
<p>Flare the POINT_VEC3 Green.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Azimuth)">Dcs.DCSTypes#Azimuth</a> ( </em></code>:
ptional) Azimuth The azimuth of the flare direction. The default azimuth is 0.</p>
</li>
<li>
<p><code><em> Azimuth </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).FlareRed" >
<strong>POINT_VEC3:FlareRed(Azimuth)</strong>
</a>
</dt>
<dd>
<p>Flare the POINT_VEC3 Red.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> Azimuth </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).FlareWhite" >
<strong>POINT_VEC3:FlareWhite((, Azimuth)</strong>
</a>
</dt>
<dd>
<p>Flare the POINT_VEC3 White.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Azimuth)">Dcs.DCSTypes#Azimuth</a> ( </em></code>:
ptional) Azimuth The azimuth of the flare direction. The default azimuth is 0.</p>
</li>
<li>
<p><code><em> Azimuth </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).FlareYellow" >
<strong>POINT_VEC3:FlareYellow((, Azimuth)</strong>
</a>
</dt>
<dd>
<p>Flare the POINT_VEC3 Yellow.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Azimuth)">Dcs.DCSTypes#Azimuth</a> ( </em></code>:
ptional) Azimuth The azimuth of the flare direction. The default azimuth is 0.</p>
</li>
<li>
<p><code><em> Azimuth </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).Get2DDistance" >
<strong>POINT_VEC3:Get2DDistance(TargetPointVec3)</strong>
</a>
</dt>
<dd>
<p>Return the 2D distance in meters between the target POINT<em>VEC3 and the POINT</em>VEC3.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="##(POINT_VEC3)">#POINT_VEC3</a> TargetPointVec3 </em></code>:
The target POINT_VEC3.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a>:</em>
Distance The distance in meters.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).Get3DDistance" >
<strong>POINT_VEC3:Get3DDistance(TargetPointVec3)</strong>
</a>
</dt>
<dd>
<p>Return the 3D distance in meters between the target POINT<em>VEC3 and the POINT</em>VEC3.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="##(POINT_VEC3)">#POINT_VEC3</a> TargetPointVec3 </em></code>:
The target POINT_VEC3.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a>:</em>
Distance The distance in meters.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).GetAltitudeText" >
<strong>POINT_VEC3:GetAltitudeText()</strong>
</a>
</dt>
<dd>
<p>Return the altitude text of the POINT_VEC3.</p>
<h3>Return value</h3>
<p><em>#string:</em>
Altitude text.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).GetBRText" >
<strong>POINT_VEC3:GetBRText(TargetPointVec3)</strong>
</a>
</dt>
<dd>
<p>Return a BR string from a POINT<em>VEC3 to the POINT</em>VEC3.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="##(POINT_VEC3)">#POINT_VEC3</a> TargetPointVec3 </em></code>:
The target POINT_VEC3.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#string:</em>
The BR text.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).GetDirectionRadians" >
<strong>POINT_VEC3:GetDirectionRadians(DirectionVec3)</strong>
</a>
</dt>
<dd>
<p>Return a direction in radians from the POINT_VEC3 using a direction vector in Vec3 format.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Vec3)">Dcs.DCSTypes#Vec3</a> DirectionVec3 </em></code>:
The direction vector in Vec3 format.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#number:</em>
DirectionRadians The direction in radians.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).GetDirectionVec3" >
<strong>POINT_VEC3:GetDirectionVec3(TargetPointVec3)</strong>
</a>
</dt>
<dd>
<p>Return a direction vector Vec3 from POINT<em>VEC3 to the POINT</em>VEC3.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="##(POINT_VEC3)">#POINT_VEC3</a> TargetPointVec3 </em></code>:
The target POINT_VEC3.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Dcs.DCSTypes.html##(Vec3)">Dcs.DCSTypes#Vec3</a>:</em>
DirectionVec3 The direction vector in Vec3 format.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).GetNorthCorrectionRadians" >
<strong>POINT_VEC3:GetNorthCorrectionRadians()</strong>
</a>
</dt>
<dd>
<p>Get a correction in radians of the real magnetic north of the POINT_VEC3.</p>
<h3>Return value</h3>
<p><em>#number:</em>
CorrectionRadians The correction in radians.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).GetRandomPointVec2InRadius" >
<strong>POINT_VEC3:GetRandomPointVec2InRadius(OuterRadius, InnerRadius)</strong>
</a>
</dt>
<dd>
<p>Return a random POINT<em>VEC2 within an Outer Radius and optionally NOT within an Inner Radius of the POINT</em>VEC3.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a> OuterRadius </em></code>: </p>
</li>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a> InnerRadius </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(POINT_VEC2)">#POINT_VEC2</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).GetRandomPointVec3InRadius" >
<strong>POINT_VEC3:GetRandomPointVec3InRadius(OuterRadius, InnerRadius)</strong>
</a>
</dt>
<dd>
<p>Return a random POINT<em>VEC3 within an Outer Radius and optionally NOT within an Inner Radius of the POINT</em>VEC3.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a> OuterRadius </em></code>: </p>
</li>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a> InnerRadius </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(POINT_VEC3)">#POINT_VEC3</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).GetRandomVec2InRadius" >
<strong>POINT_VEC3:GetRandomVec2InRadius(OuterRadius, InnerRadius)</strong>
</a>
</dt>
<dd>
<p>Return a random Vec2 within an Outer Radius and optionally NOT within an Inner Radius of the POINT_VEC3.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a> OuterRadius </em></code>: </p>
</li>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a> InnerRadius </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Dcs.DCSTypes.html##(Vec2)">Dcs.DCSTypes#Vec2</a>:</em>
Vec2</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).GetRandomVec3InRadius" >
<strong>POINT_VEC3:GetRandomVec3InRadius(OuterRadius, InnerRadius)</strong>
</a>
</dt>
<dd>
<p>Return a random Vec3 within an Outer Radius and optionally NOT within an Inner Radius of the POINT_VEC3.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a> OuterRadius </em></code>: </p>
</li>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a> InnerRadius </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Dcs.DCSTypes.html##(Vec3)">Dcs.DCSTypes#Vec3</a>:</em>
Vec3</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).GetVec2" >
<strong>POINT_VEC3:GetVec2()</strong>
</a>
</dt>
<dd>
<p>Return the coordinates of the POINT_VEC3 in Vec2 format.</p>
<h3>Return value</h3>
<p><em><a href="Dcs.DCSTypes.html##(Vec2)">Dcs.DCSTypes#Vec2</a>:</em>
The Vec2 coodinate.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).GetVec3" >
<strong>POINT_VEC3:GetVec3()</strong>
</a>
</dt>
<dd>
<p>Return the coordinates of the POINT_VEC3 in Vec3 format.</p>
<h3>Return value</h3>
<p><em><a href="Dcs.DCSTypes.html##(Vec3)">Dcs.DCSTypes#Vec3</a>:</em>
The Vec3 coodinate.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).GetX" >
<strong>POINT_VEC3:GetX()</strong>
</a>
</dt>
<dd>
<p>Return the x coordinate of the POINT_VEC3.</p>
<h3>Return value</h3>
<p><em>#number:</em>
The x coodinate.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).GetY" >
<strong>POINT_VEC3:GetY()</strong>
</a>
</dt>
<dd>
<p>Return the y coordinate of the POINT_VEC3.</p>
<h3>Return value</h3>
<p><em>#number:</em>
The y coodinate.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).GetZ" >
<strong>POINT_VEC3:GetZ()</strong>
</a>
</dt>
<dd>
<p>Return the z coordinate of the POINT_VEC3.</p>
<h3>Return value</h3>
<p><em>#number:</em>
The z coodinate.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).IsMetric" >
<strong>POINT_VEC3:IsMetric()</strong>
</a>
</dt>
<dd>
<p>Gets if the POINT_VEC3 is metric or NM.</p>
<h3>Return value</h3>
<p><em>#boolean:</em>
Metric true means metric, false means NM.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(POINT_VEC3).Metric" >
<strong>POINT_VEC3.Metric</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).New" >
<strong>POINT_VEC3:New(x, y, z)</strong>
</a>
</dt>
<dd>
<p>Create a new POINT_VEC3 object.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a> x </em></code>:
The x coordinate of the Vec3 point, pointing to the North.</p>
</li>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a> y </em></code>:
The y coordinate of the Vec3 point, pointing Upwards.</p>
</li>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a> z </em></code>:
The z coordinate of the Vec3 point, pointing to the Right.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Core.Point.html##(POINT_VEC3)">Core.Point#POINT_VEC3</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).NewFromVec2" >
<strong>POINT_VEC3:NewFromVec2(Vec2, LandHeightAdd)</strong>
</a>
</dt>
<dd>
<p>Create a new POINT_VEC3 object from Vec2 coordinates.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Vec2)">Dcs.DCSTypes#Vec2</a> Vec2 </em></code>:
The Vec2 point.</p>
</li>
<li>
<p><code><em> LandHeightAdd </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Core.Point.html##(POINT_VEC3)">Core.Point#POINT_VEC3</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).NewFromVec3" >
<strong>POINT_VEC3:NewFromVec3(Vec3)</strong>
</a>
</dt>
<dd>
<p>Create a new POINT_VEC3 object from Vec3 coordinates.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Vec3)">Dcs.DCSTypes#Vec3</a> Vec3 </em></code>:
The Vec3 point.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Core.Point.html##(POINT_VEC3)">Core.Point#POINT_VEC3</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="##(POINT_VEC3.RoutePointAction)">#POINT_VEC3.RoutePointAction</a></em>
<a id="#(POINT_VEC3).RoutePointAction" >
<strong>POINT_VEC3.RoutePointAction</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).RoutePointAir" >
<strong>POINT_VEC3:RoutePointAir(AltType, Type, Action, Speed, SpeedLocked)</strong>
</a>
</dt>
<dd>
<p>Build an air type route point.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="##(POINT_VEC3.RoutePointAltType)">#POINT_VEC3.RoutePointAltType</a> AltType </em></code>:
The altitude type.</p>
</li>
<li>
<p><code><em><a href="##(POINT_VEC3.RoutePointType)">#POINT_VEC3.RoutePointType</a> Type </em></code>:
The route point type.</p>
</li>
<li>
<p><code><em><a href="##(POINT_VEC3.RoutePointAction)">#POINT_VEC3.RoutePointAction</a> Action </em></code>:
The route point action.</p>
</li>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Speed)">Dcs.DCSTypes#Speed</a> Speed </em></code>:
Airspeed in km/h.</p>
</li>
<li>
<p><code><em>#boolean SpeedLocked </em></code>:
true means the speed is locked.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#table:</em>
The route point.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="##(POINT_VEC3.RoutePointAltType)">#POINT_VEC3.RoutePointAltType</a></em>
<a id="#(POINT_VEC3).RoutePointAltType" >
<strong>POINT_VEC3.RoutePointAltType</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).RoutePointGround" >
<strong>POINT_VEC3:RoutePointGround(Speed, Formation)</strong>
</a>
</dt>
<dd>
<p>Build an ground type route point.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Speed)">Dcs.DCSTypes#Speed</a> Speed </em></code>:
Speed in km/h.</p>
</li>
<li>
<p><code><em><a href="##(POINT_VEC3.RoutePointAction)">#POINT_VEC3.RoutePointAction</a> Formation </em></code>:
The route point Formation.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#table:</em>
The route point.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="##(POINT_VEC3.RoutePointType)">#POINT_VEC3.RoutePointType</a></em>
<a id="#(POINT_VEC3).RoutePointType" >
<strong>POINT_VEC3.RoutePointType</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).SetMetric" >
<strong>POINT_VEC3:SetMetric(Metric)</strong>
</a>
</dt>
<dd>
<p>Sets the POINT_VEC3 metric or NM.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#boolean Metric </em></code>:
true means metric, false means NM.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).SetX" >
<strong>POINT_VEC3.SetX(x, self)</strong>
</a>
</dt>
<dd>
<p>Set the x coordinate of the POINT_VEC3.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#number x </em></code>:
The x coordinate.</p>
</li>
<li>
<p><code><em> self </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).SetY" >
<strong>POINT_VEC3.SetY(y, self)</strong>
</a>
</dt>
<dd>
<p>Set the y coordinate of the POINT_VEC3.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#number y </em></code>:
The y coordinate.</p>
</li>
<li>
<p><code><em> self </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).SetZ" >
<strong>POINT_VEC3.SetZ(z, self)</strong>
</a>
</dt>
<dd>
<p>Set the z coordinate of the POINT_VEC3.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#number z </em></code>:
The z coordinate.</p>
</li>
<li>
<p><code><em> self </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).Smoke" >
<strong>POINT_VEC3:Smoke(SmokeColor)</strong>
</a>
</dt>
<dd>
<p>Smokes the point in a color.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Utilities.Utils.html##(SMOKECOLOR)">Utilities.Utils#SMOKECOLOR</a> SmokeColor </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).SmokeBlue" >
<strong>POINT_VEC3:SmokeBlue()</strong>
</a>
</dt>
<dd>
<p>Smoke the POINT_VEC3 Blue.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Utilities.Utils.html##(SMOKECOLOR)">Utilities.Utils#SMOKECOLOR</a></em>
<a id="#(POINT_VEC3).SmokeColor" >
<strong>POINT_VEC3.SmokeColor</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).SmokeGreen" >
<strong>POINT_VEC3:SmokeGreen()</strong>
</a>
</dt>
<dd>
<p>Smoke the POINT_VEC3 Green.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).SmokeOrange" >
<strong>POINT_VEC3:SmokeOrange()</strong>
</a>
</dt>
<dd>
<p>Smoke the POINT_VEC3 Orange.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).SmokeRed" >
<strong>POINT_VEC3:SmokeRed()</strong>
</a>
</dt>
<dd>
<p>Smoke the POINT_VEC3 Red.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).SmokeWhite" >
<strong>POINT_VEC3:SmokeWhite()</strong>
</a>
</dt>
<dd>
<p>Smoke the POINT_VEC3 White.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).ToStringBR" >
<strong>POINT_VEC3:ToStringBR(AngleRadians, Distance)</strong>
</a>
</dt>
<dd>
<p>Provides a Bearing / Range string</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#number AngleRadians </em></code>:
The angle in randians</p>
</li>
<li>
<p><code><em>#number Distance </em></code>:
The distance</p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#string:</em>
The BR Text</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).ToStringLL" >
<strong>POINT_VEC3:ToStringLL(AngleRadians, Distance, acc, DMS)</strong>
</a>
</dt>
<dd>
<p>Provides a Bearing / Range string</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#number AngleRadians </em></code>:
The angle in randians</p>
</li>
<li>
<p><code><em>#number Distance </em></code>:
The distance</p>
</li>
<li>
<p><code><em> acc </em></code>: </p>
</li>
<li>
<p><code><em> DMS </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#string:</em>
The BR Text</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).Translate" >
<strong>POINT_VEC3:Translate(Distance, Angle)</strong>
</a>
</dt>
<dd>
<p>Add a Distance in meters from the POINT<em>VEC3 horizontal plane, with the given angle, and calculate the new POINT</em>VEC3.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a> Distance </em></code>:
The Distance to be added in meters.</p>
</li>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Angle)">Dcs.DCSTypes#Angle</a> Angle </em></code>:
The Angle in degrees.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(POINT_VEC3)">#POINT_VEC3</a>:</em>
The new calculated POINT_VEC3.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(POINT_VEC3).x" >
<strong>POINT_VEC3.x</strong>
</a>
</dt>
<dd>
<p>The x coordinate in 3D space.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(POINT_VEC3).y" >
<strong>POINT_VEC3.y</strong>
</a>
</dt>
<dd>
<p>The y coordinate in 3D space.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(POINT_VEC3).z" >
<strong>POINT_VEC3.z</strong>
</a>
</dt>
<dd>
<p>The z coordiante in 3D space.</p>
</dd>
</dl>
<h2><a id="#(POINT_VEC3.RoutePointAction)" >Type <code>POINT_VEC3.RoutePointAction</code></a></h2>
<p>RoutePoint Actions</p>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<a id="#(POINT_VEC3.RoutePointAction).FromParkingArea" >
<strong>POINT_VEC3.RoutePointAction.FromParkingArea</strong>
</a>
</dt>
<dd>
<p>"From Parking Area"</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3.RoutePointAction).TurningPoint" >
<strong>POINT_VEC3.RoutePointAction.TurningPoint</strong>
</a>
</dt>
<dd>
<p>"Turning Point"</p>
</dd>
</dl>
<h2><a id="#(POINT_VEC3.RoutePointAltType)" >Type <code>POINT_VEC3.RoutePointAltType</code></a></h2>
<p>RoutePoint AltTypes</p>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<a id="#(POINT_VEC3.RoutePointAltType).BARO" >
<strong>POINT_VEC3.RoutePointAltType.BARO</strong>
</a>
</dt>
<dd>
<p>"BARO"</p>
</dd>
</dl>
<h2><a id="#(POINT_VEC3.RoutePointType)" >Type <code>POINT_VEC3.RoutePointType</code></a></h2>
<p>RoutePoint Types</p>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<a id="#(POINT_VEC3.RoutePointType).TakeOffParking" >
<strong>POINT_VEC3.RoutePointType.TakeOffParking</strong>
</a>
</dt>
<dd>
<p>"TakeOffParking"</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3.RoutePointType).TurningPoint" >
<strong>POINT_VEC3.RoutePointType.TurningPoint</strong>
</a>
</dt>
<dd>
<p>"Turning Point"</p>
</dd>
</dl>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink