FSUIPC Client DLL
.NET interface for FSUIPC
FsLatLonPoint Struct Reference

A point in the Flight Simulator world represented by a longitude and latitude. More...

Public Member Functions

 FsLatLonPoint (double DecimalLatitude, double DecimalLongitude)
 Create a new point from the specified latitude and longitude in decimal degrees.
 
 FsLatLonPoint (FsLatitude Latitude, FsLongitude Longitude)
 Create a new point from the specified latitude and longitude.
 
double DistanceFromInFeet (FsLatLonPoint Point)
 Gets the distance between this point and another specified point in Feet.
 
double DistanceFromInNauticalMiles (FsLatLonPoint Point)
 Gets the distance between this point and another specified point in Nautical Miles.
 
double DistanceFromInMetres (FsLatLonPoint Point)
 Gets the distance between this point and another specified point in Metres.
 
double BearingTo (FsLatLonPoint Point)
 Gets the bearing TO another point. The bearing will be in degrees TRUE, not magnetic.
 
double BearingFrom (FsLatLonPoint Point)
 Gets the bearing FROM another point. Bearing will be in degrees TRUE, not magnetic.
 
FsLatLonPoint OffsetByFeet (double Bearing, double Distance)
 Creates a new point by moving the specified distance along the specified bearing.
 
FsLatLonPoint OffsetByMetres (double Bearing, double Distance)
 Creates a new point by moving the specified distance along the specified bearing.
 
FsLatLonPoint OffsetByNauticalMiles (double Bearing, double Distance)
 Creates a new point by moving the specified distance along the specified bearing.
 
FsLatLonPointIntersectDMEMetres (double Bearing, FsLatLonPoint Point, Double Distance)
 Creates a new point by moving from the current point along a specified bearing to where the new point is a certain distance from a second point.
 
FsLatLonPointIntersectDMENauticalMiles (double Bearing, FsLatLonPoint Point, Double Distance)
 Creates a new point by moving from the current point along a specified bearing to where the new point is a certain distance from a second point.
 
FsLatLonPointIntersectDMEFeet (double Bearing, FsLatLonPoint Point, Double Distance)
 Creates a new point by moving from the current point along a specified bearing to where the new point is a certain distance from a second point.
 
FsLatLonPointIntersectRadial (double Bearing, FsLatLonPoint Point, double Radial)
 Creates a new point by moving from the current point along a specified bearing to where the new point intersects a specfied raidal from a second specified point.
 
override string ToString ()
 The latitude and longitude represented as a string in the default format of N|S|E|W dd* mm.mmmm'.
 
string ToString (bool HemisphereAsText, string DetailLevel, short DecimalPlaces)
 The latitude and longitude represented as a string in the specified format.
 

Properties

FsLongitude Longitude [get, set]
 The longitude of the point.
 
FsLatitude Latitude [get, set]
 The latitude of the point.
 

Detailed Description

A point in the Flight Simulator world represented by a longitude and latitude.

Constructor & Destructor Documentation

◆ FsLatLonPoint() [1/2]

FsLatLonPoint ( double DecimalLatitude,
double DecimalLongitude )
inline

Create a new point from the specified latitude and longitude in decimal degrees.

Parameters
DecimalLatitudeThe latitude of the point in decimal degrees
DecimalLongitudeThe longitude of the point in decimal degrees

◆ FsLatLonPoint() [2/2]

FsLatLonPoint ( FsLatitude Latitude,
FsLongitude Longitude )
inline

Create a new point from the specified latitude and longitude.

Parameters
LatitudeThe latitude of the point
LongitudeThe longitude of the point

Member Function Documentation

◆ BearingFrom()

double BearingFrom ( FsLatLonPoint Point)
inline

Gets the bearing FROM another point. Bearing will be in degrees TRUE, not magnetic.

Parameters
PointThe other point to measure the bearing from
Returns
The bearing in degrees TRUE

◆ BearingTo()

double BearingTo ( FsLatLonPoint Point)
inline

Gets the bearing TO another point. The bearing will be in degrees TRUE, not magnetic.

Parameters
PointThe other point to measure the bearing to
Returns
The bearing in degrees TRUE

◆ DistanceFromInFeet()

double DistanceFromInFeet ( FsLatLonPoint Point)
inline

Gets the distance between this point and another specified point in Feet.

Parameters
PointThe other point from which to measure the distance
Returns
The distance between this point and the other specified point in Feet

◆ DistanceFromInMetres()

double DistanceFromInMetres ( FsLatLonPoint Point)
inline

Gets the distance between this point and another specified point in Metres.

Parameters
PointThe other point from which to measure the distance
Returns
The distance between this point and the other specified point in Metres

◆ DistanceFromInNauticalMiles()

double DistanceFromInNauticalMiles ( FsLatLonPoint Point)
inline

Gets the distance between this point and another specified point in Nautical Miles.

Parameters
PointThe other point from which to measure the distance
Returns
The distance between this point and the other specified point in Nautical Miles

◆ IntersectDMEFeet()

FsLatLonPoint? IntersectDMEFeet ( double Bearing,
FsLatLonPoint Point,
Double Distance )
inline

Creates a new point by moving from the current point along a specified bearing to where the new point is a certain distance from a second point.

A typical use would be to identify the point along a given bearing where you would be a given distance from a DME/VOR marker specified as the second point.

Parameters
BearingThe bearing from this point on which the intersection must occur in degrees TRUE.
PointThe point from which the distance for the intersection is measured.
DistanceThe distance required from the specified point in Feet.
Returns
An FsLatLonPoint representing the requested intersection. If the bearing never intersects, the resulting FsLatLonPoint will be null.

◆ IntersectDMEMetres()

FsLatLonPoint? IntersectDMEMetres ( double Bearing,
FsLatLonPoint Point,
Double Distance )
inline

Creates a new point by moving from the current point along a specified bearing to where the new point is a certain distance from a second point.

A typical use would be to identify the point along a given bearing where you would be a given distance from a DME/VOR marker specified as the second point.

Parameters
BearingThe bearing from this point on which the intersection must occur in degrees TRUE.
PointThe point from which the distance for the intersection is measured.
DistanceThe distance required from the specified point in Metres.
Returns
An FsLatLonPoint representing the requested intersection. If the bearing never intersects, the resulting FsLatLonPoint will be null.

◆ IntersectDMENauticalMiles()

FsLatLonPoint? IntersectDMENauticalMiles ( double Bearing,
FsLatLonPoint Point,
Double Distance )
inline

Creates a new point by moving from the current point along a specified bearing to where the new point is a certain distance from a second point.

A typical use would be to identify the point along a given bearing where you would be a given distance from a DME/VOR marker specified as the second point.

Parameters
BearingThe bearing from this point on which the intersection must occur in degrees TRUE.
PointThe point from which the distance for the intersection is measured.
DistanceThe distance required from the specified point in Nautical Miles.
Returns
An FsLatLonPoint representing the requested intersection. If the bearing never intersects, the resulting FsLatLonPoint will be null.

◆ IntersectRadial()

FsLatLonPoint? IntersectRadial ( double Bearing,
FsLatLonPoint Point,
double Radial )
inline

Creates a new point by moving from the current point along a specified bearing to where the new point intersects a specfied raidal from a second specified point.

A typical use would be to identify the point along a given bearing where you would intercept a given radial from a VOR marker specified as the second point.

Parameters
BearingThe bearing from this point on which the intersection must occur in degrees TRUE.
PointThe point from which the radial for the intersection is measured.
RadialThe intersect radial required from the specified point in Degrees TRUE.
Returns
An FsLatLonPoint representing the requested intersection. If the bearing never intersects, OR the intersection is more than 200NM from the specified Point, the resulting FsLatLonPoint will be null.

◆ OffsetByFeet()

FsLatLonPoint OffsetByFeet ( double Bearing,
double Distance )
inline

Creates a new point by moving the specified distance along the specified bearing.

Parameters
BearingThe bearing from this point along which the new point is located in degrees TRUE
DistanceThe distance from this point which the new point is located in Feet
Returns
A new FsLatLonPoint representing a new point that is the specified distance away from this point in the specified direction

◆ OffsetByMetres()

FsLatLonPoint OffsetByMetres ( double Bearing,
double Distance )
inline

Creates a new point by moving the specified distance along the specified bearing.

Parameters
BearingThe bearing from this point along which the new point is located in degrees TRUE
DistanceThe distance from this point which the new point is located in Metres
Returns
A new FsLatLonPoint representing a new point that is the specified distance away from this point in the specified direction

◆ OffsetByNauticalMiles()

FsLatLonPoint OffsetByNauticalMiles ( double Bearing,
double Distance )
inline

Creates a new point by moving the specified distance along the specified bearing.

Parameters
BearingThe bearing from this point along which the new point is located in degrees TRUE
DistanceThe distance from this point which the new point is located in Nautical Miles
Returns
A new FsLatLonPoint representing a new point that is the specified distance away from this point in the specified direction

◆ ToString() [1/2]

override string ToString ( )
inline

The latitude and longitude represented as a string in the default format of N|S|E|W dd* mm.mmmm'.

Returns
A string representation of the Longitude and Latitude of this point in the default format

◆ ToString() [2/2]

string ToString ( bool HemisphereAsText,
string DetailLevel,
short DecimalPlaces )
inline

The latitude and longitude represented as a string in the specified format.

Parameters
HemisphereAsTextDenote hemisphere using N,S,W or E. If false, west/south is marked as -
DetailLevelSpecifies the detail level. "d" for degrees only, "m" for degrees and minutes, "s" for degrees, minutes and seconds
DecimalPlacesThe number of decimal places to show
Returns
A string representation of the Longitude and Latitude of this point in the specified format