C# Class SobekCM.Core.BriefItem.BriefItem_Coordinate_Polygon

Show file Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Private Properties

Property	Type	Description

Public Methods

Method	Description
Add_Edge_Point ( double Latitude, double Longitude ) : BriefItem_Coordinate_Point	Add a new edge point of interest to this polygon
Add_Edge_Point ( double Latitude, double Longitude, string Label ) : BriefItem_Coordinate_Point	Add a new edge point of interest to this polygon
Add_Edge_Point ( BriefItem_Coordinate_Point newPoint ) : void	Add a new edge point of interest to this polygon
Add_Inner_Point ( double Latitude, double Longitude ) : BriefItem_Coordinate_Point	Add a new inner point of interest to this polygon
Add_Inner_Point ( double Latitude, double Longitude, string Label ) : BriefItem_Coordinate_Point	Add a new inner point of interest to this polygon
Add_Inner_Point ( BriefItem_Coordinate_Point newPoint ) : void	Add a new inner point of interest to this polygon
BriefItem_Coordinate_Polygon ( ) : System	Constructor for a new instance of this BriefItem_Coordinate_Polygon class
Clear_Edge_Points ( ) : void	Clears all the edge points in thie polygon
Recalculate_Bounding_Box ( ) : ReadOnlyCollection	Forces a recalculation of the bounding box for this area and returns the new bounding box Generally, this routing does not need to be called since just adding new edge points to this polygon forces a recalculation of the bounding box the next time it is requested
is_In_Bounding_Box ( double Latitude, double Longitude ) : bool	Checks to see if a point is in the bounding box defined by this polygon
is_In_Bounding_Box ( double Rect_Latitude_A, double Rect_Longitude_A, double Rect_Latitude_B, double Rect_Longitude_B ) : bool	Checks to see if a rectangle overlaps the bounding box defined by this polygon

Method Details

Add_Edge_Point() public method

Add a new edge point of interest to this polygon

public Add_Edge_Point ( double Latitude, double Longitude ) : BriefItem_Coordinate_Point
Latitude	double	Latitude (expressed in decimal notation) for this point
Longitude	double	Longitude (expressed in decimal notation) for this point
return	BriefItem_Coordinate_Point

Add_Edge_Point() public method

Add a new edge point of interest to this polygon

public Add_Edge_Point ( double Latitude, double Longitude, string Label ) : BriefItem_Coordinate_Point
Latitude	double	Latitude (expressed in decimal notation) for this point
Longitude	double	Longitude (expressed in decimal notation) for this point
Label	string	Label to associate with this point
return	BriefItem_Coordinate_Point

Add_Edge_Point() public method

Add a new edge point of interest to this polygon

public Add_Edge_Point ( BriefItem_Coordinate_Point newPoint ) : void
newPoint	BriefItem_Coordinate_Point	Built coordinate point object to add
return	void

Add_Inner_Point() public method

Add a new inner point of interest to this polygon

public Add_Inner_Point ( double Latitude, double Longitude ) : BriefItem_Coordinate_Point
Latitude	double	Latitude (expressed in decimal notation) for this point
Longitude	double	Longitude (expressed in decimal notation) for this point
return	BriefItem_Coordinate_Point

Add_Inner_Point() public method

Add a new inner point of interest to this polygon

public Add_Inner_Point ( double Latitude, double Longitude, string Label ) : BriefItem_Coordinate_Point
Latitude	double	Latitude (expressed in decimal notation) for this point
Longitude	double	Longitude (expressed in decimal notation) for this point
Label	string	Label to associate with this point
return	BriefItem_Coordinate_Point

Add_Inner_Point() public method

Add a new inner point of interest to this polygon

public Add_Inner_Point ( BriefItem_Coordinate_Point newPoint ) : void
newPoint	BriefItem_Coordinate_Point	Built coordinate point object to add
return	void

BriefItem_Coordinate_Polygon() public method

Constructor for a new instance of this BriefItem_Coordinate_Polygon class

public BriefItem_Coordinate_Polygon ( ) : System
return	System

Clear_Edge_Points() public method

Clears all the edge points in thie polygon

public Clear_Edge_Points ( ) : void
return	void

Recalculate_Bounding_Box() public method

Forces a recalculation of the bounding box for this area and returns the new bounding box

Generally, this routing does not need to be called since just adding new edge points to this polygon forces a recalculation of the bounding box the next time it is requested

public Recalculate_Bounding_Box ( ) : ReadOnlyCollection
return	ReadOnlyCollection

is_In_Bounding_Box() public method

Checks to see if a point is in the bounding box defined by this polygon

public is_In_Bounding_Box ( double Latitude, double Longitude ) : bool
Latitude	double	Latitude of the point to check
Longitude	double	Longitude of the point to check
return	bool

is_In_Bounding_Box() public method

Checks to see if a rectangle overlaps the bounding box defined by this polygon

public is_In_Bounding_Box ( double Rect_Latitude_A, double Rect_Longitude_A, double Rect_Latitude_B, double Rect_Longitude_B ) : bool
Rect_Latitude_A	double	Maximum latitude of the rectangle to check
Rect_Longitude_A	double	Maximum longitude of the rectangle to check
Rect_Latitude_B	double	Minimum latitude of the rectangle to check
Rect_Longitude_B	double	Minimum longitude of the rectangle to check
return	bool