Module Point
This module contains the POINT classes.
1) Point#POINT_VEC3 class, extends Base#BASE
The Point#POINT_VEC3 class defines a 3D point in the simulator.
1.1) POINT_VEC3 constructor
A new POINT instance can be created with:
- POINT_VEC3.New(): a 3D point.
2) Point#POINT_VEC2 class, extends Point#POINT_VEC3
The Point#POINT_VEC2 class defines a 2D point in the simulator. The height coordinate (if needed) will be the land height + an optional added height specified.
2.1) POINT_VEC2 constructor
A new POINT instance can be created with:
- POINT_VEC2.New(): a 2D point.
Global(s)
| POINT_VEC2 | |
| POINT_VEC3 |
Type POINT_VEC2
| POINT_VEC2.ClassName | |
| POINT_VEC2:DistanceFromPointVec2(PointVec2Reference) |
Calculate the distance from a reference Point#POINT_VEC2. |
| POINT_VEC2:DistanceFromVec2(Vec2Reference) |
Calculate the distance from a reference DCSTypes#Vec2. |
| POINT_VEC2:New(x, y, LandHeightAdd) |
Create a new POINT_VEC2 object. |
| POINT_VEC2.PointVec2 |
Type POINT_VEC3
| POINT_VEC3.ClassName | |
| POINT_VEC3:Flare(Point, (, FlareColor, Azimuth) |
Flares the point in a color. |
| POINT_VEC3.FlareColor | |
| POINT_VEC3:FlareGreen((, Azimuth) |
Flare the POINT_VEC3 Green. |
| POINT_VEC3:FlareRed(Azimuth) |
Flare the POINT_VEC3 Red. |
| POINT_VEC3:FlareWhite((, Azimuth) |
Flare the POINT_VEC3 White. |
| POINT_VEC3:FlareYellow((, Azimuth) |
Flare the POINT_VEC3 Yellow. |
| POINT_VEC3:New(x, y, z) |
Create a new POINT_VEC3 object. |
| POINT_VEC3.RoutePointAction | |
| POINT_VEC3:RoutePointAir(AltType, Type, Action, Speed, SpeedLocked) |
Build an air type route point. |
| POINT_VEC3.RoutePointAltType | |
| POINT_VEC3.RoutePointType | |
| POINT_VEC3:Smoke(SmokeColor) |
Smokes the point in a color. |
| POINT_VEC3:SmokeBlue() |
Smoke the POINT_VEC3 Blue. |
| POINT_VEC3.SmokeColor | |
| POINT_VEC3:SmokeGreen() |
Smoke the POINT_VEC3 Green. |
| POINT_VEC3:SmokeOrange() |
Smoke the POINT_VEC3 Orange. |
| POINT_VEC3:SmokeRed() |
Smoke the POINT_VEC3 Red. |
| POINT_VEC3:SmokeWhite() |
Smoke the POINT_VEC3 White. |
Type POINT_VEC3.FlareColor
| POINT_VEC3.FlareColor.Green | |
| POINT_VEC3.FlareColor.Red | |
| POINT_VEC3.FlareColor.White | |
| POINT_VEC3.FlareColor.Yellow |
Type POINT_VEC3.RoutePointAction
| POINT_VEC3.RoutePointAction.TurningPoint |
"Turning Point" |
Type POINT_VEC3.RoutePointAltType
| POINT_VEC3.RoutePointAltType.BARO |
"BARO" |
Type POINT_VEC3.RoutePointType
| POINT_VEC3.RoutePointType.TurningPoint |
"Turning Point" |
Type POINT_VEC3.SmokeColor
| POINT_VEC3.SmokeColor.Blue | |
| POINT_VEC3.SmokeColor.Green | |
| POINT_VEC3.SmokeColor.Orange | |
| POINT_VEC3.SmokeColor.Red | |
| POINT_VEC3.SmokeColor.White |
Global(s)
Type Point
Type POINT_VEC2
The POINT_VEC2 class
Field(s)
- #string POINT_VEC2.ClassName
- POINT_VEC2:DistanceFromPointVec2(PointVec2Reference)
-
Calculate the distance from a reference Point#POINT_VEC2.
Parameter
-
#POINT_VEC2 PointVec2Reference: The reference Point#POINT_VEC2.
Return value
DCSTypes#Distance: The distance from the reference Point#POINT_VEC2 in meters.
-
- POINT_VEC2:DistanceFromVec2(Vec2Reference)
-
Calculate the distance from a reference DCSTypes#Vec2.
Parameter
-
DCSTypes#Vec2 Vec2Reference: The reference DCSTypes#Vec2.
Return value
DCSTypes#Distance: The distance from the reference DCSTypes#Vec2 in meters.
-
- POINT_VEC2:New(x, y, LandHeightAdd)
-
Create a new POINT_VEC2 object.
Parameters
-
DCSTypes#Distance x: The x coordinate of the Vec3 point, pointing to the North. -
DCSTypes#Distance y: The y coordinate of the Vec3 point, pointing to the Right. -
DCSTypes#Distance LandHeightAdd: (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.
Return value
-
Type POINT_VEC3
The POINT_VEC3 class
Field(s)
- #string POINT_VEC3.ClassName
- POINT_VEC3:Flare(Point, (, FlareColor, Azimuth)
-
Flares the point in a color.
Parameters
-
Point: POINT_VEC3.FlareColor -
DCSTypes#Azimuth (: ptional) Azimuth The azimuth of the flare direction. The default azimuth is 0. -
FlareColor: -
Azimuth:
-
- POINT_VEC3:FlareGreen((, Azimuth)
-
Flare the POINT_VEC3 Green.
Parameters
-
DCSTypes#Azimuth (: ptional) Azimuth The azimuth of the flare direction. The default azimuth is 0. -
Azimuth:
-
- POINT_VEC3:FlareRed(Azimuth)
-
Flare the POINT_VEC3 Red.
Parameter
-
Azimuth:
-
- POINT_VEC3:FlareWhite((, Azimuth)
-
Flare the POINT_VEC3 White.
Parameters
-
DCSTypes#Azimuth (: ptional) Azimuth The azimuth of the flare direction. The default azimuth is 0. -
Azimuth:
-
- POINT_VEC3:FlareYellow((, Azimuth)
-
Flare the POINT_VEC3 Yellow.
Parameters
-
DCSTypes#Azimuth (: ptional) Azimuth The azimuth of the flare direction. The default azimuth is 0. -
Azimuth:
-
- POINT_VEC3:New(x, y, z)
-
Create a new POINT_VEC3 object.
Parameters
-
DCSTypes#Distance x: The x coordinate of the Vec3 point, pointing to the North. -
DCSTypes#Distance y: The y coordinate of the Vec3 point, pointing Upwards. -
DCSTypes#Distance z: The z coordinate of the Vec3 point, pointing to the Right.
Return value
Point#POINT_VEC3: self
-
- POINT_VEC3:RoutePointAir(AltType, Type, Action, Speed, SpeedLocked)
-
Build an air type route point.
Parameters
-
#POINT_VEC3.RoutePointAltType AltType: The altitude type. -
#POINT_VEC3.RoutePointType Type: The route point type. -
#POINT_VEC3.RoutePointAction Action: The route point action. -
DCSTypes#Speed Speed: Airspeed in km/h. -
#boolean SpeedLocked: true means the speed is locked.
Return value
#table: The route point.
-
- POINT_VEC3:Smoke(SmokeColor)
-
Smokes the point in a color.
Parameter
-
Point#POINT_VEC3.SmokeColor SmokeColor:
-
- POINT_VEC3:SmokeBlue()
-
Smoke the POINT_VEC3 Blue.
- POINT_VEC3:SmokeGreen()
-
Smoke the POINT_VEC3 Green.
- POINT_VEC3:SmokeOrange()
-
Smoke the POINT_VEC3 Orange.
- POINT_VEC3:SmokeRed()
-
Smoke the POINT_VEC3 Red.
- POINT_VEC3:SmokeWhite()
-
Smoke the POINT_VEC3 White.
Type POINT_VEC3.FlareColor
FlareColor
Field(s)
Type POINT_VEC3.RoutePointAction
RoutePoint Actions
Field(s)
- POINT_VEC3.RoutePointAction.TurningPoint
-
"Turning Point"
Type POINT_VEC3.RoutePointAltType
RoutePoint AltTypes
Field(s)
Type POINT_VEC3.RoutePointType
RoutePoint Types
Field(s)
- POINT_VEC3.RoutePointType.TurningPoint
-
"Turning Point"
Type POINT_VEC3.SmokeColor
SmokeColor