DotSpatial.Data.Extent - sindizzy/DSW GitHub Wiki

Extent


Summary

Extent works like an envelope but is faster acting, has a minimum memory profile, only works in 2D and has no events.

Methods

Name Description
Method Clone Produces a clone, rather than using this same object.
MethodBlue Constructor This function has 5 overloads.
Method Contains This function has 3 overloads.
MethodBlue CopyFrom Copies the MinX, MaxX, MinY, MaxY values from extent.
Method Equals Allows equality testing for extents that is derived on the extent itself.
MethodBlue ExpandBy This function has 2 overloads.
Method ExpandToInclude This function has 2 overloads.
MethodBlue GetHashCode Spreads the values for the basic X, Y extents across the whole range of int. Repetition will occur, but it should be rare.
Method Intersection Calculates the intersection of this extent and the other extent. A result with a min greater than the max in either direction is considered invalid and represents no intersection.
MethodBlue Intersects This function has 5 overloads.
Method IsEmpty If this is undefined, it will have a min that is larger than the max, or else any value is NaN. This only applies to the X and Z terms. Check HasM or HasZ higher dimensions.
MethodBlue Parse This allows parsing the X and Y values from a string version of the extent as: 'X[-180|180], Y[-90|90]' Where minimum always precedes maximum. The correct M or MZ version of extent will be returned if the string has those values.
Method SetCenter This function has 3 overloads.
MethodBlue ToEnvelope Creates a geometric envelope interface from this
Method ToString Creates a string that shows the extent.
MethodBlue TryExtract Attempts to extract the min and max from one element of text. The element should be formatted like X[1.5, 2.7] using an invariant culture.
Method TryParse This reads the string and attempts to derive values from the text.
MethodBlue TryParseExtremes This method converts the X and Y text into two doubles.
Method Within This function has 2 overloads.

Properties

Name Description
Property HasM Gets or sets whether the M values are used. M values are considered optional,and not mandatory. Unused could mean either bound is NaN for some reason, orelse that the bounds are invalid by the Min being less than the Max.
PropertyBlue HasZ Gets or sets whether the M values are used. M values are considered optional,and not mandatory. Unused could mean either bound is NaN for some reason, orelse that the bounds are invalid by the Min being less than the Max.
Property Height Gets MaxY - MinY. Setting this will update MinY, keeping MaxY the same. (Pinned at top left corner).
PropertyBlue MaxX Max X
Property MaxY Max Y
PropertyBlue MinX Min X
Property MinY Min Y
PropertyBlue Width Gets MaxX - MinX. Setting this will update MaxX, keeping MinX the same. (Pinned at top left corner).
Property X Gets MinX. Setting this will shift both MinX and MaxX, keeping the width the same.
PropertyBlue Y Gets MaxY. Setting this will shift both MinY and MaxY, keeping the height the same.
⚠️ **GitHub.com Fallback** ⚠️