Public Member Functions | Private Member Functions | Private Attributes | List of all members
NETGeographicLib::PolygonAreaRhumb Class Reference

#include <PolygonArea.h>

Public Member Functions

void AddEdge (double azi, double s)
 
void AddPoint (double lat, double lon)
 
void Clear ()
 
unsigned Compute (bool reverse, bool sign, [System::Runtime::InteropServices::Out] double% perimeter, [System::Runtime::InteropServices::Out] double% area)
 
 PolygonAreaRhumb (const bool polyline)
 
 PolygonAreaRhumb (Rhumb^ earth, bool polyline)
 
unsigned TestEdge (double azi, double s, bool reverse, bool sign, [System::Runtime::InteropServices::Out] double% perimeter, [System::Runtime::InteropServices::Out] double% area)
 
unsigned TestPoint (double lat, double lon, bool reverse, bool sign, [System::Runtime::InteropServices::Out] double% perimeter, [System::Runtime::InteropServices::Out] double% area)
 
 ~PolygonAreaRhumb ()
 

Private Member Functions

 !PolygonAreaRhumb (void)
 

Private Attributes

GeographicLib::PolygonAreaRhumb * m_pPolygonArea
 

Inspector functions

property double MajorRadius { double get()
 
property double Flattening { double get()
 
void CurrentPoint ([System::Runtime::InteropServices::Out] double% lat, [System::Runtime::InteropServices::Out] double% lon)
 

Detailed Description

Definition at line 385 of file PolygonArea.h.

Constructor & Destructor Documentation

◆ !PolygonAreaRhumb()

PolygonAreaRhumb::!PolygonAreaRhumb ( void  )
private

Definition at line 247 of file dotnet/NETGeographicLib/PolygonArea.cpp.

◆ PolygonAreaRhumb() [1/2]

PolygonAreaRhumb::PolygonAreaRhumb ( Rhumb earth,
bool  polyline 
)

Constructor for PolygonArea.

Parameters
[in]earththe Geodesic object to use for geodesic calculations.
[in]polylineif true that treat the points as defining a polyline instead of a polygon.

Definition at line 257 of file dotnet/NETGeographicLib/PolygonArea.cpp.

◆ PolygonAreaRhumb() [2/2]

PolygonAreaRhumb::PolygonAreaRhumb ( const bool  polyline)

Constructor for PolygonArea that assumes a WGS84 ellipsoid.

Parameters
[in]polylineif true that treat the points as defining a polyline instead of a polygon.

Definition at line 273 of file dotnet/NETGeographicLib/PolygonArea.cpp.

◆ ~PolygonAreaRhumb()

NETGeographicLib::PolygonAreaRhumb::~PolygonAreaRhumb ( )
inline

The destructor calls the finalizer.

Definition at line 415 of file PolygonArea.h.

Member Function Documentation

◆ AddEdge()

void PolygonAreaRhumb::AddEdge ( double  azi,
double  s 
)

Add an edge to the polygon or polyline.

Parameters
[in]aziazimuth at current point (degrees).
[in]sdistance from current point to next point (meters).

This does nothing if no points have been added yet. Use PolygonArea::CurrentPoint to determine the position of the new vertex.

Definition at line 296 of file dotnet/NETGeographicLib/PolygonArea.cpp.

◆ AddPoint()

void PolygonAreaRhumb::AddPoint ( double  lat,
double  lon 
)

Add a point to the polygon or polyline.

Parameters
[in]latthe latitude of the point (degrees).
[in]lonthe longitude of the point (degrees).

lat should be in the range [−90°, 90°].

Definition at line 290 of file dotnet/NETGeographicLib/PolygonArea.cpp.

◆ Clear()

void PolygonAreaRhumb::Clear ( )

Clear PolygonArea, allowing a new polygon to be started.

Definition at line 287 of file dotnet/NETGeographicLib/PolygonArea.cpp.

◆ Compute()

unsigned PolygonAreaRhumb::Compute ( bool  reverse,
bool  sign,
[System::Runtime::InteropServices::Out] double%  perimeter,
[System::Runtime::InteropServices::Out] double%  area 
)

Return the results so far.

Parameters
[in]reverseif true then clockwise (instead of counter-clockwise) traversal counts as a positive area.
[in]signif true then return a signed result for the area if the polygon is traversed in the "wrong" direction instead of returning the area for the rest of the earth.
[out]perimeterthe perimeter of the polygon or length of the polyline (meters).
[out]areathe area of the polygon (meters2); only set if polyline is false in the constructor.
Returns
the number of points.

Definition at line 302 of file dotnet/NETGeographicLib/PolygonArea.cpp.

◆ CurrentPoint()

void PolygonAreaRhumb::CurrentPoint ( [System::Runtime::InteropServices::Out] double%  lat,
[System::Runtime::InteropServices::Out] double%  lon 
)

Report the previous vertex added to the polygon or polyline.

Parameters
[out]latthe latitude of the point (degrees).
[out]lonthe longitude of the point (degrees).

If no points have been added, then NaNs are returned. Otherwise, lon will be in the range [−180°, 180°).

Definition at line 338 of file dotnet/NETGeographicLib/PolygonArea.cpp.

◆ TestEdge()

unsigned PolygonAreaRhumb::TestEdge ( double  azi,
double  s,
bool  reverse,
bool  sign,
[System::Runtime::InteropServices::Out] double%  perimeter,
[System::Runtime::InteropServices::Out] double%  area 
)

Return the results assuming a tentative final test point is added via an azimuth and distance; however, the data for the test point is not saved. This lets you report a running result for the perimeter and area as the user moves the mouse cursor. Ordinary floating point arithmetic is used to accumulate the data for the test point; thus the area and perimeter returned are less accurate than if PolygonArea::AddEdge and PolygonArea::Compute are used.

Parameters
[in]aziazimuth at current point (degrees).
[in]sdistance from current point to final test point (meters).
[in]reverseif true then clockwise (instead of counter-clockwise) traversal counts as a positive area.
[in]signif true then return a signed result for the area if the polygon is traversed in the "wrong" direction instead of returning the area for the rest of the earth.
[out]perimeterthe approximate perimeter of the polygon or length of the polyline (meters).
[out]areathe approximate area of the polygon (meters2); only set if polyline is false in the constructor.
Returns
the number of points.

Definition at line 326 of file dotnet/NETGeographicLib/PolygonArea.cpp.

◆ TestPoint()

unsigned PolygonAreaRhumb::TestPoint ( double  lat,
double  lon,
bool  reverse,
bool  sign,
[System::Runtime::InteropServices::Out] double%  perimeter,
[System::Runtime::InteropServices::Out] double%  area 
)

Return the results assuming a tentative final test point is added; however, the data for the test point is not saved. This lets you report a running result for the perimeter and area as the user moves the mouse cursor. Ordinary floating point arithmetic is used to accumulate the data for the test point; thus the area and perimeter returned are less accurate than if PolygonArea::AddPoint and PolygonArea::Compute are used.

Parameters
[in]latthe latitude of the test point (degrees).
[in]lonthe longitude of the test point (degrees).
[in]reverseif true then clockwise (instead of counter-clockwise) traversal counts as a positive area.
[in]signif true then return a signed result for the area if the polygon is traversed in the "wrong" direction instead of returning the area for the rest of the earth.
[out]perimeterthe approximate perimeter of the polygon or length of the polyline (meters).
[out]areathe approximate area of the polygon (meters2); only set if polyline is false in the constructor.
Returns
the number of points.

lat should be in the range [−90°, 90°].

Definition at line 314 of file dotnet/NETGeographicLib/PolygonArea.cpp.

Member Data Documentation

◆ Flattening

property double NETGeographicLib::PolygonAreaRhumb::Flattening { double get()
Returns
f the flattening of the ellipsoid. This is the value inherited from the Geodesic object used in the constructor.

Definition at line 532 of file PolygonArea.h.

◆ m_pPolygonArea

GeographicLib::PolygonAreaRhumb* NETGeographicLib::PolygonAreaRhumb::m_pPolygonArea
private

Definition at line 389 of file PolygonArea.h.

◆ MajorRadius

property double NETGeographicLib::PolygonAreaRhumb::MajorRadius { double get()
Returns
a the equatorial radius of the ellipsoid (meters). This is the value inherited from the Geodesic object used in the constructor.

Definition at line 526 of file PolygonArea.h.


The documentation for this class was generated from the following files:


gtsam
Author(s):
autogenerated on Sun Dec 22 2024 04:25:01