FsLatLonCircle Struct Reference

Represents an circular area in FS defined with a centre Lat, Lon point and a radius. More...

Public Member Functions
	FsLatLonCircle (FsLatLonPoint Centre, double RadiusInNauticalMiles)
	Constructs a new FsLatLonCircle from a central FSLatLonPoint and a Radius in Nautical Miles. To specify the radius in Feet or Metres use one of the static factory methods (FsLatLonCircle.FromFeet or FsLatLonCircle.FromMetres).
bool	ContainsPoint (FsLatLonPoint Point)
	Calculates whether or not the given point in contained in this circle.

Static Public Member Functions
static FsLatLonCircle	FromFeet (FsLatLonPoint Centre, double RadiusInFeet)
	Creates a new circular area from a central FsLatLonPoint and a Radius in Feet.
static FsLatLonCircle	FromMetres (FsLatLonPoint Centre, double RadiusInMetres)
	Creates a new circular area from a central FsLatLonPoint and a Radius in Metres.
static FsLatLonCircle	FromNauticalMiles (FsLatLonPoint Centre, double RadiusInNauticalMiles)
	Creates a new circular area from a central FsLatLonPoint and a Radius in Nautical Miles.

Properties
FsLatLonPoint	Centre [get, set]
	A FsLatLonPoint representing the centre of the circle.
double	RadiusMetres [get]
	The Radius of the circle in Metres.
double	RadiusFeet [get, set]
	The Radius of the circle in Feet.
double	RadiusNauticalMiles [get]
	The Radius of the circle in Nautical Miles.

Detailed Description

Represents an circular area in FS defined with a centre Lat, Lon point and a radius.

Constructor & Destructor Documentation

FsLatLonCircle()

FsLatLonCircle ( FsLatLonPoint Centre, double RadiusInNauticalMiles )

inline

Constructs a new FsLatLonCircle from a central FSLatLonPoint and a Radius in Nautical Miles. To specify the radius in Feet or Metres use one of the static factory methods (FsLatLonCircle.FromFeet or FsLatLonCircle.FromMetres).

Parameters

Centre	An FsLatLonPoint representing the centre of the circular area
RadiusInNauticalMiles	The Radius of the circle in nautical miles

Member Function Documentation

ContainsPoint()

bool ContainsPoint ( FsLatLonPoint Point )

inline

Calculates whether or not the given point in contained in this circle.

Parameters

Point

The point to test

Returns

True if the given point is contained within this circle.

FromFeet()

static FsLatLonCircle FromFeet ( FsLatLonPoint Centre, double RadiusInFeet )

inlinestatic

Creates a new circular area from a central FsLatLonPoint and a Radius in Feet.

Parameters

Centre	An FsLatLonPoint representing the centre of the circular area
RadiusInFeet	The Radius of the circle in Feet

Returns

The FsLatLonCircle at the specified location with the specified radius

FromMetres()

static FsLatLonCircle FromMetres ( FsLatLonPoint Centre, double RadiusInMetres )

inlinestatic

Creates a new circular area from a central FsLatLonPoint and a Radius in Metres.

Parameters

Centre	An FsLatLonPoint representing the centre of the circular area
RadiusInMetres	The Radius of the circle in Metres

Returns

The FsLatLonCircle at the specified location with the specified radius

FromNauticalMiles()

static FsLatLonCircle FromNauticalMiles ( FsLatLonPoint Centre, double RadiusInNauticalMiles )

inlinestatic

Creates a new circular area from a central FsLatLonPoint and a Radius in Nautical Miles.

Parameters

Centre	An FsLatLonPoint representing the centre of the circular area
RadiusInNauticalMiles	The Radius of the circle in Nautical Miles

Returns

The FsLatLonCircle at the specified location with the specified radius