thinkgeo.mapsuite.core.lineshape
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.core.lineshape [2015/08/20 03:08] 127.0.0.1 external edit |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.Core.LineShape ====== | ||
| - | |||
| - | |||
| - | |||
| - | <!-- Class --> | ||
| - | This class represents a LineShape, which is defined as a single line with two or more points. | ||
| - | === Remarks === | ||
| - | The LineShape is one of the more commonly used shapes. Typically it is used for representing roads in GIS data files. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | **[[ThinkGeo.MapSuite.Core.BaseShape]] | ||
| - | ***[[ThinkGeo.MapSuite.Core.LineBaseShape]] | ||
| - | ****[[ThinkGeo.MapSuite.Core.LineShape]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#LineShape()|LineShape]] | | | This constructor creates the LineShape. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#LineShape(IEnumerable<Vertex>)|LineShape]] | IEnumerable<[[ThinkGeo.MapSuite.Core.Vertex|Vertex]]> | | This constructor creates the LineShape. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#LineShape(String)|LineShape]] | String | | This constructor creates the LineShape. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#LineShape(Byte［］)|LineShape]] | Byte［］ | | This constructor creates the LineShape. | | ||
| - | |||
| - | ==== Protected Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Buffer(Double, Int32, BufferCapType, GeographyUnit, DistanceUnit)|Buffer]] | Double, Int32, [[ThinkGeo.MapSuite.Core.BufferCapType|BufferCapType]], [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]], [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method computes the area containing all of the points within a given distance from this shape. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Buffer(Double, GeographyUnit, DistanceUnit)|Buffer]] | Double, [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]], [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method computes the area containing all of the points within a given distance from this shape. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Buffer(Double, Int32, GeographyUnit, DistanceUnit)|Buffer]] | Double, Int32, [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]], [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method computes the area containing all of the points within a given distance from this shape. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#CloneDeep()|CloneDeep]] | | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns a complete copy of the shape without any references in common. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Contains(BaseShape)|Contains]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns if the targetShape lies within the interior of the current shape. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Contains(Feature)|Contains]] | [[ThinkGeo.MapSuite.Core.Feature|Feature]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns if the targetFeature lies within the interior of the current shape. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ConvexHull()|ConvexHull]] | | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]] | This method returns the convex hull of the shape defined as the smallest convex ring that contains all the points in the shape. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#CreateShapeFromGeoJson(String)|CreateShapeFromGeoJson]] | String | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#CreateShapeFromWellKnownData(String)|CreateShapeFromWellKnownData]] | String | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method creates a BaseShape from a string of well-known text. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#CreateShapeFromWellKnownData(Byte［］)|CreateShapeFromWellKnownData]] | Byte［］ | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method creates a BaseShape from a string of well-known binary. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Crosses(Feature)|Crosses]] | [[ThinkGeo.MapSuite.Core.Feature|Feature]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns if the current shape and the targetFeature share some but not all interior points. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Crosses(BaseShape)|Crosses]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns if the current shape and the targetShape share some but not all interior points. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetAccurateLength(String, DistanceUnit, DistanceCalculationMode)|GetAccurateLength]] | String, [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]], [[ThinkGeo.MapSuite.Core.DistanceCalculationMode|DistanceCalculationMode]] | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetAccurateLength(Int32, DistanceUnit, DistanceCalculationMode)|GetAccurateLength]] | Int32, [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]], [[ThinkGeo.MapSuite.Core.DistanceCalculationMode|DistanceCalculationMode]] | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetBoundingBox()|GetBoundingBox]] | | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method calculates the smallest RectangleShape that encompasses the entire geometry. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetCenterPoint()|GetCenterPoint]] | | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns the center point of the current shape's bounding box. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetClosestPointTo(Feature, GeographyUnit)|GetClosestPointTo]] | [[ThinkGeo.MapSuite.Core.Feature|Feature]], [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns the point of the current shape that is closest to the target feature. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetClosestPointTo(BaseShape, GeographyUnit)|GetClosestPointTo]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]], [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns the point of the current shape that is closest to the target shape. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetCrossing(BaseShape)|GetCrossing]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns the crossing points between the current shape and the passed-in target shape. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetDistanceTo(BaseShape, GeographyUnit, DistanceUnit)|GetDistanceTo]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]], [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]], [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method computes the distance between the current shape and the targetShape. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetDistanceTo(Feature, GeographyUnit, DistanceUnit)|GetDistanceTo]] | [[ThinkGeo.MapSuite.Core.Feature|Feature]], [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]], [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method computes the distance between the current shape and the targetFeature. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeature(IDictionary<String, String>)|GetFeature]] | IDictionary<String, String> | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | Get a corresponding feature which has the same Id and BaseShape as the current shape. Additionally, pass the specified columnValues into the returned feature. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeature()|GetFeature]] | | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | Get a corresponding feature which has the same Id and BaseShape as the current shape. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetGeoJson()|GetGeoJson]] | | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetIntersection(Feature)|GetIntersection]] | [[ThinkGeo.MapSuite.Core.Feature|Feature]] | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetIntersection(AreaBaseShape)|GetIntersection]] | [[ThinkGeo.MapSuite.Core.AreaBaseShape|AreaBaseShape]] | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetLength(GeographyUnit, DistanceUnit)|GetLength]] | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]], [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]] | This method returns the length of the line shape. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetLineOnALine(StartingPoint, PointShape)|GetLineOnALine]] | [[ThinkGeo.MapSuite.Core.StartingPoint|StartingPoint]], [[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | | This method returns a BaseLineShape, based on a starting position and other factors. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetLineOnALine(StartingPoint, Double, Double, GeographyUnit, DistanceUnit)|GetLineOnALine]] | [[ThinkGeo.MapSuite.Core.StartingPoint|StartingPoint]], Double, Double, [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]], [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | | This method returns a BaseLineShape, based on a starting position and other factors. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetLineOnALine(StartingPoint, Single)|GetLineOnALine]] | [[ThinkGeo.MapSuite.Core.StartingPoint|StartingPoint]], Single | | This method returns a BaseLineShape, based on a starting position and other factors. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetLineOnALine(StartingPoint, Single, Single)|GetLineOnALine]] | [[ThinkGeo.MapSuite.Core.StartingPoint|StartingPoint]], Single, Single | | This method returns a BaseLineShape, based on a starting position and other factors. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetLineOnALine(PointShape, PointShape)|GetLineOnALine]] | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], [[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | | This method returns a BaseLineShape, based on a starting position and other factors. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetPointOnALine(StartingPoint, Single)|GetPointOnALine]] | [[ThinkGeo.MapSuite.Core.StartingPoint|StartingPoint]], Single | | This method returns a PointShape on the line, based on a percentage of the length of the line from the first or last vertex defined in the startingPoint parameter. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetPointOnALine(StartingPoint, Double, GeographyUnit, DistanceUnit)|GetPointOnALine]] | [[ThinkGeo.MapSuite.Core.StartingPoint|StartingPoint]], Double, [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]], [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | | This method returns a PointShape on the line, based on a distance on the line from the first or last vertex defined in the startingPoint parameter. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetShortestLineTo(Feature, GeographyUnit)|GetShortestLineTo]] | [[ThinkGeo.MapSuite.Core.Feature|Feature]], [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns the shortest LineShape between this shape and the targetFeature. parameter. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetShortestLineTo(BaseShape, GeographyUnit)|GetShortestLineTo]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]], [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns the shortest LineShape between this shape and the targetShape parameter. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetWellKnownBinary()|GetWellKnownBinary]] | | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns a byte array that represents the shape in well-known binary. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetWellKnownBinary(WkbByteOrder)|GetWellKnownBinary]] | [[ThinkGeo.MapSuite.Core.WkbByteOrder|WkbByteOrder]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns a byte array that represents the shape in well-known binary. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetWellKnownBinary(RingOrder)|GetWellKnownBinary]] | [[ThinkGeo.MapSuite.Core.RingOrder|RingOrder]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetWellKnownBinary(RingOrder, WkbByteOrder)|GetWellKnownBinary]] | [[ThinkGeo.MapSuite.Core.RingOrder|RingOrder]], [[ThinkGeo.MapSuite.Core.WkbByteOrder|WkbByteOrder]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetWellKnownText()|GetWellKnownText]] | | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns the well-known text representation of this shape. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetWellKnownText(RingOrder)|GetWellKnownText]] | [[ThinkGeo.MapSuite.Core.RingOrder|RingOrder]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns the well-known text representation of this shape. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetWellKnownType()|GetWellKnownType]] | | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns the well-known type for the shape. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Intersects(Feature)|Intersects]] | [[ThinkGeo.MapSuite.Core.Feature|Feature]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns if the current shape and the targetFeature have at least one point in common. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Intersects(BaseShape)|Intersects]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns if the current shape and the targetShape have at least one point in common. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#IsClosed()|IsClosed]] | | | This method determines whether the line is closed, meaning that the last point and first point are the same. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#IsDisjointed(Feature)|IsDisjointed]] | [[ThinkGeo.MapSuite.Core.Feature|Feature]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns if the current shape and the targetFeature have no points in common. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#IsDisjointed(BaseShape)|IsDisjointed]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns if the current shape and the targetShape have no points in common. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#IsTopologicallyEqual(Feature)|IsTopologicallyEqual]] | [[ThinkGeo.MapSuite.Core.Feature|Feature]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns if the current shape and the targetFeature are topologically equal. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#IsTopologicallyEqual(BaseShape)|IsTopologicallyEqual]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns if the current shape and the targetShape are topologically equal. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#IsWithin(BaseShape)|IsWithin]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns if the current shape lies within the interior of the targetShape. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#IsWithin(Feature)|IsWithin]] | [[ThinkGeo.MapSuite.Core.Feature|Feature]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns if the current shape lies within the interior of the targetFeature. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#LoadFromWellKnownData(String)|LoadFromWellKnownData]] | String | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method hydrates the current shape with its data from well-known text. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#LoadFromWellKnownData(Byte［］)|LoadFromWellKnownData]] | Byte［］ | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method hydrates the current shape with its data from well-known binary. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Overlaps(Feature)|Overlaps]] | [[ThinkGeo.MapSuite.Core.Feature|Feature]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns if the current shape and the targetFeature share some but not all points in common. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Overlaps(BaseShape)|Overlaps]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns if the current shape and the targetShape share some but not all points in common. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Register(PointShape, PointShape, DistanceUnit, GeographyUnit)|Register]] | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]], [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns a BaseShape which has been registered from its original coordinate system to another based on two anchor PointShapes. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Register(Feature, Feature, DistanceUnit, GeographyUnit)|Register]] | [[ThinkGeo.MapSuite.Core.Feature|Feature]], [[ThinkGeo.MapSuite.Core.Feature|Feature]], [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]], [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns a BaseShape which has been registered from its original coordinate system to another based on two anchor PointShapes. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#RemoveVertex(Vertex, LineShape)|RemoveVertex]] | [[ThinkGeo.MapSuite.Core.Vertex|Vertex]], [[ThinkGeo.MapSuite.Core.LineShape|LineShape]] | | This method removes the selected vertex from line shape. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RemoveVertex(Vertex)|RemoveVertex]] | [[ThinkGeo.MapSuite.Core.Vertex|Vertex]] | | This method removes the selected vertex from line shape. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ReversePoints()|ReversePoints]] | | | This method reverses the order of the points in the line. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#Rotate(Feature, PointShape, Single)|Rotate]] | [[ThinkGeo.MapSuite.Core.Feature|Feature]], [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], Single | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns a feature rotated by a number of degrees based on a pivot point. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Rotate(PointShape, Single)|Rotate]] | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], Single | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method rotates a shape a number of degrees based on a pivot point. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#Rotate(BaseShape, PointShape, Single)|Rotate]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]], [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], Single | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns a shape rotated by a number of degrees based on a pivot point. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ScaleDown(Double)|ScaleDown]] | Double | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]] | This method decreases the size of the LineShape by the percentage given in the percentage parameter. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#ScaleDown(LineBaseShape, Double)|ScaleDown]] | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]], Double | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]] | This method returns a new shape that is decreases by the percentage given in the percentage parameter. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#ScaleDown(Feature, Double)|ScaleDown]] | [[ThinkGeo.MapSuite.Core.Feature|Feature]], Double | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]] | This method returns a new feature that is decreases by the percentage given in the percentage parameter. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ScaleTo(Double)|ScaleTo]] | Double | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method increases or decreases the size of the shape by the specified scale factor given in the parameter. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#ScaleTo(BaseShape, Double)|ScaleTo]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]], Double | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method increases or decreases the size of the shape by the specified scale factor given in the parameter. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#ScaleUp(Feature, Double)|ScaleUp]] | [[ThinkGeo.MapSuite.Core.Feature|Feature]], Double | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]] | This method returns a new feature that is increased by the percentage given in the percentage parameter. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ScaleUp(Double)|ScaleUp]] | Double | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]] | This method increases the size of the LineShape by the percentage given in the percentage parameter. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#ScaleUp(LineBaseShape, Double)|ScaleUp]] | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]], Double | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]] | This method returns a new shape that is increased by the percentage given in the percentage parameter. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#Simplify(LineBaseShape, Double, SimplificationType)|Simplify]] | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]], Double, [[ThinkGeo.MapSuite.Core.SimplificationType|SimplificationType]] | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]] | Simplify the LineBaseShape to MultilineShape depends on distance tolerance and different SimplificationType. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#Simplify(LineBaseShape, GeographyUnit, Double, DistanceUnit, SimplificationType)|Simplify]] | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]], [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]], Double, [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]], [[ThinkGeo.MapSuite.Core.SimplificationType|SimplificationType]] | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]] | Simplify the LineBaseShape to MultilineShape depends on distance tolerance and different SimplificationType. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Simplify(GeographyUnit, Double, DistanceUnit, SimplificationType)|Simplify]] | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]], Double, [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]], [[ThinkGeo.MapSuite.Core.SimplificationType|SimplificationType]] | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]] | Simplify the LineBaseShape to MultilineShape depends on distance tolerance and different SimplificationType. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Simplify(Double, SimplificationType)|Simplify]] | Double, [[ThinkGeo.MapSuite.Core.SimplificationType|SimplificationType]] | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]] | Simplify the LineBaseShape to MultilineShape depends on distance tolerance and different SimplificationType. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToPolygonShape()|ToPolygonShape]] | | | This method generates a PolygonShape based the vertexes of the line. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Touches(Feature)|Touches]] | [[ThinkGeo.MapSuite.Core.Feature|Feature]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns of the current shape and the targetFeature have at least one boundary point in common, but no interior points. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Touches(BaseShape)|Touches]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns if the current shape and the targetShape have at least one boundary point in common, but no interior points. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#TranslateByDegree(Double, Double)|TranslateByDegree]] | Double, Double | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method moves a base shape from one location to another based on a distance and a direction in degrees. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#TranslateByDegree(Double, Double, GeographyUnit, DistanceUnit)|TranslateByDegree]] | Double, Double, [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]], [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method moves a base shape from one location to another based on a distance and a direction in degrees. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#TranslateByDegree(Feature, Double, Double, GeographyUnit, DistanceUnit)|TranslateByDegree]] | [[ThinkGeo.MapSuite.Core.Feature|Feature]], Double, Double, [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]], [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns a feature repositioned from one location to another, based on a distance and a direction in degrees. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#TranslateByDegree(BaseShape, Double, Double, GeographyUnit, DistanceUnit)|TranslateByDegree]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]], Double, Double, [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]], [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns a shape repositioned from one location to another based on a distance and a direction in degrees. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#TranslateByOffset(Double, Double, GeographyUnit, DistanceUnit)|TranslateByOffset]] | Double, Double, [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]], [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method moves a base shape from one location to another based on an X and Y offset distance. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#TranslateByOffset(Double, Double)|TranslateByOffset]] | Double, Double | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method moves a base shape from one location to another based on an X and Y offset distance. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#TranslateByOffset(Feature, Double, Double, GeographyUnit, DistanceUnit)|TranslateByOffset]] | [[ThinkGeo.MapSuite.Core.Feature|Feature]], Double, Double, [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]], [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns a feature repositioned from one location to another based on an X and Y offset distance. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#TranslateByOffset(BaseShape, Double, Double, GeographyUnit, DistanceUnit)|TranslateByOffset]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]], Double, Double, [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]], [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns a shape repositioned from one location to another based on an X and Y offset distance. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Union(Feature)|Union]] | [[ThinkGeo.MapSuite.Core.Feature|Feature]] | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#Union(IEnumerable<Feature>)|Union]] | IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#Union(IEnumerable<LineBaseShape>)|Union]] | IEnumerable<[[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]]> | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]] | Calculates a new geometry that contains all the points in this LineBaseShape and input LineBaseShape set. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Union(LineBaseShape)|Union]] | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]] | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]] | Calculates a new geometry that contains all the points in this LineBaseShape and input LineBaseShape | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Validate(ShapeValidationMode)|Validate]] | [[ThinkGeo.MapSuite.Core.ShapeValidationMode|ShapeValidationMode]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns a ShapeValidationResult based on a series of tests. | | ||
| - | |||
| - | ==== Protected Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#BufferCore(Double, Int32, BufferCapType, GeographyUnit, DistanceUnit)|BufferCore]] | Double, Int32, [[ThinkGeo.MapSuite.Core.BufferCapType|BufferCapType]], [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]], [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method computes the area containing all of the points within a given distance from this shape. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#CloneDeepCore()|CloneDeepCore]] | | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]](overriden) | This method returns a complete copy of the shape without any references in common. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#ContainsCore(BaseShape)|ContainsCore]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns if the targetShape lies within the interior of the current shape. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#ConvexHullCore()|ConvexHullCore]] | | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]] | This method returns the convex hull of the shape defined as the smallest convex ring that contains all the points in the shape. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#CrossesCore(BaseShape)|CrossesCore]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns if the current shape and the targetShape share some but not all interior points. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetAccurateLengthCore(String, DistanceUnit, DistanceCalculationMode)|GetAccurateLengthCore]] | String, [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]], [[ThinkGeo.MapSuite.Core.DistanceCalculationMode|DistanceCalculationMode]] | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]] | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetBoundingBoxCore()|GetBoundingBoxCore]] | | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]](overriden) | This method calculates the smallest RectangleShape that encompasses the entire geometry. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetCenterPointCore()|GetCenterPointCore]] | | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]](overriden) | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetClosestPointToCore(BaseShape, GeographyUnit)|GetClosestPointToCore]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]], [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]](overriden) | This method returns the point of the current shape that is closest to the target shape. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetCrossingCore(BaseShape)|GetCrossingCore]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]](overriden) | This method returns the crossing points between the current shape and the passed-in target shape. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetDistanceToCore(BaseShape, GeographyUnit, DistanceUnit)|GetDistanceToCore]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]], [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]], [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]](overriden) | This method computes the distance between the current shape and the targetShape. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetGeoJsonCore()|GetGeoJsonCore]] | | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetIntersectionCore(AreaBaseShape)|GetIntersectionCore]] | [[ThinkGeo.MapSuite.Core.AreaBaseShape|AreaBaseShape]] | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]] | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetLengthCore(GeographyUnit, DistanceUnit)|GetLengthCore]] | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]], [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]](overriden) | This method returns the length of the LineShape. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetLineOnALineCore(StartingPoint, Double, Double, GeographyUnit, DistanceUnit)|GetLineOnALineCore]] | [[ThinkGeo.MapSuite.Core.StartingPoint|StartingPoint]], Double, Double, [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]], [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | | This method returns a BaseLineShape, based on a starting position and other factors. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetPointOnALineCore(StartingPoint, Double, GeographyUnit, DistanceUnit)|GetPointOnALineCore]] | [[ThinkGeo.MapSuite.Core.StartingPoint|StartingPoint]], Double, [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]], [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | | This method returns a PointShape on the line, based on a distance on the line from the first or last vertex defined in the startingPoint parameter. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetShortestLineToCore(BaseShape, GeographyUnit)|GetShortestLineToCore]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]], [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns the shortest LineShape between this shape and the targetShape parameter. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetWellKnownBinaryCore(RingOrder, WkbByteOrder)|GetWellKnownBinaryCore]] | [[ThinkGeo.MapSuite.Core.RingOrder|RingOrder]], [[ThinkGeo.MapSuite.Core.WkbByteOrder|WkbByteOrder]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns a byte array that represents the shape in well-known binary. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetWellKnownTextCore(RingOrder)|GetWellKnownTextCore]] | [[ThinkGeo.MapSuite.Core.RingOrder|RingOrder]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]](overriden) | This method returns the well-known text representation of this shape. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetWellKnownTypeCore()|GetWellKnownTypeCore]] | | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]](overriden) | This method returns the well-known type for the shape. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#IntersectsCore(BaseShape)|IntersectsCore]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns if the current shape and the targetShape have at least one point in common. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#IsClosedCore()|IsClosedCore]] | | | This method determines whether the line is closed, meaning that the last point and first point are the same. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#IsDisjointedCore(BaseShape)|IsDisjointedCore]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns if the current shape and the targetShape have no points in common. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#IsTopologicallyEqualCore(BaseShape)|IsTopologicallyEqualCore]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns if the current shape and the targetShape are topologically equal. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#IsWithinCore(BaseShape)|IsWithinCore]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns if the current shape lies within the interior of the targetShape. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#LoadFromWellKnownDataCore(Byte［］)|LoadFromWellKnownDataCore]] | Byte［］ | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]](overriden) | This method hydrates the current shape with its data from well-known binary. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#LoadFromWellKnownDataCore(String)|LoadFromWellKnownDataCore]] | String | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]](overriden) | This method hydrates the current shape with its data from well-known text. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OverlapsCore(BaseShape)|OverlapsCore]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns if the current shape and the targetShape share some but not all points in common. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#RegisterCore(PointShape, PointShape, DistanceUnit, GeographyUnit)|RegisterCore]] | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]], [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]](overriden) | This method returns a BaseShape which has been registered from its original coordinate system to another, based on two anchor PointShapes. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#ReversePointsCore()|ReversePointsCore]] | | | This method reverses the order of the points in the line. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#RotateCore(PointShape, Single)|RotateCore]] | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], Single | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]](overriden) | This method rotates the shape a number of degrees based on a pivot point. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#ScaleDownCore(Double)|ScaleDownCore]] | Double | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]](overriden) | This method decreases the size of the LineShape by the percentage given in the percentage parameter. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#ScaleToCore(Double)|ScaleToCore]] | Double | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method increases or decreases the size of the shape by the specified scale factor given in the parameter. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#ScaleUpCore(Double)|ScaleUpCore]] | Double | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]](overriden) | This method increases the size of the LineShape by the percentage given in the percentage parameter. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#SimplifyCore(Double, SimplificationType)|SimplifyCore]] | Double, [[ThinkGeo.MapSuite.Core.SimplificationType|SimplificationType]] | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]] | Simplify the LineBaseShape to MultilineShape depends on distance tolerance and different SimplificationType. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#TouchesCore(BaseShape)|TouchesCore]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | This method returns if the current shape and the targetShape have at least one boundary point in common, but no interior points. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#TranslateByDegreeCore(Double, Double, GeographyUnit, DistanceUnit)|TranslateByDegreeCore]] | Double, Double, [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]], [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]](overriden) | This method moves the base shape from one location to another based on a distance and a direction in degrees. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#TranslateByOffsetCore(Double, Double, GeographyUnit, DistanceUnit)|TranslateByOffsetCore]] | Double, Double, [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]], [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]](overriden) | This method moves the base shape from one location to another based on an X and Y offset distance. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#UnionCore(IEnumerable<LineBaseShape>)|UnionCore]] | IEnumerable<[[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]]> | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]] | The protected virtual method used by "Union" that you can overwrite to implement your own logic. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#ValidateCore(ShapeValidationMode)|ValidateCore]] | [[ThinkGeo.MapSuite.Core.ShapeValidationMode|ShapeValidationMode]] | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]](overriden) | This method returns a ShapeValidationResult based on a series of tests. | | ||
| - | |||
| - | ==== Public Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#CanRotate|CanRotate]] | Boolean | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]](overriden) | This property specifies whether the shape can be rotated. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Id|Id]] | String | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | The id of the shape. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Tag|Tag]] | Object | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | The tag of the shape. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Vertices|Vertices]] | Collection<[[ThinkGeo.MapSuite.Core.Vertex|Vertex]]> | | This property is the collection of points that make up the LineShape. | | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Events ==== | ||
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ===== Public Constructors ===== | ||
| - | ==== LineShape() ==== | ||
| - | This constructor creates the LineShape. | ||
| - | === Overloads === | ||
| - | This overload creates the LineShape without any points. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== LineShape(IEnumerable<Vertex>) ==== | ||
| - | This constructor creates the LineShape. | ||
| - | === Overloads === | ||
| - | This overload creates the LineShape with a vertex collection. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | points | IEnumerable<[[ThinkGeo.MapSuite.Core.Vertex|Vertex]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.Vertex} --> | | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== LineShape(String) ==== | ||
| - | This constructor creates the LineShape. | ||
| - | === Overloads === | ||
| - | This constructor allows you to build the shape from well-known text. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | wellKnownText | String<!-- System.String --> | This parameter is the well-known text used to build the shape. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== LineShape(Byte［］) ==== | ||
| - | This constructor creates the LineShape. | ||
| - | === Overloads === | ||
| - | This constructor allows you to build the shape from well-known binary. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | wellKnownBinary | Byte［］<!-- System.Byte[[]] --> | This parameter is the well-known binary used to build the shape. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ===== Protected Constructors ===== | ||
| - | ===== Public Methods ===== | ||
| - | ==== Buffer(Double, Int32, BufferCapType, GeographyUnit, DistanceUnit) ==== | ||
| - | This method computes the area containing all of the points within a given distance from this shape. | ||
| - | === Remarks === | ||
| - | This method computes the area containing all of the points within a given distance from this shape. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.MultipolygonShape|MultipolygonShape]]<!-- ThinkGeo.MapSuite.Core.MultipolygonShape --> | The return type is a MultiPolygonShape that represents all of the points within a given distance from the shape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | distance | Double<!-- System.Double --> | The distance is the number of units to buffer the current shape. The distance unit will be the one specified in the distanceUnit parameter. | | ||
| - | | quadrantSegments | Int32<!-- System.Int32 --> | The quadrant segments are the number of points in each quarter circle. A good default is 8, but if you want smoother edges you can increase this number. The valid range for this number is from 3 to 100. | | ||
| - | | bufferCapType | [[ThinkGeo.MapSuite.Core.BufferCapType|BufferCapType]]<!-- ThinkGeo.MapSuite.Core.BufferCapType --> | The bufferCapType determines how the caps of the buffered object look. They range from rounded to squared off. | | ||
| - | | shapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | This is the geographic unit of the shape you are performing the operation on. | | ||
| - | | distanceUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | This is the distance unit you would like to use as the distance. For example, if you select miles as your distanceUnit, then the distance will be calculated in miles for the operation. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Buffer(Double, GeographyUnit, DistanceUnit) ==== | ||
| - | This method computes the area containing all of the points within a given distance from this shape. | ||
| - | === Remarks === | ||
| - | This method computes the area containing all of the points within a given distance from this shape. In this case, you will be using the rounded RoundedBufferCapStyle and the default 8 quadrant segments. The distance unit is determined by the distanceUnit argument. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.MultipolygonShape|MultipolygonShape]]<!-- ThinkGeo.MapSuite.Core.MultipolygonShape --> | The return type is a MultiPolygonShape that represents all of the points within a given distance from the shape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | distance | Double<!-- System.Double --> | The distance is the number of units to buffer the current shape. The distance unit will be the one specified in the distanceUnit parameter. | | ||
| - | | shapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | This is the geographic unit of the shape you are performing the operation on. | | ||
| - | | distanceUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | This is the distance unit you would like to use as the distance. For example, if you select miles as your distanceUnit, then the distance will be calculated in miles for the operation. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Buffer(Double, Int32, GeographyUnit, DistanceUnit) ==== | ||
| - | This method computes the area containing all of the points within a given distance from this shape. | ||
| - | === Remarks === | ||
| - | This method computes the area containing all of the points within a given distance from this shape. In this case, you will be using the rounded RoundedBufferCapStyle. The distance unit is determined by the distanceUnit argument. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.MultipolygonShape|MultipolygonShape]]<!-- ThinkGeo.MapSuite.Core.MultipolygonShape --> | The return type is a MultiPolygonShape that represents all of the points within a given distance from the shape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | distance | Double<!-- System.Double --> | The distance is the number of units to buffer the current shape. The distance unit will be the one specified in the distanceUnit parameter. | | ||
| - | | quadrantSegments | Int32<!-- System.Int32 --> | The quadrant segments are the number of points in each quarter circle. A good default is 8, but if you want smoother edges you can increase this number. The valid range for this number is from 3 to 100. | | ||
| - | | shapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | This is the geographic unit of the shape you are performing the operation on. | | ||
| - | | distanceUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | This is the distance unit you would like to use as the distance. For example, if you select miles as your distanceUnit, then the distance will be calculated in miles for the operation. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== CloneDeep() ==== | ||
| - | This method returns a complete copy of the shape without any references in common. | ||
| - | === Remarks === | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | This method returns a complete copy of the shape without any references in common. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Contains(BaseShape) ==== | ||
| - | This method returns if the targetShape lies within the interior of the current shape. | ||
| - | === Remarks === | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | This method returns if the targetShape lies within the interior of the current shape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | The shape you wish to compare the current one to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Contains(Feature) ==== | ||
| - | This method returns if the targetFeature lies within the interior of the current shape. | ||
| - | === Remarks === | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | This method returns if the targetFeature lies within the interior of the current shape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetFeature | [[ThinkGeo.MapSuite.Core.Feature|Feature]]<!-- ThinkGeo.MapSuite.Core.Feature --> | The targetFeature that contains a shape you wish to compare the current one to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ConvexHull() ==== | ||
| - | This method returns the convex hull of the shape defined as the smallest convex ring that contains all the points in the shape. | ||
| - | === Remarks === | ||
| - | This method is useful when you want to create a perimeter around the shape. For example if you had a MultiPolygon which represented buildings in a campus you could easily get the convex hull of the buildings and determine the perimeter of all of the buildings together. This also works with MultiPoint shapes where each point may represent a certain type of person you are doing statistics on. With convex hull you can get an idea of the regions those points are located in. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method we reserve the right to add events and other logic to pre or post process data returned by the Core version of the method. In this way we leave our framework open on our end but also allow you the developer to extend our logic to your needs. If you have questions about this please contact support as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.RingShape|RingShape]]<!-- ThinkGeo.MapSuite.Core.RingShape --> | This method returns a RingShape defined as the smallest convex ring that contains all the points in the shape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== CreateShapeFromGeoJson(String) ==== | ||
| - | <!-- static --> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | geoJson | String<!-- System.String --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== CreateShapeFromWellKnownData(String) ==== | ||
| - | <!-- static --> | ||
| - | This method creates a BaseShape from a string of well-known text. | ||
| - | === Remarks === | ||
| - | This method creates a BaseShape from a string of well-known text. Well-known text allows you to describe geometries as a string of text. Well-known text is useful when you want to save a geometry in a format such as a text file, or when you simply want to cut and paste the text between other applications. An alternative to well-known text is well-known binary, which is a binary representation of a geometry object. We have methods that work with well-known binary as well. Below are some samples of what well-known text might look like for various kinds of geometries. | ||
| - | |||
| - | POINT(5 17) | ||
| - | |||
| - | LINESTRING(4 5,10 50,25 80) | ||
| - | |||
| - | POLYGON((2 2,6 2,6 6,2 6,2 2),(3 3,4 3,4 4,3 4,3 3)) | ||
| - | |||
| - | MULTIPOINT(3.7 9.7,4.9 11.6) | ||
| - | |||
| - | MULTILINESTRING((4 5,11 51,21 26),(-4 -7,-9 -7,-14 -3)) | ||
| - | |||
| - | MULTIPOLYGON(((2 2,6 2,6 6,2 6,2 2),(3 3,4 3,4 4,3 4,3 3)),((4 4,7 3,7 5,4 4))) | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | The return type is a higher level shape constructed from the well-known text you passed into the method. Though the object is a higher level shape, such as a PolygonShape or MultiPointShape, you will need to cast it to that shape in order to use its unique properties. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | wellKnownText | String<!-- System.String --> | A string representing the geometry in well-known text format. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== CreateShapeFromWellKnownData(Byte［］) ==== | ||
| - | <!-- static --> | ||
| - | This method creates a BaseShape from a string of well-known binary. | ||
| - | === Remarks === | ||
| - | This method creates a BaseShape from a string of well-known binary. Well-known binary allows you to describe geometries as a binary array. Well-known binary is useful when you want to save a geometry in an efficient format using as little space as possible. An alternative to well-known binary is well-known text, which is a textual representation of a geometry object. We have methods that work with well-known text as well. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | The return type is a higher level shape constructed from the well-known binary you passed into the method. Though the object is a higher level shape, such as a PolygonShape or MultiPointShape, you will need to cast it to that shape in order to use its unique properties. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | wellKnownBinary | Byte［］<!-- System.Byte[[]] --> | An array of bytes representing the geometry in well-known binary format. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Crosses(Feature) ==== | ||
| - | This method returns if the current shape and the targetFeature share some but not all interior points. | ||
| - | === Remarks === | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | This method returns if the current shape and the targetFeature share some but not all interior points. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetFeature | [[ThinkGeo.MapSuite.Core.Feature|Feature]]<!-- ThinkGeo.MapSuite.Core.Feature --> | The targetFeature that contains a shape you wish to compare the current one to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Crosses(BaseShape) ==== | ||
| - | This method returns if the current shape and the targetShape share some but not all interior points. | ||
| - | === Remarks === | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | This method returns if the current shape and the targetShape share some but not all interior points. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | The shape you wish to compare the current one to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Equals(Object) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | obj | Object<!-- System.Object --> | | | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetAccurateLength(String, DistanceUnit, DistanceCalculationMode) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Double<!-- System.Double --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | shapeProj4ProjectionParameters | String<!-- System.String --> | | | ||
| - | | returningUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | | | ||
| - | | distanceCalculationMode | [[ThinkGeo.MapSuite.Core.DistanceCalculationMode|DistanceCalculationMode]]<!-- ThinkGeo.MapSuite.Core.DistanceCalculationMode --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetAccurateLength(Int32, DistanceUnit, DistanceCalculationMode) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Double<!-- System.Double --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | shapeSrid | Int32<!-- System.Int32 --> | | | ||
| - | | returningUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | | | ||
| - | | distanceCalculationMode | [[ThinkGeo.MapSuite.Core.DistanceCalculationMode|DistanceCalculationMode]]<!-- ThinkGeo.MapSuite.Core.DistanceCalculationMode --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetBoundingBox() ==== | ||
| - | This method calculates the smallest RectangleShape that encompasses the entire geometry. | ||
| - | === Remarks === | ||
| - | The GetBoundingBox method calculates the smallest RectangleShape that can encompass the entire geometry by examining each point in the geometry. | ||
| - | |||
| - | Depending on the number of PointShapes and complexity of the geometry, this operation can take longer for larger objects. | ||
| - | |||
| - | If the shape is a PointShape, then the bounding box's upper left and lower right points will be equal. This will create a RectangleShape with no area. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> | The RectangleShape returned is the smallest RectangleShape that can encompass the entire geometry. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetCenterPoint() ==== | ||
| - | This method returns the center point of the current shape's bounding box. | ||
| - | === Remarks === | ||
| - | This method returns the center point of the current shape's bounding box. It is important to note that this is the center point of the bounding box. There are numerous ways to calculate the "center" of a geometry, such as its weighted center, etc. You can find other centers by examining the various methods of the shape itself. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | A PointShape representing the center point of the current shape's bounding box. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetClosestPointTo(Feature, GeographyUnit) ==== | ||
| - | This method returns the point of the current shape that is closest to the target feature. | ||
| - | === Remarks === | ||
| - | This method returns the point of the current shape that is closest to the target feature. It is often the case that the point returned is not a point of the object itself. An example would be a line with two points that are far apart from each other. If you set the targetFeature to be a point midway between the points but a short distance away from the line, the method would return a point that is on the line but not either of the two points that make up the line. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | A PointShape representing the closest point of the current shape to the targetFeature. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetFeature | [[ThinkGeo.MapSuite.Core.Feature|Feature]]<!-- ThinkGeo.MapSuite.Core.Feature --> | The feature you are trying to find the closest point to. | | ||
| - | | shapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | The geographic unit of the feature you are trying to find the closet point to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetClosestPointTo(BaseShape, GeographyUnit) ==== | ||
| - | This method returns the point of the current shape that is closest to the target shape. | ||
| - | === Remarks === | ||
| - | This method returns the point of the current shape that is closest to the target shape. It is often the case that the point returned is not a point of the object itself. An example would be a line with two points that are far apart from each other. If you set the targetShape to be a point midway between the points but a short distance away from the line, the method would return a point that is on the line but not either of the two points that make up the line. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | A PointShape representing the closest point of the current shape to the targetShape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | The shape you are trying to find the closest point to. | | ||
| - | | shapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | The geographic unit of the shape you are trying to find the closet point to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetCrossing(BaseShape) ==== | ||
| - | This method returns the crossing points between the current shape and the passed-in target shape. | ||
| - | === Remarks === | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.MultipointShape|MultipointShape]]<!-- ThinkGeo.MapSuite.Core.MultipointShape --> | This method returns the crossing points between the current shape and the passed-in target shape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | The target shape you wish to get crossing points with. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetDistanceTo(BaseShape, GeographyUnit, DistanceUnit) ==== | ||
| - | This method computes the distance between the current shape and the targetShape. | ||
| - | === Remarks === | ||
| - | In this method we compute the closest distance between the two shapes. The returned unit will be in the unit of distance specified. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Double<!-- System.Double --> | The return type is the distance between this shape and the targetShape in the GeographyUnit of the shape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | The shape you are trying to find the distance to. | | ||
| - | | shapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | This parameter is the unit of the shape you are getting the distance to. | | ||
| - | | distanceUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | This parameter is the unit of the distance you want the return value to be in. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetDistanceTo(Feature, GeographyUnit, DistanceUnit) ==== | ||
| - | This method computes the distance between the current shape and the targetFeature. | ||
| - | === Remarks === | ||
| - | In this method we compute the closest distance between a shape and a feature. The returned unit will be in the unit of distance specified. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Double<!-- System.Double --> | The return type is the distance between this shape and the targetFeature in the GeographyUnit of the shape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetFeature | [[ThinkGeo.MapSuite.Core.Feature|Feature]]<!-- ThinkGeo.MapSuite.Core.Feature --> | The feature you are trying to find the distance to. | | ||
| - | | shapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | This parameter is the unit of the shape which is contained in the targetFeature you are getting the distance to. | | ||
| - | | distanceUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | This parameter is the unit of the distance you want the return value to be in. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetFeature(IDictionary<String, String>) ==== | ||
| - | Get a corresponding feature which has the same Id and BaseShape as the current shape. Additionally, pass the specified columnValues into the returned feature. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.Feature|Feature]]<!-- ThinkGeo.MapSuite.Core.Feature --> | The feature with the same Id and BaseShape as the current BaseShape and with empty columnValues in it, substituted with the passed-in columnValues. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | columnValues | IDictionary<String,String><!-- System.Collections.Generic.IDictionary{System.String,System.String} --> | The columnValues will be passed into returning feature. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetFeature() ==== | ||
| - | Get a corresponding feature which has the same Id and BaseShape as the current shape. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.Feature|Feature]]<!-- ThinkGeo.MapSuite.Core.Feature --> | The feature with the same Id and BaseShape as the current BaseShape, and with empty columnValues in it. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetGeoJson() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetHashCode() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Int32<!-- System.Int32 --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetIntersection(Feature) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.MultilineShape|MultilineShape]]<!-- ThinkGeo.MapSuite.Core.MultilineShape --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetFeature | [[ThinkGeo.MapSuite.Core.Feature|Feature]]<!-- ThinkGeo.MapSuite.Core.Feature --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetIntersection(AreaBaseShape) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.MultilineShape|MultilineShape]]<!-- ThinkGeo.MapSuite.Core.MultilineShape --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.AreaBaseShape|AreaBaseShape]]<!-- ThinkGeo.MapSuite.Core.AreaBaseShape --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetLength(GeographyUnit, DistanceUnit) ==== | ||
| - | This method returns the length of the line shape. | ||
| - | === Remarks === | ||
| - | This is a useful method when you want to know the total length of a line-based shape. If the shape is a MultiLineShape, then the length is the sum of all of its lines. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Double<!-- System.Double --> | This overload returns the length in the unit of your choice, based on the returningUnit parameter specified. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | shapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | This is the GeographyUnit of the shape you are performing the operation on. | | ||
| - | | returningUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | This is the distance unit you would like to use as the return value. For example, if you select miles as your returningUnit, then the distance will be returned in miles. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetLineOnALine(StartingPoint, PointShape) ==== | ||
| - | This method returns a BaseLineShape, based on a starting position and other factors. | ||
| - | === Overloads === | ||
| - | This overload allows you to specify the starting point and another point. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]]<!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | This method returns a BaseLineShape, based on a starting position and other factors. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | startingPoint | [[ThinkGeo.MapSuite.Core.StartingPoint|StartingPoint]]<!-- ThinkGeo.MapSuite.Core.StartingPoint --> | The startingPoint defines whether the method starts at the beginning or the end of the line. | | ||
| - | | endPointShape | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | The BaseLineShape returned will be between the startingPoint and the endPointShape specified in this parameter. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetLineOnALine(StartingPoint, Double, Double, GeographyUnit, DistanceUnit) ==== | ||
| - | This method returns a BaseLineShape, based on a starting position and other factors. | ||
| - | === Overloads === | ||
| - | This overload allows you to specify the starting point along with the starting distance. This allows you to get a certain distance of the line after the starting distance. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]]<!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | This method returns a BaseLineShape, based on a starting position and other factors. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | startingPoint | [[ThinkGeo.MapSuite.Core.StartingPoint|StartingPoint]]<!-- ThinkGeo.MapSuite.Core.StartingPoint --> | The startingPoint defines whether the method starts at the beginning or the end of the line. | | ||
| - | | startingDistance | Double<!-- System.Double --> | The starting distance from which you will start getting the line. For example, if the line is 3 units long and you have a starting distance of 1 unit, the result will be the last two units of the line. Valid values must be greater than 0. The starting distance will be in the GeographyUnit of the shape. | | ||
| - | | distance | Double<!-- System.Double --> | The amount of the line you want to get after the startingDistance. Valid values must be greater than 0. | | ||
| - | | shapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | This is the GeographyUnit of the shape you are performing the operation on. | | ||
| - | | distanceUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | This is the DistanceUnit you would like to use for the distance parameter. For example, if you select miles as your distanceUnit, then the distance will be measured in miles. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetLineOnALine(StartingPoint, Single) ==== | ||
| - | This method returns a BaseLineShape, based on a starting position and other factors. | ||
| - | === Overloads === | ||
| - | This overload allows you to pass the starting point and percentage of the line. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]]<!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | This method returns a BaseLineShape, based on a starting position and other factors. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | startingPoint | [[ThinkGeo.MapSuite.Core.StartingPoint|StartingPoint]]<!-- ThinkGeo.MapSuite.Core.StartingPoint --> | The startingPoint defines whether the method starts at the beginning or the end of the line. | | ||
| - | | percentageOfLine | Single<!-- System.Single --> | This parameter defines the percentage into the line. Valid values must be greater than 0 and less than or equal to 100. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetLineOnALine(StartingPoint, Single, Single) ==== | ||
| - | This method returns a BaseLineShape, based on a starting position and other factors. | ||
| - | === Overloads === | ||
| - | This overload allows you to pass the starting point, starting percentage of the line and percentage of the line. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]]<!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | This method returns a BaseLineShape, based on a starting position and other factors. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | startingPoint | [[ThinkGeo.MapSuite.Core.StartingPoint|StartingPoint]]<!-- ThinkGeo.MapSuite.Core.StartingPoint --> | The startingPoint defines whether the method starts at the beginning or the end of the line. | | ||
| - | | startingPercentageOfTheLine | Single<!-- System.Single --> | This parameter defines the starting percentage into the line. Valid values must be greater than 0 and less than or equal to 100. | | ||
| - | | percentageOfTheLine | Single<!-- System.Single --> | This parameter defines the percentage into the line. Valid values must be greater than 0 and less than or equal to 100. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetLineOnALine(PointShape, PointShape) ==== | ||
| - | This method returns a BaseLineShape, based on a starting position and other factors. | ||
| - | === Overloads === | ||
| - | This overload allows you to pass in two points to get a BaseLineShape from the original LineShape. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]]<!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | This method returns a BaseLineShape based on a start PointShape and an end PointShape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | startPointShape | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | The startPointShape defines where you will start to get the line. If it does not stand on this LineShape, the closest point on the LineShape will be the start PointShape. | | ||
| - | | endPointShape | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | The endPointShape defines where you will stop getting the line. If it does not stand on this LineShape, the closest point on the LineShape will be the end PointShape. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetPointOnALine(StartingPoint, Single) ==== | ||
| - | This method returns a PointShape on the line, based on a percentage of the length of the line from the first or last vertex defined in the startingPoint parameter. | ||
| - | === Overloads === | ||
| - | This overload allows you to pass a percentage determining how far you want to move along the line, as well as the option for starting from either the beginning or the end of the line. | ||
| - | === Remarks === | ||
| - | If you pass 100 or 0 as the percentage of the line, it will return either the first or last vertex, depending on the value of the startingPoint argument. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | This method returns a PointShape on the line, based on a percentage of the length of the line from the first or last vertex defined in the startingPoint parameter. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | startingPoint | [[ThinkGeo.MapSuite.Core.StartingPoint|StartingPoint]]<!-- ThinkGeo.MapSuite.Core.StartingPoint --> | The startingPoint defines whether the method starts at the beginning or the end of the line. | | ||
| - | | percentageOfLine | Single<!-- System.Single --> | This parameter defines the percentage into the line. Valid values are between 0 and 100. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetPointOnALine(StartingPoint, Double, GeographyUnit, DistanceUnit) ==== | ||
| - | This method returns a PointShape on the line, based on a distance on the line from the first or last vertex defined in the startingPoint parameter. | ||
| - | === Overloads === | ||
| - | This overload allows you to pass a distance determining how far you want to move along the line using your unit of choice, as well as the option to start from the beginning or the end of the line. | ||
| - | === Remarks === | ||
| - | Passing in a 0 distance will return either the first or last point on the line, depending upon the value of the startingPoint parameter. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | This method returns a PointShape on the line, based on a distance on the line from the first or last vertex defined in the startingPoint parameter. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | startingPoint | [[ThinkGeo.MapSuite.Core.StartingPoint|StartingPoint]]<!-- ThinkGeo.MapSuite.Core.StartingPoint --> | The startingPoint defines whether the method starts at the beginning or the end of the line. | | ||
| - | | distance | Double<!-- System.Double --> | This parameter specifies the distance into the line you wish to move in the unit specified by the distanceUnit parameter. Valid values must be greater than or equal to 0. | | ||
| - | | shapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | This is the GeographyUnit of the shape you are performing the operation on. | | ||
| - | | distanceUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | This is the DistanceUnit you would like to use for the distance parameter. For example, if you select miles as your distanceUnit, then the distance will be measured in miles. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetShortestLineTo(Feature, GeographyUnit) ==== | ||
| - | This method returns the shortest LineShape between this shape and the targetFeature. parameter. | ||
| - | === Remarks === | ||
| - | This method returns a MultiLineShape representing the shortest distance between the shape you're calling the method on and the targetShape. In some instances, based on the GeographicType or Projection, the line may not be straight. This is effect is similar to what you might see on an international flight when the displayed flight path is curved. | ||
| - | |||
| - | Overriding: | ||
| - | |||
| - | Please ensure that you validate the parameters being passed in and raise the exceptions defined above. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.MultilineShape|MultilineShape]]<!-- ThinkGeo.MapSuite.Core.MultilineShape --> | A MultiLineShape representing the shortest distance between the shape you're calling the method on and the targetFeature. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetFeature | [[ThinkGeo.MapSuite.Core.Feature|Feature]]<!-- ThinkGeo.MapSuite.Core.Feature --> | The feature you are trying to find the distance to. | | ||
| - | | shapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | The geographic unit of the feature you are trying to find the distance to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetShortestLineTo(BaseShape, GeographyUnit) ==== | ||
| - | This method returns the shortest LineShape between this shape and the targetShape parameter. | ||
| - | === Remarks === | ||
| - | This method returns a LineShape representing the shortest distance between the shape you're calling the method on and the targetShape. In some instances, based on the GeographicType or Projection, the line may not be straight. This effect is similar to what you might see on an international flight when the displayed flight path is curved. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.MultilineShape|MultilineShape]]<!-- ThinkGeo.MapSuite.Core.MultilineShape --> | A LineShape representing the shortest distance between the shape you're calling the method on and the targetShape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | The shape you are trying to find the distance to. | | ||
| - | | shapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | The geographic unit of the Shape you are trying to find the distance to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetType() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Type<!-- System.Type --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetWellKnownBinary() ==== | ||
| - | This method returns a byte array that represents the shape in well-known binary. | ||
| - | === Remarks === | ||
| - | This method returns a byte array that represents the shape in well-known binary. Well-known binary allows you to describe geometries as a binary array. Well-known binary is useful when you want to save a geometry in an efficient format using as little space as possible. An alternative to well-known binary is well-known text, which is a textual representation of a geometry object. We have methods that work with well known text as well. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Byte［］<!-- System.Byte[[]] --> | This method returns a byte array that represents the shape in well-known binary. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetWellKnownBinary(WkbByteOrder) ==== | ||
| - | This method returns a byte array that represents the shape in well-known binary. | ||
| - | === Remarks === | ||
| - | This method returns a byte array that represents the shape in well-known binary. Well-known binary allows you to describe geometries as a binary array. Well-known binary is useful when you want to save a geometry in an efficient format using as little space as possible. An alternative to well-known binary is well-known text, which is a textual representation of a geometry object. We have methods that work with well known text as well. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Byte［］<!-- System.Byte[[]] --> | This method returns a byte array that represents the shape in well-known binary. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | byteOrder | [[ThinkGeo.MapSuite.Core.WkbByteOrder|WkbByteOrder]]<!-- ThinkGeo.MapSuite.Core.WkbByteOrder --> | This parameter is the byte order used to encode the well-known binary. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetWellKnownBinary(RingOrder) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Byte［］<!-- System.Byte[[]] --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | outerRingOrder | [[ThinkGeo.MapSuite.Core.RingOrder|RingOrder]]<!-- ThinkGeo.MapSuite.Core.RingOrder --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetWellKnownBinary(RingOrder, WkbByteOrder) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Byte［］<!-- System.Byte[[]] --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | outerRingOrder | [[ThinkGeo.MapSuite.Core.RingOrder|RingOrder]]<!-- ThinkGeo.MapSuite.Core.RingOrder --> | | | ||
| - | | byteOrder | [[ThinkGeo.MapSuite.Core.WkbByteOrder|WkbByteOrder]]<!-- ThinkGeo.MapSuite.Core.WkbByteOrder --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetWellKnownText() ==== | ||
| - | This method returns the well-known text representation of this shape. | ||
| - | === Remarks === | ||
| - | This method returns a string that represents the shape in well-known text. Well-known text allows you to describe geometries as a string of text. Well-known text is useful when you want to save a geometry in a format such as a text file, or when you simply want to cut and paste the text between other applications. An alternative to well-known text is well-known binary, which is a binary representation of a geometry object. We have methods that work with well-known binary as well. Below are some samples of what well-known text might look like for various kinds of geometries. | ||
| - | |||
| - | POINT(5 17) | ||
| - | |||
| - | LINESTRING(4 5,10 50,25 80) | ||
| - | |||
| - | POLYGON((2 2,6 2,6 6,2 6,2 2),(3 3,4 3,4 4,3 4,3 3)) | ||
| - | |||
| - | MULTIPOINT(3.7 9.7,4.9 11.6) | ||
| - | |||
| - | MULTILINESTRING((4 5,11 51,21 26),(-4 -7,-9 -7,-14 -3)) | ||
| - | |||
| - | MULTIPOLYGON(((2 2,6 2,6 6,2 6,2 2),(3 3,4 3,4 4,3 4,3 3)),((4 4,7 3,7 5,4 4))) | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | This method returns a string that represents the shape in well-known text. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetWellKnownText(RingOrder) ==== | ||
| - | This method returns the well-known text representation of this shape. | ||
| - | === Remarks === | ||
| - | This method returns a stringthat represents the shape in well-known text. Well-known text allows you to describe geometries as a string of text. Well-known text is useful when you want to save a geometry in a format such as a text file, or when you simply want to cut and paste the text between other applications. An alternative to well-known text is well-known binary, which is a binary representation of a geometry object. We have methods that work with well-known binary as well. Below are some samples of what well-known text might look like for various kinds of geometries. | ||
| - | |||
| - | POINT(5 17) | ||
| - | |||
| - | LINESTRING(4 5,10 50,25 80) | ||
| - | |||
| - | POLYGON((2 2,6 2,6 6,2 6,2 2),(3 3,4 3,4 4,3 4,3 3)) | ||
| - | |||
| - | MULTIPOINT(3.7 9.7,4.9 11.6) | ||
| - | |||
| - | MULTILINESTRING((4 5,11 51,21 26),(-4 -7,-9 -7,-14 -3)) | ||
| - | |||
| - | MULTIPOLYGON(((2 2,6 2,6 6,2 6,2 2),(3 3,4 3,4 4,3 4,3 3)),((4 4,7 3,7 5,4 4))) | ||
| - | |||
| - | Overriding: | ||
| - | |||
| - | Please ensure that you validate the parameters being passed in and raise the exceptions defined above. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | This method returns a string that represents the shape in well-known text. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | outerRingOrder | [[ThinkGeo.MapSuite.Core.RingOrder|RingOrder]]<!-- ThinkGeo.MapSuite.Core.RingOrder --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetWellKnownType() ==== | ||
| - | This method returns the well-known type for the shape. | ||
| - | === Remarks === | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.WellKnownType|WellKnownType]]<!-- ThinkGeo.MapSuite.Core.WellKnownType --> | This method returns the well-known type for the shape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Intersects(Feature) ==== | ||
| - | This method returns if the current shape and the targetFeature have at least one point in common. | ||
| - | === Remarks === | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | This method returns if the current shape and the targetFeature have at least one point in common. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetFeature | [[ThinkGeo.MapSuite.Core.Feature|Feature]]<!-- ThinkGeo.MapSuite.Core.Feature --> | The targetFeature you wish to compare the current one to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Intersects(BaseShape) ==== | ||
| - | This method returns if the current shape and the targetShape have at least one point in common. | ||
| - | === Remarks === | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | This method returns if the current shape and the targetShape have at least one point in common. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | The shape you wish to compare the current one to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== IsClosed() ==== | ||
| - | This method determines whether the line is closed, meaning that the last point and first point are the same. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | The return value indicating whether the line is closed. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== IsDisjointed(Feature) ==== | ||
| - | This method returns if the current shape and the targetFeature have no points in common. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | This method returns if the current shape and the targetFeature have no points in common. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetFeature | [[ThinkGeo.MapSuite.Core.Feature|Feature]]<!-- ThinkGeo.MapSuite.Core.Feature --> | The feature you wish to compare the current one to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== IsDisjointed(BaseShape) ==== | ||
| - | This method returns if the current shape and the targetShape have no points in common. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | This method returns if the current shape and the targetShape have no points in common. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | The shape you wish to compare the current one to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== IsTopologicallyEqual(Feature) ==== | ||
| - | This method returns if the current shape and the targetFeature are topologically equal. | ||
| - | === Remarks === | ||
| - | Topologically equal means that the shapes are essentially the same. For example, let's say you have a line with two points, point A and point B. You also have another line that is made up of point A, point B and point C. Point A of line one shares the same vertex as point A of line two, and point B of line one shares the same vertex as point C of line two. They are both straight lines, so point B of line two would lie on the first line. Essentially the two lines are the same, with line 2 having just one extra point. Topologically they are the same line, so this method would return true. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | This method returns if the current shape and the targetFeature are topologically equal. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetFeature | [[ThinkGeo.MapSuite.Core.Feature|Feature]]<!-- ThinkGeo.MapSuite.Core.Feature --> | The targetFeature that contains a shape you wish to compare the current one to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== IsTopologicallyEqual(BaseShape) ==== | ||
| - | This method returns if the current shape and the targetShape are topologically equal. | ||
| - | === Remarks === | ||
| - | Topologically equal means that the shapes are essentially the same. For example, let's say you have a line with two points, point A and point B. You also have another line that is made up of point A, point B and point C. Point A of line one shares the same vertex as point A of line two, and point B of line one shares the same vertex as point C of line two. They are both straight lines, so point B of line two would lie on the first line. Essentially the two lines are the same, with line 2 having just one extra point. Topologically they are the same line, so this method would return true. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | This method returns if the current shape and the targetShape are topologically equal. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | The shape you wish to compare the current one to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== IsWithin(BaseShape) ==== | ||
| - | This method returns if the current shape lies within the interior of the targetShape. | ||
| - | === Remarks === | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | This method returns if the current shape lies within the interior of the targetShape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | The shape you wish to compare the current one to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== IsWithin(Feature) ==== | ||
| - | This method returns if the current shape lies within the interior of the targetFeature. | ||
| - | === Remarks === | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | This method returns if the current shape lies within the interior of the targetFeature. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetFeature | [[ThinkGeo.MapSuite.Core.Feature|Feature]]<!-- ThinkGeo.MapSuite.Core.Feature --> | The targetFeature that contains a shape you wish to compare the current one to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== LoadFromWellKnownData(String) ==== | ||
| - | This method hydrates the current shape with its data from well-known text. | ||
| - | === Remarks === | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | wellKnownText | String<!-- System.String --> | This parameter is the well-known text you will use to hydrate your object. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== LoadFromWellKnownData(Byte［］) ==== | ||
| - | This method hydrates the current shape with its data from well-known binary. | ||
| - | === Remarks === | ||
| - | This is used when you want to hydrate a shape based on well-known binary. You can create the shape and then load the well-known binary using this method. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | wellKnownBinary | Byte［］<!-- System.Byte[[]] --> | This parameter is the well-known binary used to populate the shape. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Overlaps(Feature) ==== | ||
| - | This method returns if the current shape and the targetFeature share some but not all points in common. | ||
| - | === Remarks === | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | This method returns if the current shape and the targetFeature share some but not all points in common. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetFeature | [[ThinkGeo.MapSuite.Core.Feature|Feature]]<!-- ThinkGeo.MapSuite.Core.Feature --> | The targetFeature that contains a shape you wish to compare the current one to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Overlaps(BaseShape) ==== | ||
| - | This method returns if the current shape and the targetShape share some but not all points in common. | ||
| - | === Remarks === | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | This method returns if the current shape and the targetShape share some but not all points in common. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | The shape you wish to compare the current one to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Register(PointShape, PointShape, DistanceUnit, GeographyUnit) ==== | ||
| - | This method returns a BaseShape which has been registered from its original coordinate system to another based on two anchor PointShapes. | ||
| - | === Remarks === | ||
| - | Registering allows you to take a geometric shape generated in a planar system and attach it to the ground in a Geographic Unit. | ||
| - | |||
| - | A common scenario is integrating geometric shapes from external programs (such as CAD software or a modeling system) and placing them onto a map. You may have the schematics of a building in a CAD system and the relationship between all the points of the building are in feet. You want to then take the CAD image and attach it to where it really exists on a map. You would use the register method to do this. | ||
| - | |||
| - | Registering is also useful for scientific modeling, where software models things such as a plume of hazardous materials or the fallout from a volcano. The modeling software typically generates these models in a fictitious planar system. You would then use the register to take the abstract model and attach it to a map with real coordinates. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | This method returns a BaseShape which has been registered from its original coordinate system to another based on two anchor PointShapes. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | fromPoint | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | This parameter is the anchor PointShape in the coordinate of origin. | | ||
| - | | toPoint | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | This parameter is the anchor PointShape in the coordinate of destination. | | ||
| - | | fromUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | This parameter is the DistanceUnit of the coordinate of origin. | | ||
| - | | toUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | This parameter is the GeographyUnit of the coordinate of destination. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Register(Feature, Feature, DistanceUnit, GeographyUnit) ==== | ||
| - | This method returns a BaseShape which has been registered from its original coordinate system to another based on two anchor PointShapes. | ||
| - | === Remarks === | ||
| - | Registering allows you to take a geometric shape generated in a planar system and attach it to the ground in a Geographic Unit. | ||
| - | |||
| - | A common scenario is integrating geometric shapes from external programs (such as CAD software or a modeling system) and placing them onto a map. You may have the schematics of a building in a CAD system and the relationship between all the points of the building are in feet. You want to then take the CAD image and attach it to where it really exists on a map. You would use the register method to do this. | ||
| - | |||
| - | Registering is also useful for scientific modeling, where software models things such as a plume of hazardous materials or the fallout from a volcano. The modeling software typically generates these models in a fictitious planar system. You would then use the register to take the abstract model and attach it to a map with real coordinates. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | This method returns a BaseShape which has been registered from its original coordinate system to another based on two anchor PointShapes. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | fromPoint | [[ThinkGeo.MapSuite.Core.Feature|Feature]]<!-- ThinkGeo.MapSuite.Core.Feature --> | This parameter is the anchor PointFeature in the coordinate of origin. | | ||
| - | | toPoint | [[ThinkGeo.MapSuite.Core.Feature|Feature]]<!-- ThinkGeo.MapSuite.Core.Feature --> | This parameter is the anchor PointFeature in the coordinate of destination. | | ||
| - | | fromUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | This parameter is the DistanceUnit of the coordinate of origin. | | ||
| - | | toUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | This parameter is the GeographyUnit of the coordinate of destination. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== RemoveVertex(Vertex, LineShape) ==== | ||
| - | <!-- static --> | ||
| - | This method removes the selected vertex from line shape. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | If remove sucess it will return true, otherwise return false. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | selectedVertex | [[ThinkGeo.MapSuite.Core.Vertex|Vertex]]<!-- ThinkGeo.MapSuite.Core.Vertex --> | The selected vertex must be a vertex of line shape, otherwise it will return false and line shape will keep the same. | | ||
| - | | lineShape | [[ThinkGeo.MapSuite.Core.LineShape|LineShape]]<!-- ThinkGeo.MapSuite.Core.LineShape --> | The line shape will be removed one vertex. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== RemoveVertex(Vertex) ==== | ||
| - | This method removes the selected vertex from line shape. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | If remove sucess it will return true, otherwise return false. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | selectedVertex | [[ThinkGeo.MapSuite.Core.Vertex|Vertex]]<!-- ThinkGeo.MapSuite.Core.Vertex --> | The selected vertex must be a vertex of line shape, otherwise it will return false and line shape will keep the same. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ReversePoints() ==== | ||
| - | This method reverses the order of the points in the line. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Rotate(Feature, PointShape, Single) ==== | ||
| - | <!-- static --> | ||
| - | This method returns a feature rotated by a number of degrees based on a pivot point. | ||
| - | === Remarks === | ||
| - | This method returns a feature rotated by a number of degrees based on a pivot point. By placing the pivot point in the center of the feature you can achieve in-place rotation. By moving the pivot point outside of the center of the feature you can translate the feature in a circular motion. Moving the pivot point further outside of the center will make the circular area larger. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | This method returns a shape rotated by a number of degrees based on a pivot point. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetFeature | [[ThinkGeo.MapSuite.Core.Feature|Feature]]<!-- ThinkGeo.MapSuite.Core.Feature --> | This parameter is the basis for the rotation. | | ||
| - | | pivotPoint | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | The pivotPoint represents the center of rotation. | | ||
| - | | degreeAngle | Single<!-- System.Single --> | The number of degrees of rotation required, from 0 to 360. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Rotate(PointShape, Single) ==== | ||
| - | This method rotates a shape a number of degrees based on a pivot point. | ||
| - | === Remarks === | ||
| - | This method returns a shape rotated by a number of degrees based on a pivot point. By placing the pivot point in the center of the shape you can achieve in-place rotation. By moving the pivot point outside of the center of the shape you can translate the shape in a circular motion. Moving the pivot point further outside of the center will make the circular area larger. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | pivotPoint | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | The pivotPoint represents the center of rotation. | | ||
| - | | degreeAngle | Single<!-- System.Single --> | The number of degrees of rotation required, from 0 to 360. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Rotate(BaseShape, PointShape, Single) ==== | ||
| - | <!-- static --> | ||
| - | This method returns a shape rotated by a number of degrees based on a pivot point. | ||
| - | === Remarks === | ||
| - | This method returns a shape rotated by a number of degrees based on a pivot point. By placing the pivot point in the center of the shape you can achieve in-place rotation. By moving the pivot point outside of the center of the shape you can translate the shape in a circular motion. Moving the pivot point further outside of the center will make the circular area larger. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | This method returns a shape rotated by a number of degrees based on a pivot point. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | sourceBaseShape | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | This parameter is the basis for the rotation. | | ||
| - | | pivotPoint | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | The pivotPoint represents the center of rotation. | | ||
| - | | degreeAngle | Single<!-- System.Single --> | The number of degrees of rotation required, from 0 to 360. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ScaleDown(Double) ==== | ||
| - | This method decreases the size of the LineShape by the percentage given in the percentage parameter. | ||
| - | === Remarks === | ||
| - | This method is useful when you would like to decrease the size of the shape. Note that a larger percentage will scale the shape down faster as you apply the operation multiple times. There is also a ScaleUp method that will enlarge the shape as well. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method we reserve the right to add events and other logic to pre or post process data returned by the Core version of the method. In this way we leave our framework open on our end but also allow you the developer to extend our logic to your needs. If you have questions about this please contact support as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | percentage | Double<!-- System.Double --> | This is the percentage by which to decrease the shape�s size. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ScaleDown(LineBaseShape, Double) ==== | ||
| - | <!-- static --> | ||
| - | This method returns a new shape that is decreases by the percentage given in the percentage parameter. | ||
| - | === Remarks === | ||
| - | This method is useful when you would like to decrease the size of the shape. Note that a larger percentage will scale the shape down faster as you apply the operation multiple times. There is also a ScaleUp method that will enlarge the shape as well. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method we reserve the right to add events and other logic to pre or post process data returned by the Core version of the method. In this way we leave our framework open on our end but also allow you the developer to extend our logic to your needs. If you have questions about this please contact support as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]]<!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | a scaled down line type shape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | sourceLineBaseShape | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]]<!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | This parameter is the basis for the scale up up but is not modified. | | ||
| - | | percentage | Double<!-- System.Double --> | This is the percentage by which to decrease the shape�s size. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ScaleDown(Feature, Double) ==== | ||
| - | <!-- static --> | ||
| - | This method returns a new feature that is decreases by the percentage given in the percentage parameter. | ||
| - | === Remarks === | ||
| - | This method is useful when you would like to decrease the size of the feature. Note that a larger percentage will scale the shape down faster as you apply the operation multiple times. There is also a ScaleUp method that will enlarge the shape as well. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method we reserve the right to add events and other logic to pre or post process data returned by the Core version of the method. In this way we leave our framework open on our end but also allow you the developer to extend our logic to your needs. If you have questions about this please contact support as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.Feature|Feature]]<!-- ThinkGeo.MapSuite.Core.Feature --> | a scaled down line type feature. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | sourceLine | [[ThinkGeo.MapSuite.Core.Feature|Feature]]<!-- ThinkGeo.MapSuite.Core.Feature --> | This parameter is the basis for the scale up up but is not modified. | | ||
| - | | percentage | Double<!-- System.Double --> | This is the percentage by which to decrease the shape�s size. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ScaleTo(Double) ==== | ||
| - | This method increases or decreases the size of the shape by the specified scale factor given in the parameter. | ||
| - | === Remarks === | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | This method is useful when you would like to increase or decrease the size of the shape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | scale | Double<!-- System.Double --> | Pepresents a value which scaleFactor to | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ScaleTo(BaseShape, Double) ==== | ||
| - | <!-- static --> | ||
| - | This method increases or decreases the size of the shape by the specified scale factor given in the parameter. | ||
| - | === Remarks === | ||
| - | It will call the instanced method ScaleTo internally. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | This method is useful when you would like to increase or decrease the size of the shape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | baseShape | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | Represents a shape which you want to resize | | ||
| - | | scale | Double<!-- System.Double --> | Pepresents a value which scaleFactor to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ScaleUp(Feature, Double) ==== | ||
| - | <!-- static --> | ||
| - | This method returns a new feature that is increased by the percentage given in the percentage parameter. | ||
| - | === Remarks === | ||
| - | This method is useful when you would like to increase the size of the feature. Note that a larger percentage will scale the shape up faster as you apply the operation multiple times. There is also a ScaleDown method that will shrink the shape as well. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method we reserve the right to add events and other logic to pre or post process data returned by the Core version of the method. In this way we leave our framework open on our end but also allow you the developer to extend our logic to your needs. If you have questions about this please contact support as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.Feature|Feature]]<!-- ThinkGeo.MapSuite.Core.Feature --> | a scaled line type feature. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | sourceLine | [[ThinkGeo.MapSuite.Core.Feature|Feature]]<!-- ThinkGeo.MapSuite.Core.Feature --> | This parameter is the basis for the scale up up but is not modified. | | ||
| - | | percentage | Double<!-- System.Double --> | This is the percentage by which to increase the shape�s size. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ScaleUp(Double) ==== | ||
| - | This method increases the size of the LineShape by the percentage given in the percentage parameter. | ||
| - | === Remarks === | ||
| - | This method is useful when you would like to increase the size of the shape. Note that a larger percentage will scale the shape up faster as you apply the operation multiple times. There is also a ScaleDown method that will shrink the shape as well. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method we reserve the right to add events and other logic to pre or post process data returned by the Core version of the method. In this way we leave our framework open on our end but also allow you the developer to extend our logic to your needs. If you have questions about this please contact support as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | percentage | Double<!-- System.Double --> | This is the percentage by which to increase the shape�s size. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ScaleUp(LineBaseShape, Double) ==== | ||
| - | <!-- static --> | ||
| - | This method returns a new shape that is increased by the percentage given in the percentage parameter. | ||
| - | === Remarks === | ||
| - | This method is useful when you would like to increase the size of the shape. Note that a larger percentage will scale the shape up faster as you apply the operation multiple times. There is also a ScaleDown method that will shrink the shape as well. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method we reserve the right to add events and other logic to pre or post process data returned by the Core version of the method. In this way we leave our framework open on our end but also allow you the developer to extend our logic to your needs. If you have questions about this please contact support as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]]<!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | a scaled line type shape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | sourceShape | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]]<!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | This parameter is the basis for the scale up up but is not modified. | | ||
| - | | percentage | Double<!-- System.Double --> | This is the percentage by which to increase the shape�s size. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Simplify(LineBaseShape, Double, SimplificationType) ==== | ||
| - | <!-- static --> | ||
| - | Simplify the LineBaseShape to MultilineShape depends on distance tolerance and different SimplificationType. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.MultilineShape|MultilineShape]]<!-- ThinkGeo.MapSuite.Core.MultilineShape --> | Simplify the LineBaseShape to MultilineShape depends on distance tolerance and different SimplificationType. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]]<!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | target shape which will be simplified. | | ||
| - | | tolerance | Double<!-- System.Double --> | distance tolerance | | ||
| - | | simplificationType | [[ThinkGeo.MapSuite.Core.SimplificationType|SimplificationType]]<!-- ThinkGeo.MapSuite.Core.SimplificationType --> | Specifies which algorthm will be use to simplify. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Simplify(LineBaseShape, GeographyUnit, Double, DistanceUnit, SimplificationType) ==== | ||
| - | <!-- static --> | ||
| - | Simplify the LineBaseShape to MultilineShape depends on distance tolerance and different SimplificationType. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.MultilineShape|MultilineShape]]<!-- ThinkGeo.MapSuite.Core.MultilineShape --> | Simplify the LineBaseShape to MultilineShape depends on distance tolerance and different SimplificationType. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]]<!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | target shape which will be simplified. | | ||
| - | | targetShapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | the geography unit of the target shape | | ||
| - | | tolerance | Double<!-- System.Double --> | distance tolerance | | ||
| - | | toleranceUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | the distance unit of tolerance | | ||
| - | | simplificationType | [[ThinkGeo.MapSuite.Core.SimplificationType|SimplificationType]]<!-- ThinkGeo.MapSuite.Core.SimplificationType --> | Specifies which algorthm will be use to simplify. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Simplify(GeographyUnit, Double, DistanceUnit, SimplificationType) ==== | ||
| - | Simplify the LineBaseShape to MultilineShape depends on distance tolerance and different SimplificationType. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.MultilineShape|MultilineShape]]<!-- ThinkGeo.MapSuite.Core.MultilineShape --> | Simplify the LineBaseShape to MultilineShape depends on distance tolerance and different SimplificationType. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | shapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | the geography unit of the target shape | | ||
| - | | tolerance | Double<!-- System.Double --> | distance tolerance | | ||
| - | | toleranceUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | the distance unit of tolerance | | ||
| - | | simplificationType | [[ThinkGeo.MapSuite.Core.SimplificationType|SimplificationType]]<!-- ThinkGeo.MapSuite.Core.SimplificationType --> | Specifies which algorthm will be use to simplify. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Simplify(Double, SimplificationType) ==== | ||
| - | Simplify the LineBaseShape to MultilineShape depends on distance tolerance and different SimplificationType. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.MultilineShape|MultilineShape]]<!-- ThinkGeo.MapSuite.Core.MultilineShape --> | Simplify the LineBaseShape to MultilineShape depends on distance tolerance and different SimplificationType. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | tolerance | Double<!-- System.Double --> | distance tolerance | | ||
| - | | simplificationType | [[ThinkGeo.MapSuite.Core.SimplificationType|SimplificationType]]<!-- ThinkGeo.MapSuite.Core.SimplificationType --> | Specifies which algorthm will be use to simplify. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ToPolygonShape() ==== | ||
| - | This method generates a PolygonShape based the vertexes of the line. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]]<!-- ThinkGeo.MapSuite.Core.PolygonShape --> | A generated polygon based on the vertexes of the line, otherwise return null. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ToString() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Touches(Feature) ==== | ||
| - | This method returns of the current shape and the targetFeature have at least one boundary point in common, but no interior points. | ||
| - | === Remarks === | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | This method returns of the current shape and the targetFeature have at least one boundary point in common, but no interior points. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetFeature | [[ThinkGeo.MapSuite.Core.Feature|Feature]]<!-- ThinkGeo.MapSuite.Core.Feature --> | The targetFeature which contains a shape that you wish to compare the current one to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Touches(BaseShape) ==== | ||
| - | This method returns if the current shape and the targetShape have at least one boundary point in common, but no interior points. | ||
| - | === Remarks === | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | This method returns if the current shape and the targetShape have at least one boundary point in common, but no interior points. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | The shape you wish to compare the current one to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== TranslateByDegree(Double, Double) ==== | ||
| - | This method moves a base shape from one location to another based on a distance and a direction in degrees. | ||
| - | === Remarks === | ||
| - | This method moves a base shape from one location to another based on angleInDegrees and distance parameter. With this overload, it is important to note that the distance is based on the supplied distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with a distanceUnit of miles, you're going to move this shape a number of miles based on the distance value and the angleInDegrees. In this way, you can easily move a shape in decimal degrees five miles to the north. | ||
| - | |||
| - | If you pass a distance of 0, then the operation is ignored. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | distance | Double<!-- System.Double --> | The distance is the number of units to move the shape using the angle specified. The distance unit will be the DistanceUnit specified in the distanceUnit parameter. The distance must be greater than or equal to 0. | | ||
| - | | angleInDegrees | Double<!-- System.Double --> | A number between 0 and 360 degrees that represents the direction you wish to move the shape, with 0 being up. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== TranslateByDegree(Double, Double, GeographyUnit, DistanceUnit) ==== | ||
| - | This method moves a base shape from one location to another based on a distance and a direction in degrees. | ||
| - | === Remarks === | ||
| - | This method moves a base shape from one location to another based on angleInDegrees and distance parameter. With this overload, it is important to note that the distance is based on the supplied distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with a distanceUnit of miles, you're going to move this shape a number of miles based on the distance value and the angleInDegrees. In this way, you can easily move a shape in decimal degrees five miles to the north. | ||
| - | |||
| - | If you pass a distance of 0, then the operation is ignored. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | distance | Double<!-- System.Double --> | The distance is the number of units to move the shape using the angle specified. The distance unit will be the DistanceUnit specified in the distanceUnit parameter. The distance must be greater than or equal to 0. | | ||
| - | | angleInDegrees | Double<!-- System.Double --> | A number between 0 and 360 degrees that represents the direction you wish to move the shape, with 0 being up. | | ||
| - | | shapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | This is the geographic unit of the shape you are performing the operation on. | | ||
| - | | distanceUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | This is the DistanceUnit you would like to use as the measure of the translate. For example if you select miles as your distanceUnit then the distance will be calculated in miles. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== TranslateByDegree(Feature, Double, Double, GeographyUnit, DistanceUnit) ==== | ||
| - | <!-- static --> | ||
| - | This method returns a feature repositioned from one location to another, based on a distance and a direction in degrees. | ||
| - | === Remarks === | ||
| - | This method returns a feature repositioned from one location to another based on angleInDegrees and distance parameter. With this overload, it is important to note that the distance is based on the supplied distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with a distanceUnit of miles, you're going to move this feature a number of miles based on the distance value and the angleInDegrees. In this way, you can easily move a shape in decimal degrees five miles to the north. | ||
| - | |||
| - | If you pass a distance of 0, then the operation is ignored. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | This method returns a feature repositioned from one location to another, based on a distance and a direction in degrees. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetFeature | [[ThinkGeo.MapSuite.Core.Feature|Feature]]<!-- ThinkGeo.MapSuite.Core.Feature --> | This parameter is the basis of the move. | | ||
| - | | distance | Double<!-- System.Double --> | The distance is the number of units to move the shape using the angle specified. The distance unit will be the DistanceUnit specified in the distanceUnit parameter. The distance must be greater than or equal to 0. | | ||
| - | | angleInDegrees | Double<!-- System.Double --> | A number between 0 and 360 degrees that represents the direction you wish to move the feature, with 0 being up. | | ||
| - | | shapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | This is the geographic unit of the shape you are performing the operation on. | | ||
| - | | distanceUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | This is the distance unit you would like to use as the measure for the move. For example, if you select miles as your distance unit, then the distance will be calculated in miles. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== TranslateByDegree(BaseShape, Double, Double, GeographyUnit, DistanceUnit) ==== | ||
| - | <!-- static --> | ||
| - | This method returns a shape repositioned from one location to another based on a distance and a direction in degrees. | ||
| - | === Remarks === | ||
| - | This method returns a shape repositioned from one location to another based on angleInDegrees and distance parameter. With this overload, it is important to note that the distance is based on the supplied distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with a distanceUnit of miles, you're going to move this shape a number of miles based on the distance value and the angleInDegrees. In this way, you can easily move a shape in decimal degrees five miles to the north. | ||
| - | |||
| - | If you pass a distance of 0, then the operation is ignored. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | This method returns a shape repositioned from one location to another based on a distance and a direction in degrees. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | This parameter is the basis of the move. | | ||
| - | | distance | Double<!-- System.Double --> | The distance is the number of units to move the shape using the angle specified. The distance unit will be the one specified in the distanceUnit parameter. The distance must be greater than or equal to 0. | | ||
| - | | angleInDegrees | Double<!-- System.Double --> | A number between 0 and 360 degrees that represents the direction you wish to move the shape, with 0 being up. | | ||
| - | | shapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | This is the geographic unit of the shape you are performing the operation on. | | ||
| - | | distanceUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | This is the distance unit you would like to use as the measure for the move. For example, if you select miles as your distance unit, then the distance will be calculated in miles. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== TranslateByOffset(Double, Double, GeographyUnit, DistanceUnit) ==== | ||
| - | This method moves a base shape from one location to another based on an X and Y offset distance. | ||
| - | === Remarks === | ||
| - | This method moves a base shape from one location to another based on an X and Y offset distance. With this overload, it is important to note that the X and Y offset units are based on the distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with an X offset of 1 and a Y offset of 1, you're going to move this shape one unit of the distanceUnit in the horizontal direction and one unit of the distanceUnit in the vertical direction. In this way, you can easily move a shape in decimal degrees five miles on the X axis and 3 miles on the Y axis. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | xOffsetDistance | Double<!-- System.Double --> | This is the number of horizontal units of movement in the distance unit specified in the distanceUnit parameter. | | ||
| - | | yOffsetDistance | Double<!-- System.Double --> | This is the number of horizontal units of movement in the distance unit specified in the distanceUnit parameter. | | ||
| - | | shapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | This is the geographic unit of the base shape you are performing the operation on. | | ||
| - | | distanceUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | This is the distance unit you would like to use as the measure for the move. For example, if you select miles as your distance unit, then the xOffsetDistance and yOffsetDistance will be calculated in miles. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== TranslateByOffset(Double, Double) ==== | ||
| - | This method moves a base shape from one location to another based on an X and Y offset distance. | ||
| - | === Remarks === | ||
| - | This method moves a base shape from one location to another based on an X and Y offset distance. With this overload, it is important to note that the X and Y offset units are based on the distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with an X offset of 1 and a Y offset of 1, you're going to move this shape one unit of the distanceUnit in the horizontal direction and one unit of the distanceUnit in the vertical direction. In this way, you can easily move a shape in decimal degrees five miles on the X axis and 3 miles on the Y axis. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | xOffsetDistance | Double<!-- System.Double --> | This is the number of horizontal units of movement in the distance unit specified in the distanceUnit parameter. | | ||
| - | | yOffsetDistance | Double<!-- System.Double --> | This is the number of horizontal units of movement in the distance unit specified in the distanceUnit parameter. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== TranslateByOffset(Feature, Double, Double, GeographyUnit, DistanceUnit) ==== | ||
| - | <!-- static --> | ||
| - | This method returns a feature repositioned from one location to another based on an X and Y offset distance. | ||
| - | === Remarks === | ||
| - | This method returns a feature repositioned from one location to another based on an X and Y offset distance. With this overload, it is important to note that the X and Y offset units are based on the distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with an X offset of 1 and a Y offset of 1, you're going to move this shape one unit of the distanceUnit in the horizontal direction and one unit of the distanceUnit in the vertical direction. In this way, you can easily move a shape in decimal degrees five miles on the X axis and 3 miles on the Y axis. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.Feature|Feature]]<!-- ThinkGeo.MapSuite.Core.Feature --> | This method returns a feature repositioned from one location to another based on an X and Y offset distance. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetFeature | [[ThinkGeo.MapSuite.Core.Feature|Feature]]<!-- ThinkGeo.MapSuite.Core.Feature --> | This parameter is the basis of the moved feature. | | ||
| - | | xOffsetDistance | Double<!-- System.Double --> | This is the number of horizontal units of movement in the distance unit specified in the distanceUnit parameter. | | ||
| - | | yOffsetDistance | Double<!-- System.Double --> | This is the number of horizontal units of movement in the distance unit specified in the distanceUnit parameter. | | ||
| - | | shapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | This is the geographic unit of the shape you are performing the operation on. | | ||
| - | | distanceUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | This is the distance unit you would like to use as the measure for the move. For example, if you select miles as your distance unit, then the xOffsetDistance and yOffsetDistance will be calculated in miles. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== TranslateByOffset(BaseShape, Double, Double, GeographyUnit, DistanceUnit) ==== | ||
| - | <!-- static --> | ||
| - | This method returns a shape repositioned from one location to another based on an X and Y offset distance. | ||
| - | === Remarks === | ||
| - | This method returns a shape repositioned from one location to another based on an X and Y offset distance. With this overload, it is important to note that the X and Y offset units are based on the distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with an X offset of 1 and a Y offset of 1, you're going to move this shape one unit of the distanceUnit in the horizontal direction and one unit of the distanceUnit in the vertical direction. In this way, you can easily move a shape in decimal degrees five miles on the X axis and 3 miles on the Y axis. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | This method returns a shape repositioned from one location to another based on an X and Y offset distance. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | This parameter is the basis of the moved shape. | | ||
| - | | xOffsetDistance | Double<!-- System.Double --> | This is the number of horizontal units of movement in the distance unit specified in the distanceUnit parameter. | | ||
| - | | yOffsetDistance | Double<!-- System.Double --> | This is the number of vertical units of movement in the distance unit specified in the distanceUnit parameter. | | ||
| - | | shapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | This is the geographic unit of the shape you are performing the operation on. | | ||
| - | | distanceUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | This is the distance unit you would like to use as the measure for the move. For example, if you select miles as your distance unit, then the xOffsetDistance and yOffsetDistance will be calculated in miles. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Union(Feature) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.MultilineShape|MultilineShape]]<!-- ThinkGeo.MapSuite.Core.MultilineShape --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetFeature | [[ThinkGeo.MapSuite.Core.Feature|Feature]]<!-- ThinkGeo.MapSuite.Core.Feature --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Union(IEnumerable<Feature>) ==== | ||
| - | <!-- static --> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.MultilineShape|MultilineShape]]<!-- ThinkGeo.MapSuite.Core.MultilineShape --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetFeatures | IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.Feature} --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Union(IEnumerable<LineBaseShape>) ==== | ||
| - | <!-- static --> | ||
| - | Calculates a new geometry that contains all the points in this LineBaseShape and input LineBaseShape set. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.MultilineShape|MultilineShape]]<!-- ThinkGeo.MapSuite.Core.MultilineShape --> | A set combining the points of this LineBaseShape and the points of input LineBaseShape set. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | lineBaseShapes | IEnumerable<[[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.LineBaseShape} --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Union(LineBaseShape) ==== | ||
| - | Calculates a new geometry that contains all the points in this LineBaseShape and input LineBaseShape | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.MultilineShape|MultilineShape]]<!-- ThinkGeo.MapSuite.Core.MultilineShape --> | A set combining the points of this LineBaseShape and the points of input LineBaseShape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]]<!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | The target LineBasheShape with which to compute the union | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Validate(ShapeValidationMode) ==== | ||
| - | This method returns a ShapeValidationResult based on a series of tests. | ||
| - | === Remarks === | ||
| - | We use this method, with the simple enumeration, internally before doing any kind of other methods on the shape. In this way, we are able to verify the integrity of the shape itself. If you wish to test things such as whether a polygon self-intersects, we invite you to call this method with the advanced ShapeValidationMode. One thing to consider is that for complex polygon shapes this operation could take some time, which is why we only run the basic, faster test. If you are dealing with polygon shapes that are suspect, we suggest you run the advanced test. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.ShapeValidationResult|ShapeValidationResult]]<!-- ThinkGeo.MapSuite.Core.ShapeValidationResult --> | This method returns a ShapeValidationResult based on a series of tests. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | validationMode | [[ThinkGeo.MapSuite.Core.ShapeValidationMode|ShapeValidationMode]]<!-- ThinkGeo.MapSuite.Core.ShapeValidationMode --> | This parameter determines whether the test is simple or advanced. In some cases, the advanced tests can take some time. The simple test is designed to always be fast. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ===== Protected Methods ===== | ||
| - | ==== BufferCore(Double, Int32, BufferCapType, GeographyUnit, DistanceUnit) ==== | ||
| - | This method computes the area containing all of the points within a given distance from this shape. | ||
| - | === Remarks === | ||
| - | This method computes the area containing all of the points within a given distance from this shape. In this case, you will be using the rounded RoundedBufferCapStyle and the default 8 quadrant segments. The distance unit is determined by the distanceUnit argument. | ||
| - | |||
| - | Overriding: | ||
| - | |||
| - | Please ensure that you validate the parameters being passed in and raise the exceptions defined above. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.MultipolygonShape|MultipolygonShape]]<!-- ThinkGeo.MapSuite.Core.MultipolygonShape --> | The return type is a MultiPolygonShape that represents all of the points within a given distance from the shape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | distance | Double<!-- System.Double --> | The distance is the number of units to buffer the current shape. The distance unit will be the one specified in the distanceUnit parameter. | | ||
| - | | quadrantSegments | Int32<!-- System.Int32 --> | The number of quadrantSegments used in the buffer logic. | | ||
| - | | bufferCapType | [[ThinkGeo.MapSuite.Core.BufferCapType|BufferCapType]]<!-- ThinkGeo.MapSuite.Core.BufferCapType --> | The bufferCapType used in the buffer logic. | | ||
| - | | shapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | This is the geographic unit of the shape you are performing the operation on. | | ||
| - | | distanceUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | This is the distance unit you would like to use as the distance. For example, if you select miles as your distanceUnit, then the distance will be calculated in miles for the operation. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== CloneDeepCore() ==== | ||
| - | This method returns a complete copy of the shape without any references in common. | ||
| - | === Remarks === | ||
| - | When you override this method, you need to ensure that there are no references in common between the original and the copy. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | This method returns a complete copy of the shape without any references in common. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== ContainsCore(BaseShape) ==== | ||
| - | This method returns if the targetShape lies within the interior of the current shape. | ||
| - | === Remarks === | ||
| - | Overriding: | ||
| - | |||
| - | Please ensure that you validate the parameters being passed in and raise the exceptions defined above. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | This method returns if the targetShape lies within the interior of the current shape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | The shape you wish to compare the current one to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== ConvexHullCore() ==== | ||
| - | This method returns the convex hull of the shape defined as the smallest convex ring that contains all the points in the shape. | ||
| - | === Remarks === | ||
| - | This method is useful when you want to create a perimeter around the shape. For example, if you had a MultiPolygon that represented buildings on a campus, you could easily get the convex hull of the buildings and determine the perimeter of all of the buildings together. This also works with MultiPoint shapes, where each point may represent a certain type of person you are doing statistics on. With convex hull, you can get an idea of the regions those points are located in. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.RingShape|RingShape]]<!-- ThinkGeo.MapSuite.Core.RingShape --> | This method returns a RingShape defined as the smallest convex ring that contains all the points in the shape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== CrossesCore(BaseShape) ==== | ||
| - | This method returns if the current shape and the targetShape share some but not all interior points. | ||
| - | === Remarks === | ||
| - | Overriding: | ||
| - | |||
| - | Please ensure that you validate the parameters being passed in and raise the exceptions defined above. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | This method returns if the current shape and the targetShape share some but not all interior points. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | The shape you wish to compare the current one to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== Finalize() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== GetAccurateLengthCore(String, DistanceUnit, DistanceCalculationMode) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Double<!-- System.Double --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | shapeProj4ProjectionParameters | String<!-- System.String --> | | | ||
| - | | returningUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | | | ||
| - | | distanceCalculationMode | [[ThinkGeo.MapSuite.Core.DistanceCalculationMode|DistanceCalculationMode]]<!-- ThinkGeo.MapSuite.Core.DistanceCalculationMode --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== GetBoundingBoxCore() ==== | ||
| - | This method calculates the smallest RectangleShape that encompasses the entire geometry. | ||
| - | === Remarks === | ||
| - | The GetBoundingBox method calculates the smallest RectangleShape that can encompass the entire geometry by examining each point in the geometry. | ||
| - | |||
| - | Depending on the number of PointShapes and complexity of the geometry this operation can take longer for larger objects. | ||
| - | |||
| - | If the shape is a PointShape, than the bounding box's upper left and lower right points will be equal. This will create a RectangleShape with no area. | ||
| - | |||
| - | Overriding: | ||
| - | |||
| - | Please ensure that you validate the parameters being passed in and raise the exceptions defined above. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> | The RectangleShape returned is the smallest RectangleShape that can encompass the entire geometry. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== GetCenterPointCore() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== GetClosestPointToCore(BaseShape, GeographyUnit) ==== | ||
| - | This method returns the point of the current shape that is closest to the target shape. | ||
| - | === Remarks === | ||
| - | This method returns the point of the current shape that is closest to the target shape. It is often the case that the point returned is not a point of the object itself. An example would be a line with two points that are far apart from each other. If you set the targetShape to be a point midway between the points but a short distance away from the line, the method would return a point that is on the line but not either of the two points that make up the line. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | A PointShape representing the closest point of the current shape to the targetShape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | The shape you are trying to find the closest point to. | | ||
| - | | shapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | This is the GeographyUnit of the shape you are performing the operation on. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== GetCrossingCore(BaseShape) ==== | ||
| - | This method returns the crossing points between the current shape and the passed-in target shape. | ||
| - | === Remarks === | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.MultipointShape|MultipointShape]]<!-- ThinkGeo.MapSuite.Core.MultipointShape --> | This method returns the crossing points between the current shape and the passed-in target shape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | The target shape you wish to get crossing with. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== GetDistanceToCore(BaseShape, GeographyUnit, DistanceUnit) ==== | ||
| - | This method computes the distance between the current shape and the targetShape. | ||
| - | === Overloads === | ||
| - | The distance returned will be in the unit of the shape. | ||
| - | === Remarks === | ||
| - | In this method, we compute the closest distance between the two shapes. The returned unit will be in the unit of distance specified. | ||
| - | |||
| - | Overriding: | ||
| - | |||
| - | Please ensure that you validate the parameters being passed in and raise the exceptions defined above. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Double<!-- System.Double --> | The return type is the distance between this shape and the targetShape in the GeographyUnit of the shape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | The shape you are trying to find the distance to. | | ||
| - | | shapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | This is the GeographicUnit of the shape you are performing the operation on. | | ||
| - | | distanceUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | This is the DistanceUnit you would like to use as the return value. For example, if you select miles as your distanceUnit, then the distance will be returned in miles. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== GetGeoJsonCore() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== GetIntersectionCore(AreaBaseShape) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.MultilineShape|MultilineShape]]<!-- ThinkGeo.MapSuite.Core.MultilineShape --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.AreaBaseShape|AreaBaseShape]]<!-- ThinkGeo.MapSuite.Core.AreaBaseShape --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== GetLengthCore(GeographyUnit, DistanceUnit) ==== | ||
| - | This method returns the length of the LineShape. | ||
| - | === Overloads === | ||
| - | This overload returns the length in the unit of your choice, based on returningUnit you specify. | ||
| - | === Remarks === | ||
| - | This is a useful method when you want to know the total length of a line-based shape. If the shape is a MultiLineShape, then the length is the sum of all of its lines. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Double<!-- System.Double --> | This overload returns the length in the unit of your choice, based on returningUnit you specify. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | shapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | This is the GeographyUnit of the shape you are performing the operation on. | | ||
| - | | returningUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | This is the DistanceUnit you would like to use as the return value. For example, if you select miles as your returningUnit, then the distance will be returned in miles. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineBaseShape(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== GetLineOnALineCore(StartingPoint, Double, Double, GeographyUnit, DistanceUnit) ==== | ||
| - | This method returns a BaseLineShape, based on a starting position and other factors. | ||
| - | === Overloads === | ||
| - | This overload allows you to specify the starting point along with the starting distance. This allows you to get a certain distance of the line after the starting distance. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]]<!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | This method returns a BaseLineShape, based on a starting position and other factors. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | startingPoint | [[ThinkGeo.MapSuite.Core.StartingPoint|StartingPoint]]<!-- ThinkGeo.MapSuite.Core.StartingPoint --> | The startingPoint defines whether the method starts at the beginning or the end of the line. | | ||
| - | | startingDistance | Double<!-- System.Double --> | The starting distance from which you will start getting the line. For example, if the line is 3 units long and you have a starting distance of 1 unit, the result will be the last two units of the line. Valid values must be greater than 0. The starting distance will be in the GeographyUnit of the shape. | | ||
| - | | distance | Double<!-- System.Double --> | The amount of the line you want to get after the startingDistance. Valid values must be greater than 0. | | ||
| - | | shapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | This is the GeographyUnit of the shape you are performing the operation on. | | ||
| - | | distanceUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | This is the DistanceUnit you would like to use for the distance parameter. For example, if you select miles as your distanceUnit, then the distance will be measured in miles. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineShape --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== GetPointOnALineCore(StartingPoint, Double, GeographyUnit, DistanceUnit) ==== | ||
| - | This method returns a PointShape on the line, based on a distance on the line from the first or last vertex defined in the startingPoint parameter. | ||
| - | === Overloads === | ||
| - | This overload allows you to pass a distance determining how far you want to move along the line using your unit of choice, as well as the option to start from the beginning or the end of the line. | ||
| - | === Remarks === | ||
| - | Passing in a 0 distance will return either the first or last point on the line, depending on the value of the startingPoint parameter. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | This method returns a PointShape on the line, based on a distance on the line from the first or last vertex defined in the startingPoint parameter. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | startingPoint | [[ThinkGeo.MapSuite.Core.StartingPoint|StartingPoint]]<!-- ThinkGeo.MapSuite.Core.StartingPoint --> | The startingPoint defines whether the method starts at the beginning or the end of the line. | | ||
| - | | distance | Double<!-- System.Double --> | This parameter specifies the distance into the line you wish to move in the unit specified by the distanceUnit parameter. Valid values must be greater than or equal to 0. | | ||
| - | | shapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | This is the GeographyUnit of the shape you are performing the operation on. | | ||
| - | | distanceUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | This is the DistanceUnit you would like to use for the distance parameter. For example, if you select miles as your distanceUnit, then the distance will be measured in miles. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineShape --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== GetShortestLineToCore(BaseShape, GeographyUnit) ==== | ||
| - | This method returns the shortest LineShape between this shape and the targetShape parameter. | ||
| - | === Remarks === | ||
| - | This method returns a LineShape representing the shortest distance between the shape you're calling the method on and the targetShape. In some instances, based on the GeographicType or Projection, the line may not be straight. This is effect is similar to what you might see on an international flight when the displayed flight path is curved. | ||
| - | |||
| - | Overriding: | ||
| - | |||
| - | Please ensure that you validate the parameters being passed in and raise the exceptions defined above. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.MultilineShape|MultilineShape]]<!-- ThinkGeo.MapSuite.Core.MultilineShape --> | A LineShape representing the shortest distance between the shape you're calling the method on and the targetShape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | The shape you are trying to find the distance to. | | ||
| - | | shapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | The geographic unit of the shape you are trying to find the distance to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== GetWellKnownBinaryCore(RingOrder, WkbByteOrder) ==== | ||
| - | This method returns a byte array that represents the shape in well-known binary. | ||
| - | === Remarks === | ||
| - | This method returns a byte array that represents the shape in well-known binary. Well-known binary allows you to describe geometries as a binary array. Well-known binary is useful when you want to save a geometry in an efficient format using as little space as possible. An alternative to well-known binary is well-known text, which is a textual representation of a geometry object. We have methods that work with well known text as well. | ||
| - | |||
| - | Overriding: | ||
| - | |||
| - | Please ensure that you validate the parameters being passed in and raise the exceptions defined above. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Byte［］<!-- System.Byte[[]] --> | This method returns a byte array that represents the shape in well-known binary. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | outerRingOrder | [[ThinkGeo.MapSuite.Core.RingOrder|RingOrder]]<!-- ThinkGeo.MapSuite.Core.RingOrder --> | | | ||
| - | | byteOrder | [[ThinkGeo.MapSuite.Core.WkbByteOrder|WkbByteOrder]]<!-- ThinkGeo.MapSuite.Core.WkbByteOrder --> | This parameter specifies if the byte order is big- or little-endian. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== GetWellKnownTextCore(RingOrder) ==== | ||
| - | This method returns the well-known text representation of this shape. | ||
| - | === Remarks === | ||
| - | This method returns a string that represents the shape in well-known text. Well-known text allows you to describe a geometry as a string of text. Well-known text is useful when you want to save a geometry in a format such as a text file, or when you simply want to cut and paste the text between other applications. An alternative to well-known text is well-known binary, which is a binary representation of a geometry object. We have methods that work with well-known binary as well. Below are some samples of what well-known text might look like for various kinds of geometric figures. | ||
| - | |||
| - | POINT(5 17) | ||
| - | |||
| - | LINESTRING(4 5,10 50,25 80) | ||
| - | |||
| - | POLYGON((2 2,6 2,6 6,2 6,2 2),(3 3,4 3,4 4,3 4,3 3)) | ||
| - | |||
| - | MULTIPOINT(3.7 9.7,4.9 11.6) | ||
| - | |||
| - | MULTILINESTRING((4 5,11 51,21 26),(-4 -7,-9 -7,-14 -3)) | ||
| - | |||
| - | MULTIPOLYGON(((2 2,6 2,6 6,2 6,2 2),(3 3,4 3,4 4,3 4,3 3)),((4 4,7 3,7 5,4 4))) | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | This method returns a string that represents the shape in well-known text. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | outerRingOrder | [[ThinkGeo.MapSuite.Core.RingOrder|RingOrder]]<!-- ThinkGeo.MapSuite.Core.RingOrder --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== GetWellKnownTypeCore() ==== | ||
| - | This method returns the well-known type for the shape. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.WellKnownType|WellKnownType]]<!-- ThinkGeo.MapSuite.Core.WellKnownType --> | This method returns the well-known type for the shape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== IntersectsCore(BaseShape) ==== | ||
| - | This method returns if the current shape and the targetShape have at least one point in common. | ||
| - | === Remarks === | ||
| - | Overriding: | ||
| - | |||
| - | Please ensure that you validate the parameters being passed in and raise the exceptions defined above. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | This method returns if the current shape and the targetShape have at least one point in common. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | The shape you wish to compare the current one to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== IsClosedCore() ==== | ||
| - | This method determines whether the line is closed, meaning that the last point and first point are the same. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | The return value indicating whether the line is closed. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineShape --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== IsDisjointedCore(BaseShape) ==== | ||
| - | This method returns if the current shape and the targetShape have no points in common. | ||
| - | === Remarks === | ||
| - | Overriding: | ||
| - | |||
| - | Please ensure that you validate the parameters being passed in and raise the exceptions defined above. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | This method returns if the current shape and the targetShape have no points in common. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | The shape you wish to compare the current one to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== IsTopologicallyEqualCore(BaseShape) ==== | ||
| - | This method returns if the current shape and the targetShape are topologically equal. | ||
| - | === Remarks === | ||
| - | Topologically equal means that the shapes are essentially the same. For example, let's say you have a line with two points, point A and point B. You also have another line that is made up of point A, point B and point C. Point A of line one shares the same vertex as point A of line two, and point B of line one shares the same vertex as point C of line two. They are both straight lines, so point B of line two would lie on the first line. Essentially the two lines are the same, with line 2 having just one extra point. Topologically they are the same line, so this method would return true. | ||
| - | |||
| - | Overriding: | ||
| - | |||
| - | Please ensure that you validate the parameters being passed in and raise the exceptions defined above. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | This method returns if the current shape and the targetShape are topologically equal. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | The shape you wish to compare the current one to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== IsWithinCore(BaseShape) ==== | ||
| - | This method returns if the current shape lies within the interior of the targetShape. | ||
| - | === Remarks === | ||
| - | Overriding: | ||
| - | |||
| - | Please ensure that you validate the parameters being passed in and raise the exceptions defined above. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | This method returns if the current shape lies within the interior of the targetShape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | The shape you wish to compare the current one to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== LoadFromWellKnownDataCore(Byte［］) ==== | ||
| - | This method hydrates the current shape with its data from well-known binary. | ||
| - | === Remarks === | ||
| - | This is used when you want to hydrate a shape based on well-known binary. You can create the shape and then load the well-known binary using this method. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | wellKnownBinary | Byte［］<!-- System.Byte[[]] --> | This parameter is the well-known binary used to populate the shape. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== LoadFromWellKnownDataCore(String) ==== | ||
| - | This method hydrates the current shape with its data from well-known text. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | wellKnownText | String<!-- System.String --> | This parameter is the well-known text you will use to hydrate your object. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== MemberwiseClone() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Object<!-- System.Object --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== OverlapsCore(BaseShape) ==== | ||
| - | This method returns if the current shape and the targetShape share some but not all points in common. | ||
| - | === Remarks === | ||
| - | Overriding: | ||
| - | |||
| - | Please ensure that you validate the parameters being passed in and raise the exceptions defined above. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | This method returns if the current shape and the targetShape share some but not all points in common. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | The shape you wish to compare the current one to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== RegisterCore(PointShape, PointShape, DistanceUnit, GeographyUnit) ==== | ||
| - | This method returns a BaseShape which has been registered from its original coordinate system to another, based on two anchor PointShapes. | ||
| - | === Remarks === | ||
| - | Registering allows you to take a geometric shape generated in a planar system and attach it to the ground in a Geographic Unit. | ||
| - | |||
| - | A common scenario is integrating geometric shapes from external programs (such as CAD software or a modeling system) and placing them onto a map. You may have the schematics of a building in a CAD system and the relationship between all the points of the building are in feet. You want to then take the CAD image and attach it to where it really exists on a map. You would use the register method to do this. | ||
| - | |||
| - | Registering is also useful for scientific modeling, where software models things such as a plume of hazardous materials or the fallout from a volcano. The modeling software typically generates these models in a fictitious planar system. You would then use the register to take the abstract model and attach it to a map with real coordinates. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | This method returns a BaseShape which has been registered from its original coordinate system to another, based on two anchor PointShapes. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | fromPoint | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | This parameter is the anchor PointShape in the coordinate of origin. | | ||
| - | | toPoint | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | This parameter is the anchor PointShape in the coordinate of destination. | | ||
| - | | fromUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | This parameter is the DistanceUnit of the coordinate of origin. | | ||
| - | | toUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | This parameter is the GeographyUnit of the coordinate of destination. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== ReversePointsCore() ==== | ||
| - | This method reverses the order of the points in the line. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineShape --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== RotateCore(PointShape, Single) ==== | ||
| - | This method rotates the shape a number of degrees based on a pivot point. | ||
| - | === Remarks === | ||
| - | This method rotates the shape a number of degrees based on a pivot point. By placing the pivot point in the center of the shape, you can achieve in-place rotation. By moving the pivot point outside of the center of the shape, you can translate the shape in a circular motion. Moving the pivot point further outside of the center will make the circular area larger. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | pivotPoint | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | The pivotPoint represents the center of rotation. | | ||
| - | | degreeAngle | Single<!-- System.Single --> | The number of degrees of rotation required from 0 to 360. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== ScaleDownCore(Double) ==== | ||
| - | This method decreases the size of the LineShape by the percentage given in the percentage parameter. | ||
| - | === Remarks === | ||
| - | This method is useful when you would like to decrease the size of the shape. Note that a larger percentage will scale the shape down faster, as you are applying the operation multiple times. There is also a ScaleUp method that will enlarge the shape. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | percentage | Double<!-- System.Double --> | This is the percentage by which to decrease the shape's size. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineBaseShape(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== ScaleToCore(Double) ==== | ||
| - | This method increases or decreases the size of the shape by the specified scale factor given in the parameter. | ||
| - | === Remarks === | ||
| - | This protected virtual method is called from the concrete public method ScaleTo. It does not take into account any transaction activity, as this is the responsibility of the concrete public method ScaleTo. This way, as a developer, if you choose to override this method you do not have to consider transactions at all. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | This method is useful when you would like to increase or decrease the size of the shape. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | scale | Double<!-- System.Double --> | Pepresents a value which scaleFactor to | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== ScaleUpCore(Double) ==== | ||
| - | This method increases the size of the LineShape by the percentage given in the percentage parameter. | ||
| - | === Remarks === | ||
| - | This method is useful when you would like to increase the size of the shape. Note that a larger percentage will scale the shape up faster, as you are applying the operation multiple times. There is also a ScaleDown method that will shrink the shape. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | percentage | Double<!-- System.Double --> | This is the percentage by which to increase the shape's size. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineBaseShape(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== SimplifyCore(Double, SimplificationType) ==== | ||
| - | Simplify the LineBaseShape to MultilineShape depends on distance tolerance and different SimplificationType. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.MultilineShape|MultilineShape]]<!-- ThinkGeo.MapSuite.Core.MultilineShape --> | Simplify the LineBaseShape to MultilineShape depends on distance tolerance and different SimplificationType. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | tolerance | Double<!-- System.Double --> | distance tolerance | | ||
| - | | simplificationType | [[ThinkGeo.MapSuite.Core.SimplificationType|SimplificationType]]<!-- ThinkGeo.MapSuite.Core.SimplificationType --> | Specifies which algorthm will be use to simplify. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== TouchesCore(BaseShape) ==== | ||
| - | This method returns if the current shape and the targetShape have at least one boundary point in common, but no interior points. | ||
| - | === Remarks === | ||
| - | Overriding: | ||
| - | |||
| - | Please ensure that you validate the parameters being passed in and raise the exceptions defined above. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | This method returns if the current shape and the targetShape have at least one boundary point in common, but no interior points. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | targetShape | [[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.Core.BaseShape --> | The shape you wish to compare the current one to. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== TranslateByDegreeCore(Double, Double, GeographyUnit, DistanceUnit) ==== | ||
| - | This method moves the base shape from one location to another based on a distance and a direction in degrees. | ||
| - | === Overloads === | ||
| - | In this overload, the distance unit is based on a DistanceUnit you specify in the distanceUnit parameter, regardless of the shape's GeographicUnit. | ||
| - | === Remarks === | ||
| - | This method returns a shape repositioned from one location to another based on angleInDegrees and distance parameter. With this overload, it is important to note that the distance is based on the supplied distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with a distanceUnit of miles, you're going to move this shape a number of miles based on the distance value and the angleInDegrees. In this way, you can easily move a shape in decimal degrees five miles to the north. | ||
| - | |||
| - | If you pass a distance of 0, then the operation is ignored. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | distance | Double<!-- System.Double --> | The distance is the number of units to move the shape using the angle specified. The distance unit will be the one specified in the distanceUnit parameter. The distance must be greater than or equal to 0. | | ||
| - | | angleInDegrees | Double<!-- System.Double --> | A number between 0 and 360 degrees that represents the direction you wish to move the shape, with 0 being up. | | ||
| - | | shapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | This is the GeographicUnit of the shape you are performing the operation on. | | ||
| - | | distanceUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | This is the DistanceUnit you would like to use as the measure for the move. For example, if you select miles as your distanceUnit, then the distance will be calculated in miles. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== TranslateByOffsetCore(Double, Double, GeographyUnit, DistanceUnit) ==== | ||
| - | This method moves the base shape from one location to another based on an X and Y offset distance. | ||
| - | === Overloads === | ||
| - | In this overload, the X and Y offset are based on a DistanceUnit you specify, regardless of the shape's GeographicUnit. | ||
| - | === Remarks === | ||
| - | This method returns a shape repositioned from one location to another based on an X and Y offset distance. With this overload, it is important to note that the X and Y offset units are based on the distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with an X offset of 1 and a Y offset of 1, you're going to move this shape one unit of the distanceUnit in the horizontal direction and one unit of the distanceUnit in the vertical direction. In this way, you can easily move a shape in decimal degrees five miles on the X axis and 3 miles on the Y axis. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | xOffsetDistance | Double<!-- System.Double --> | This is the number of horizontal units of movement in the distance unit specified in the distanceUnit parameter. | | ||
| - | | yOffsetDistance | Double<!-- System.Double --> | This is the number of vertical units of movement in the distance unit specified in the distanceUnit parameter. | | ||
| - | | shapeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | This is the GeographicUnit of the shape you are performing the operation on. | | ||
| - | | distanceUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | This is the distance unit you would like to use as the measure for the move. For example, if you select miles as your distance unit, then the xOffsetDistance and yOffsetDistance will be calculated in miles. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== UnionCore(IEnumerable<LineBaseShape>) ==== | ||
| - | The protected virtual method used by "Union" that you can overwrite to implement your own logic. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.MultilineShape|MultilineShape]]<!-- ThinkGeo.MapSuite.Core.MultilineShape --> | A set combining the points of this LineBaseShape and the points of input LineBaseShape set. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | lineBaseShapes | IEnumerable<[[ThinkGeo.MapSuite.Core.LineBaseShape|LineBaseShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.LineBaseShape} --> | The target LineBasheShape set with which to compute the union | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineBaseShape --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== ValidateCore(ShapeValidationMode) ==== | ||
| - | This method returns a ShapeValidationResult based on a series of tests. | ||
| - | === Remarks === | ||
| - | We use this method, with the simple enumeration, internally before doing any kind of other methods on the shape. In this way, we are able to verify the integrity of the shape itself. If you wish to test things such as whether a polygon self-intersects, we invite you to call this method with the advanced ShapeValidationMode. One thing to consider is that for complex polygon shapes this operation could take some time, which is why we only run the basic, faster test. If you are dealing with polygon shapes that are suspect, we suggest you run the advanced test. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.ShapeValidationResult|ShapeValidationResult]]<!-- ThinkGeo.MapSuite.Core.ShapeValidationResult --> | This method returns a ShapeValidationResult based on a series of tests. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | validationMode | [[ThinkGeo.MapSuite.Core.ShapeValidationMode|ShapeValidationMode]]<!-- ThinkGeo.MapSuite.Core.ShapeValidationMode --> | This parameter determines whether the test is simple or advanced. In some cases, the advanced tests can take some time. The simple test is designed to always be fast. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== Public Properties ===== | ||
| - | ==== CanRotate ==== | ||
| - | This property specifies whether the shape can be rotated. | ||
| - | === Remarks === | ||
| - | If this property returns false and you attempt call the rotate method, it will throw a NotImplementedException. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape(overriden) --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Id ==== | ||
| - | The id of the shape. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Tag ==== | ||
| - | The tag of the shape. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Object<!-- System.Object --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.BaseShape --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Vertices ==== | ||
| - | This property is the collection of points that make up the LineShape. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Collection<[[ThinkGeo.MapSuite.Core.Vertex|Vertex]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Vertex} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.LineShape --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | ===== Public Events ===== | ||
| - | __NOTOC__ | ||
| - | [[Category:MapSuiteCore]] | ||
| - | [[Category:ThinkGeo.MapSuite.Core]] | ||
| - | [[Category:UpdateDocumentation]] | ||
thinkgeo.mapsuite.core.lineshape.1440040129.txt.gz · Last modified: 2015/09/17 10:34 (external edit)
