Table of Contents

Class LineShape

Namespace
ThinkGeo.Core
Assembly
ThinkGeo.Core.dll

This class represents a LineShape, which is defined as a single line with two or more points.

[TypeConverter(typeof(BaseShapeTypeConverter))]
public class LineShape : LineBaseShape
Inheritance
LineShape
Inherited Members

Remarks

The LineShape is one of the more commonly used shapes. Typically it is used for representing roads in GIS data files.

Constructors

LineShape()

This constructor creates the LineShape.

public LineShape()

Remarks

None

LineShape(byte[])

This constructor creates the LineShape.

public LineShape(byte[] wellKnownBinary)

Parameters

wellKnownBinary byte[]

This parameter is the well-known binary used to build the shape.

Remarks

None

Exceptions

ArgumentException

Passing invalid well-known binary in the bytes parameter will throw an ArgumentException.

ArgumentNullException

Passing a null as the bytes parameter will throw an ArgumentNullException.

LineShape(IEnumerable<Vertex>)

This constructor creates the LineShape.

public LineShape(IEnumerable<Vertex> points)

Parameters

points IEnumerable<Vertex>

Remarks

None

Exceptions

ArgumentNullException

If you pass a null as the points, we will throw an ArgumentNullException.

LineShape(string)

This constructor creates the LineShape.

public LineShape(string wellKnownText)

Parameters

wellKnownText string

This parameter is the well-known text used to build the shape.

Remarks

None

Exceptions

ArgumentException

Passing invalid well-known text in the wellKnownText parameter will throw an ArgumentException.

ArgumentNullException

Passing a null as the wellKnownText parameter will throw an ArgumentNullException.

Properties

Vertices

This property is the collection of points that make up the LineShape.

public Collection<Vertex> Vertices { get; }

Property Value

Collection<Vertex>

Remarks

None

Methods

CloneDeepCore()

This method returns a complete copy of the shape without any references in common.

protected override BaseShape CloneDeepCore()

Returns

BaseShape

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.

GetBoundingBoxCore()

This method calculates the smallest RectangleShape that encompasses the entire geometry.

protected override RectangleShape GetBoundingBoxCore()

Returns

RectangleShape

The RectangleShape returned is the smallest RectangleShape that can encompass 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.

Exceptions

InvalidOperationException

In the event you attempt to get the bounding box from a shape which has no points, it will throw an InvalidOperationException.

GetCenterPointCore() 

protected override PointShape GetCenterPointCore()

Returns

PointShape

GetClosestPointToCore(BaseShape, GeographyUnit)

This method returns the point of the current shape that is closest to the target shape.

protected override PointShape GetClosestPointToCore(BaseShape targetShape, GeographyUnit shapeUnit)

Parameters

targetShape BaseShape

The shape you are trying to find the closest point to.

shapeUnit GeographyUnit

This is the GeographyUnit of the shape you are performing the operation on.

Returns

PointShape

A PointShape representing the closest point of the current shape to the targetShape.

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.

Exceptions

ArgumentException

If you pass in a targetShape which does not have any points, we will throw an ArgumentException.

ArgumentNullException

If you pass a null as the targetShape, we will throw an ArgumentNullException.

InvalidOperationException

In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.

ArgumentOutOfRangeException

If you pass in a shapeUnit that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.

GetCrossingCore(BaseShape)

This method returns the crossing points between the current shape and the passed-in target shape.

protected override MultipointShape GetCrossingCore(BaseShape targetShape)

Parameters

targetShape BaseShape

The target shape you wish to get crossing with.

Returns

MultipointShape

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.

Exceptions

InvalidOperationException

In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.

ArgumentNullException

If you pass a null as the targetShape, we will throw an ArgumentNullException.

GetDistanceToCore(BaseShape, GeographyUnit, DistanceUnit)

This method computes the distance between the current shape and the targetShape.

protected override double GetDistanceToCore(BaseShape targetShape, GeographyUnit shapeUnit, DistanceUnit distanceUnit)

Parameters

targetShape BaseShape

The shape you are trying to find the distance to.

shapeUnit GeographyUnit

This is the GeographicUnit of the shape you are performing the operation on.

distanceUnit 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.

Returns

double

The return type is the distance between this shape and the targetShape in the GeographyUnit 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.

Exceptions

ArgumentException

If you pass in a targetShape which does not have any points, we will throw an ArgumentException.

ArgumentNullException

If you pass a null as the targetShape, we will throw an ArgumentNullException.

InvalidOperationException

In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.

ArgumentOutOfRangeException

If you pass in a shapeUnit that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.

ArgumentOutOfRangeException

If you pass in a distanceUnit that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.

GetLengthCore(GeographyUnit, DistanceUnit)

This method returns the length of the LineShape.

protected override double GetLengthCore(GeographyUnit shapeUnit, DistanceUnit returningUnit)

Parameters

shapeUnit GeographyUnit

This is the GeographyUnit of the shape you are performing the operation on.

returningUnit 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.

Returns

double

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.

Exceptions

ArgumentOutOfRangeException

If you pass in a shapeUnit that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.

ArgumentOutOfRangeException

If you pass in a returningUnit that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.

InvalidOperationException

In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.

GetLineOnALine(PointShape, PointShape)

This method returns a BaseLineShape, based on a starting position and other factors.

public LineBaseShape GetLineOnALine(PointShape startPointShape, PointShape endPointShape)

Parameters

startPointShape 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 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.

Returns

LineBaseShape

This method returns a BaseLineShape based on a start PointShape and an end PointShape.

Remarks

None

Exceptions

ArgumentNullException

Passing a null startPointShape will throw an ArgumentNullException.

ArgumentNullException

Passing a null endPointShape will throw an ArgumentNullException.

InvalidOperationException

In the event you attempt to call this method on a shape which has less than two points, it will throw an InvalidOperationException.

GetLineOnALine(StartingPoint, double, double, GeographyUnit, DistanceUnit)

This method returns a BaseLineShape, based on a starting position and other factors.

public LineBaseShape GetLineOnALine(StartingPoint startingPoint, double startingDistance, double distance, GeographyUnit shapeUnit, DistanceUnit distanceUnit)

Parameters

startingPoint StartingPoint

The startingPoint defines whether the method starts at the beginning or the end of the line.

startingDistance 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

The amount of the line you want to get after the startingDistance. Valid values must be greater than 0.

shapeUnit GeographyUnit

This is the GeographyUnit of the shape you are performing the operation on.

distanceUnit 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.

Returns

LineBaseShape

This method returns a BaseLineShape, based on a starting position and other factors.

Remarks

None

Exceptions

ArgumentOutOfRangeException

If you pass in a shapeUnit that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.

ArgumentOutOfRangeException

If you pass in a distanceUnit that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.

ArgumentOutOfRangeException

If you pass in a startingPoint that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.

ArgumentOutOfRangeException

Passing an invalid startingDistance which is not greater than 0 will throw an ArgumentOutOfRangeException.

InvalidOperationException

In the event you attempt to call this method on a shape which has less than two points, it will throw an InvalidOperationException.

ArgumentOutOfRangeException

Passing an invalid distance which is not greater than 0 will throw an ArgumentOutOfRangeException.

GetLineOnALine(StartingPoint, float)

This method returns a BaseLineShape, based on a starting position and other factors.

public LineBaseShape GetLineOnALine(StartingPoint startingPoint, float percentageOfLine)

Parameters

startingPoint StartingPoint

The startingPoint defines whether the method starts at the beginning or the end of the line.

percentageOfLine float

This parameter defines the percentage into the line. Valid values must be greater than 0 and less than or equal to 100.

Returns

LineBaseShape

This method returns a BaseLineShape, based on a starting position and other factors.

Remarks

None

Exceptions

ArgumentOutOfRangeException

If you pass in a startingPoint that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.

ArgumentOutOfRangeException

Passing an invalid number for the percentageOfLine which is not greater than 0 and less than or equal to 100 will throw an ArgumentOutOfRangeException.

InvalidOperationException

In the event you attempt to call this method on a shape which has less than two points, it will throw an InvalidOperationException.

GetLineOnALine(StartingPoint, float, float)

This method returns a BaseLineShape, based on a starting position and other factors.

public LineBaseShape GetLineOnALine(StartingPoint startingPoint, float startingPercentageOfTheLine, float percentageOfTheLine)

Parameters

startingPoint StartingPoint

The startingPoint defines whether the method starts at the beginning or the end of the line.

startingPercentageOfTheLine float

This parameter defines the starting percentage into the line. Valid values must be greater than 0 and less than or equal to 100.

percentageOfTheLine float

This parameter defines the percentage into the line. Valid values must be greater than 0 and less than or equal to 100.

Returns

LineBaseShape

This method returns a BaseLineShape, based on a starting position and other factors.

Remarks

None

Exceptions

ArgumentOutOfRangeException

If you pass in a startingPoint that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.

ArgumentOutOfRangeException

Passing an invalid number for the percentageOfLine which is not greater than 0 and less than or equal to 100 will throw an ArgumentOutOfRangeException.

InvalidOperationException

In the event you attempt to call this method on a shape which has less than two points, it will throw an InvalidOperationException.

GetLineOnALine(StartingPoint, PointShape)

This method returns a BaseLineShape, based on a starting position and other factors.

public LineBaseShape GetLineOnALine(StartingPoint startingPoint, PointShape endPointShape)

Parameters

startingPoint StartingPoint

The startingPoint defines whether the method starts at the beginning or the end of the line.

endPointShape PointShape

The BaseLineShape returned will be between the startingPoint and the endPointShape specified in this parameter.

Returns

LineBaseShape

This method returns a BaseLineShape, based on a starting position and other factors.

Remarks

None

Exceptions

ArgumentOutOfRangeException

If you pass in a startingPoint that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.

ArgumentNullException

Passing a null endPointShape will throw an ArgumentNullException.

InvalidOperationException

In the event you attempt to call this method on a shape which has less than two points, it will throw an InvalidOperationException.

GetLineOnALineCore(StartingPoint, double, double, GeographyUnit, DistanceUnit)

This method returns a BaseLineShape, based on a starting position and other factors.

protected virtual LineBaseShape GetLineOnALineCore(StartingPoint startingPoint, double startingDistance, double distance, GeographyUnit shapeUnit, DistanceUnit distanceUnit)

Parameters

startingPoint StartingPoint

The startingPoint defines whether the method starts at the beginning or the end of the line.

startingDistance 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

The amount of the line you want to get after the startingDistance. Valid values must be greater than 0.

shapeUnit GeographyUnit

This is the GeographyUnit of the shape you are performing the operation on.

distanceUnit 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.

Returns

LineBaseShape

This method returns a BaseLineShape, based on a starting position and other factors.

Remarks

None

Exceptions

ArgumentOutOfRangeException

If you pass in a shapeUnit that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.

ArgumentOutOfRangeException

If you pass in a distanceUnit that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.

ArgumentOutOfRangeException

If you pass in a startingPoint that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.

ArgumentOutOfRangeException

Passing an invalid startingDistance which is not greater than 0 will throw an ArgumentOutOfRangeException.

InvalidOperationException

In the event you attempt to call this method on a shape which has less than two points, it will throw an InvalidOperationException.

ArgumentOutOfRangeException

Passing an invalid distance which is not greater than 0 will throw an ArgumentOutOfRangeException.

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.

public PointShape GetPointOnALine(StartingPoint startingPoint, double distance, GeographyUnit shapeUnit, DistanceUnit distanceUnit)

Parameters

startingPoint StartingPoint

The startingPoint defines whether the method starts at the beginning or the end of the line.

distance 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 GeographyUnit

This is the GeographyUnit of the shape you are performing the operation on.

distanceUnit 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.

Returns

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.

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.

Exceptions

ArgumentOutOfRangeException

If you pass in a startingPoint that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.

ArgumentOutOfRangeException

Passing an invalid distance which is not greater than or equal to 0 will throw an ArgumentOutOfRangeException.

ArgumentOutOfRangeException

If you pass in a shapeUnit that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.

ArgumentOutOfRangeException

If you pass in a distanceUnit that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.

InvalidOperationException

In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.

GetPointOnALine(StartingPoint, float)

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.

public PointShape GetPointOnALine(StartingPoint startingPoint, float percentageOfLine)

Parameters

startingPoint StartingPoint

The startingPoint defines whether the method starts at the beginning or the end of the line.

percentageOfLine float

This parameter defines the percentage into the line. Valid values are between 0 and 100.

Returns

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.

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.

Exceptions

ArgumentOutOfRangeException

If you pass in a startingPoint that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.

ArgumentOutOfRangeException

Passing an invalid number for the percentageOfLine which is not between 0 and 100 will throw an ArgumentOutOfRangeException.

InvalidOperationException

In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.

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.

protected virtual PointShape GetPointOnALineCore(StartingPoint startingPoint, double distance, GeographyUnit shapeUnit, DistanceUnit distanceUnit)

Parameters

startingPoint StartingPoint

The startingPoint defines whether the method starts at the beginning or the end of the line.

distance 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 GeographyUnit

This is the GeographyUnit of the shape you are performing the operation on.

distanceUnit 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.

Returns

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.

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.

Exceptions

ArgumentOutOfRangeException

If you pass in a startingPoint that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.

ArgumentOutOfRangeException

Passing an invalid distance which is not greater than or equal to 0 will throw an ArgumentOutOfRangeException.

ArgumentOutOfRangeException

If you pass in a shapeUnit that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.

ArgumentOutOfRangeException

If you pass in a distanceUnit that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.

InvalidOperationException

In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.

GetPointPosition(PointShape, double)

Calculate the topology relationship between point and line.

public PointLineRelationship GetPointPosition(PointShape pointShape, double tolerance)

Parameters

pointShape PointShape
tolerance double

Returns

PointLineRelationship

GetPointPositionCore(PointShape, double) 

protected virtual PointLineRelationship GetPointPositionCore(PointShape pointShape, double tolerance)

Parameters

pointShape PointShape
tolerance double

Returns

PointLineRelationship

GetSublinePercentage(PointShape, double)

Calculate the percentage of pointShape is along the line.

public double GetSublinePercentage(PointShape sublineEndpoint, double tolerance)

Parameters

sublineEndpoint PointShape
tolerance double

Returns

double

GetSublinePercentageCore(PointShape, double) 

protected virtual double GetSublinePercentageCore(PointShape sublineEndpoint, double tolerance)

Parameters

sublineEndpoint PointShape
tolerance double

Returns

double

GetWellKnownTextCore(RingOrder)

This method returns the well-known text representation of this shape.

protected override string GetWellKnownTextCore(RingOrder outerRingOrder)

Parameters

outerRingOrder RingOrder

Returns

string

This method returns a string that represents the shape in well-known text.

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)))

Exceptions

InvalidOperationException

In the event you attempt to call this method on a shape which has less than two points, it will throw an InvalidOperationException.

GetWellKnownTypeCore()

This method returns the well-known type for the shape.

protected override WellKnownType GetWellKnownTypeCore()

Returns

WellKnownType

This method returns the well-known type for the shape.

Remarks

None

IsClosed()

This method determines whether the line is closed, meaning that the last point and first point are the same.

public bool IsClosed()

Returns

bool

The return value indicating whether the line is closed.

Remarks

None

Exceptions

InvalidOperationException

In the event you attempt to call this method on a shape which has less than two points, it will throw an InvalidOperationException.

IsClosedCore()

This method determines whether the line is closed, meaning that the last point and first point are the same.

protected virtual bool IsClosedCore()

Returns

bool

The return value indicating whether the line is closed.

Remarks

None

Exceptions

InvalidOperationException

In the event you attempt to call this method on a shape which has less than two points, it will throw an InvalidOperationException.

LoadFromWellKnownDataCore(byte[])

This method hydrates the current shape with its data from well-known binary.

protected override void LoadFromWellKnownDataCore(byte[] wellKnownBinary)

Parameters

wellKnownBinary byte[]

This parameter is the well-known binary used to populate the shape.

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.

Exceptions

ArgumentException

Passing invalid well-known binary in the bytes parameter will throw an ArgumentException.

ArgumentNullException

Passing a null as the bytes parameter will throw an ArgumentNullException.

LoadFromWellKnownDataCore(string)

This method hydrates the current shape with its data from well-known text.

protected override void LoadFromWellKnownDataCore(string wellKnownText)

Parameters

wellKnownText string

This parameter is the well-known text you will use to hydrate your object.

Remarks

None

Exceptions

ArgumentException

Passing invalid well-known text in the wellKnownText parameter will throw an ArgumentException.

ArgumentNullException

Passing a null as the wellKnownText parameter will throw an ArgumentNullException.

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.

protected override BaseShape RegisterCore(PointShape fromPoint, PointShape toPoint, DistanceUnit fromUnit, GeographyUnit toUnit)

Parameters

fromPoint PointShape

This parameter is the anchor PointShape in the coordinate of origin.

toPoint PointShape

This parameter is the anchor PointShape in the coordinate of destination.

fromUnit DistanceUnit

This parameter is the DistanceUnit of the coordinate of origin.

toUnit GeographyUnit

This parameter is the GeographyUnit of the coordinate of destination.

Returns

BaseShape

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.

Exceptions

ArgumentOutOfRangeException

If you pass in a fromUnit that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.

ArgumentOutOfRangeException

If you pass in a toUnit that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.

InvalidOperationException

In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.

ArgumentNullException

Passing a null as the fromPoint parameter will throw an ArgumentNullException.

ArgumentNullException

Passing a null as the toPoint parameter will throw an ArgumentNullException.

RemoveVertex(Vertex)

This method removes the selected vertex from line shape.

public bool RemoveVertex(Vertex selectedVertex)

Parameters

selectedVertex Vertex

The selected vertex must be a vertex of line shape, otherwise it will return false and line shape will keep the same.

Returns

bool

If remove sucess it will return true, otherwise return false.

RemoveVertex(Vertex, LineShape)

This method removes the selected vertex from line shape.

public static bool RemoveVertex(Vertex selectedVertex, LineShape lineShape)

Parameters

selectedVertex Vertex

The selected vertex must be a vertex of line shape, otherwise it will return false and line shape will keep the same.

lineShape LineShape

The line shape will be removed one vertex.

Returns

bool

If remove sucess it will return true, otherwise return false.

ReversePoints()

This method reverses the order of the points in the line.

public void ReversePoints()

Remarks

None

Exceptions

InvalidOperationException

In the event you attempt to call this method on a shape which has less than two points, it will throw an InvalidOperationException.

ReversePointsCore()

This method reverses the order of the points in the line.

protected virtual void ReversePointsCore()

Remarks

None

Exceptions

InvalidOperationException

In the event you attempt to call this method on a shape which has less than two points, it will throw an InvalidOperationException.

RotateCore(PointShape, double)

This method rotates the shape a number of degrees based on a pivot point.

protected override void RotateCore(PointShape pivotPoint, double degreeAngle)

Parameters

pivotPoint PointShape

The pivotPoint represents the center of rotation.

degreeAngle double

The number of degrees of rotation required from 0 to 360.

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.

Exceptions

ArgumentNullException

If you pass a null as the pivotPoint, we will throw an ArgumentNullException.

ArgumentOutOfRangeException

Passing an invalid degreeAngle which is not between 0 and 360 will throw an ArgumentOutOfRangeException.

InvalidOperationException

In the event you attempt to call this method on a shape which is not valid, it will throw an InvalidOperationException.

ScaleDownCore(double)

This method decreases the size of the LineShape by the percentage given in the percentage parameter.

protected override void ScaleDownCore(double percentage)

Parameters

percentage double

This is the percentage by which to decrease the shape's size.

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.

Exceptions

InvalidOperationException

In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.

ArgumentOutOfRangeException

Passing an invalid percentage which is less than 0 will throw an ArgumentOutOfRangeException.

ScaleUpCore(double)

This method increases the size of the LineShape by the percentage given in the percentage parameter.

protected override void ScaleUpCore(double percentage)

Parameters

percentage double

This is the percentage by which to increase the shape's size.

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.

Exceptions

InvalidOperationException

In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.

ArgumentOutOfRangeException

Passing an invalid percentage which is less than 0 will throw an ArgumentOutOfRangeException.

ToPolygonShape()

This method generates a PolygonShape based the vertexes of the line.

public PolygonShape ToPolygonShape()

Returns

PolygonShape

A generated polygon based on the vertexes of the line, otherwise return null.

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.

protected override void TranslateByDegreeCore(double distance, double angleInDegrees, GeographyUnit shapeUnit, DistanceUnit distanceUnit)

Parameters

distance 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

A number between 0 and 360 degrees that represents the direction you wish to move the shape, with 0 being up.

shapeUnit GeographyUnit

This is the GeographicUnit of the shape you are performing the operation on.

distanceUnit 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.

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.

Exceptions

ArgumentOutOfRangeException

Passing an invalid angleInDegrees which is not between 0 and 360 will throw an ArgumentOutOfRangeException.

ArgumentOutOfRangeException

If you pass in a shapeUnit that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.

ArgumentOutOfRangeException

If you pass in a distanceUnit that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.

InvalidOperationException

In the event you attempt to call this method from a shape which has no points, it will throw an InvalidOperationException.

ArgumentOutOfRangeException

Passing an invalid distance which is not greater than or equal to 0 will throw an ArgumentOutOfRangeException.

TranslateByOffsetCore(double, double, GeographyUnit, DistanceUnit)

This method moves the base shape from one location to another based on an X and Y offset distance.

protected override void TranslateByOffsetCore(double xOffsetDistance, double yOffsetDistance, GeographyUnit shapeUnit, DistanceUnit distanceUnit)

Parameters

xOffsetDistance double

This is the number of horizontal units of movement in the distance unit specified in the distanceUnit parameter.

yOffsetDistance double

This is the number of vertical units of movement in the distance unit specified in the distanceUnit parameter.

shapeUnit GeographyUnit

This is the GeographicUnit of the shape you are performing the operation on.

distanceUnit 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.

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.

Exceptions

ArgumentOutOfRangeException

If you pass in a distanceUnit that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.

ArgumentOutOfRangeException

If you pass in a shapeUnit that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.

InvalidOperationException

In the event you attempt to call this method from a shape which has no points, it will throw an InvalidOperationException.

ValidateCore(ShapeValidationMode)

This method returns a ShapeValidationResult based on a series of tests.

protected override ShapeValidationResult ValidateCore(ShapeValidationMode validationMode)

Parameters

validationMode 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.

Returns

ShapeValidationResult

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.

Exceptions

ArgumentOutOfRangeException

If you pass in a validationMode that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.