BaseShape¶
Namespace: ThinkGeo.Core
The abstract class from which area shapes, line shapes, and point shapes inherit from.
public abstract class BaseShape
Inheritance Object → BaseShape
Remarks:
The BaseShape is the lowest level shape in the shapes hierarchy. Directly inherited from BaseShape are AreaShape, LineShape and PointShape. The methods and properties on BaseShape are the lowest common denominator for all the various kinds of shapes. It marked abstract and is designed only to be inherited from.
Properties¶
Id¶
The id of the shape.
public string Id { get; set; }
Property Value¶
Tag¶
The tag of the shape.
public object Tag { get; set; }
Property Value¶
Methods¶
CreateShapeFromWellKnownData(String)¶
This method creates a BaseShape from a string of well-known text.
public static BaseShape CreateShapeFromWellKnownData(string wellKnownText)
Parameters¶
wellKnownText String
A string representing the geometry in well-known text format.
Returns¶
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.
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.
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)))
LoadFromWellKnownData(String)¶
This method hydrates the current shape with its data from well-known text.
public void LoadFromWellKnownData(string wellKnownText)
Parameters¶
wellKnownText String
This parameter is the well-known text you will use to hydrate your object.
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.
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.
LoadFromWellKnownDataCore(String)¶
This method hydrates the current shape with its data from well-known text.
protected abstract void LoadFromWellKnownDataCore(string wellKnownText)
Parameters¶
wellKnownText String
This parameter is the well-known text you will use to hydrate your object.
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.
Remarks:
None
GetWellKnownText()¶
This method returns the well-known text representation of this shape.
public string GetWellKnownText()
Returns¶
String
This method returns a string that represents the shape in well-known text.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
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.
GetGeoJson()¶
public string GetGeoJson()
Returns¶
GetGeoJsonCore()¶
protected string GetGeoJsonCore()
Returns¶
GetWellKnownText(RingOrder)¶
This method returns the well-known text representation of this shape.
public string GetWellKnownText(RingOrder outerRingOrder)
Parameters¶
outerRingOrder RingOrder
Returns¶
String
This method returns a string that represents the shape in well-known text.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
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.
GetWellKnownTextCore(RingOrder)¶
protected abstract string GetWellKnownTextCore(RingOrder outerRingOrder)
Parameters¶
outerRingOrder RingOrder
Returns¶
CreateShapeFromWellKnownData(Byte[])¶
This method creates a BaseShape from a string of well-known binary.
public static BaseShape CreateShapeFromWellKnownData(Byte[] wellKnownBinary)
Parameters¶
wellKnownBinary Byte[]
An array of bytes representing the geometry in well-known binary format.
Returns¶
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.
Exceptions¶
ArgumentException
Passing invalid well-known binary in the bytes parameter will throw an ArgumentException.
ArgumentNullException
Passing a null in the bytes parameter will throw an ArgumentNullException.
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.
CreateShapeFromGeoJson(String)¶
public static BaseShape CreateShapeFromGeoJson(string geoJson)
Parameters¶
geoJson String
Returns¶
LoadFromWellKnownData(Byte[])¶
This method hydrates the current shape with its data from well-known binary.
public void LoadFromWellKnownData(Byte[] wellKnownBinary)
Parameters¶
wellKnownBinary Byte[]
This parameter is the well-known binary used to populate the shape.
Exceptions¶
ArgumentException
Passing invalid well-known binary in the bytes parameter will throw an ArgumentException.
ArgumentNullException
Passing a null in the bytes parameter will throw an ArgumentNullException.
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.
LoadFromWellKnownDataCore(Byte[])¶
This method hydrates the current shape with its data from well-known binary.
protected void LoadFromWellKnownDataCore(Byte[] wellKnownBinary)
Parameters¶
wellKnownBinary Byte[]
This parameter is the well-known binary used to populate the shape.
Exceptions¶
ArgumentException
Passing invalid well-known binary in the bytes parameter will throw an ArgumentException.
ArgumentNullException
Passing a null in the bytes parameter will throw an ArgumentNullException.
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.
GetWellKnownBinary()¶
This method returns a byte array that represents the shape in well-known binary.
public Byte[] GetWellKnownBinary()
Returns¶
This method returns a byte array that represents the shape in well-known
binary.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
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.
GetWellKnownBinary(WkbByteOrder)¶
This method returns a byte array that represents the shape in well-known binary.
public Byte[] GetWellKnownBinary(WkbByteOrder byteOrder)
Parameters¶
byteOrder WkbByteOrder
This parameter is the byte order used to encode the well-known binary.
Returns¶
This method returns a byte array that represents the shape in well-known
binary.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
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.
GetWellKnownBinary(RingOrder)¶
public Byte[] GetWellKnownBinary(RingOrder outerRingOrder)
Parameters¶
outerRingOrder RingOrder
Returns¶
GetWellKnownBinary(RingOrder, WkbByteOrder)¶
public Byte[] GetWellKnownBinary(RingOrder outerRingOrder, WkbByteOrder byteOrder)
Parameters¶
outerRingOrder RingOrder
byteOrder WkbByteOrder
Returns¶
GetWellKnownBinaryCore(RingOrder, WkbByteOrder)¶
This method returns a byte array that represents the shape in well-known binary.
protected Byte[] GetWellKnownBinaryCore(RingOrder outerRingOrder, WkbByteOrder byteOrder)
Parameters¶
outerRingOrder RingOrder
byteOrder WkbByteOrder
This parameter specifies if the byte order is big- or little-endian.
Returns¶
This method returns a byte array that represents the shape in well-known
binary.
Exceptions¶
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 ByteOrder that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.
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.
GetBoundingBox()¶
This method calculates the smallest RectangleShape that encompasses the entire geometry.
public RectangleShape GetBoundingBox()
Returns¶
The RectangleShape returned is the smallest RectangleShape that can encompass the
entire geometry.
Exceptions¶
InvalidOperationException
In the event you attempt to get the bounding box from a shape which has no points, it will throw an InvalidOperationException.
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.
GetBoundingBoxCore()¶
This method calculates the smallest RectangleShape that encompasses the entire geometry.
protected RectangleShape GetBoundingBoxCore()
Returns¶
The RectangleShape returned is the smallest RectangleShape that can encompass the
entire geometry.
Exceptions¶
InvalidOperationException
In the event you attempt to get the bounding box from a shape which has no points, it will throw an InvalidOperationException.
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.
Overriding:
Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
GetWellKnownType()¶
This method returns the well-known type for the shape.
public WellKnownType GetWellKnownType()
Returns¶
WellKnownType
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.
GetWellKnownTypeCore()¶
This method returns the well-known type for the shape.
protected WellKnownType GetWellKnownTypeCore()
Returns¶
WellKnownType
This method returns the well-known type for the shape.
Remarks:
None
CloneDeep()¶
This method returns a complete copy of the shape without any references in common.
public BaseShape CloneDeep()
Returns¶
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.
CloneDeepCore()¶
This method returns a complete copy of the shape without any references in common.
protected BaseShape CloneDeepCore()
Returns¶
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 copy.
TranslateByOffset(BaseShape, Double, Double, GeographyUnit, DistanceUnit)¶
This method returns a shape repositioned from one location to another based on an X and Y offset distance.
public static BaseShape TranslateByOffset(BaseShape targetShape, double xOffsetDistance, double yOffsetDistance, GeographyUnit shapeUnit, DistanceUnit distanceUnit)
Parameters¶
targetShape BaseShape
This parameter is the basis of the moved shape.
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 geographic unit 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.
Returns¶
This method returns a shape repositioned from one location to another based on an X and Y
offset distance.
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.
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.
TranslateByOffset(Feature, Double, Double, GeographyUnit, DistanceUnit)¶
This method returns a feature repositioned from one location to another based on an X and Y offset distance.
public static Feature TranslateByOffset(Feature targetFeature, double xOffsetDistance, double yOffsetDistance, GeographyUnit shapeUnit, DistanceUnit distanceUnit)
Parameters¶
targetFeature Feature
This parameter is the basis of the moved feature.
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 horizontal units of movement in the distance unit specified in
the distanceUnit parameter.
shapeUnit GeographyUnit
This is the geographic unit 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.
Returns¶
This method returns a feature repositioned from one location to another based on an X and Y
offset distance.
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.
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.
TranslateByOffset(Double, Double, GeographyUnit, DistanceUnit)¶
This method moves a base shape from one location to another based on an X and Y offset distance.
public void TranslateByOffset(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 horizontal units of movement in the distance unit specified in
the distanceUnit parameter.
shapeUnit GeographyUnit
This is the geographic unit of the base 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.
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.
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.
TranslateByOffset(Double, Double)¶
This method moves a base shape from one location to another based on an X and Y offset distance.
public void TranslateByOffset(double xOffsetDistance, double yOffsetDistance)
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 horizontal units of movement in the distance unit specified in
the distanceUnit parameter.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method from a shape which has no points, it will throw an InvalidOperationException.
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.
TranslateByOffsetCore(Double, Double, GeographyUnit, DistanceUnit)¶
This method moves a base shape from one location to another based on an X and Y offset distance.
protected 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 horizontal units of movement in the distance unit specified in
the distanceUnit parameter.
shapeUnit GeographyUnit
This is the geographic unit of the base 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.
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.
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.
Overriding:
Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
TranslateByDegree(BaseShape, Double, Double, GeographyUnit, DistanceUnit)¶
This method returns a shape repositioned from one location to another based on a distance and a direction in degrees.
public static BaseShape TranslateByDegree(BaseShape targetShape, double distance, double angleInDegrees, GeographyUnit shapeUnit, DistanceUnit distanceUnit)
Parameters¶
targetShape BaseShape
This parameter is the basis of the move.
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 geographic unit 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 distance
will be calculated in miles.
Returns¶
This method returns a shape repositioned from one location to another based on a
distance and a direction in degrees.
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.
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.
TranslateByDegree(Feature, Double, Double, GeographyUnit, DistanceUnit)¶
This method returns a feature repositioned from one location to another, based on a distance and a direction in degrees.
public static BaseShape TranslateByDegree(Feature targetFeature, double distance, double angleInDegrees, GeographyUnit shapeUnit, DistanceUnit distanceUnit)
Parameters¶
targetFeature Feature
This parameter is the basis of the move.
distance 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
A number between 0 and 360 degrees that represents the direction you wish to move the feature, with 0 being up.
shapeUnit GeographyUnit
This is the geographic unit 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 distance
will be calculated in miles.
Returns¶
This method returns a feature repositioned from one location to another, based on a
distance and a direction in degrees.
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.
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.
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.
public void TranslateByDegree(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 DistanceUnit 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 geographic unit of the shape you are performing the operation
on.
distanceUnit 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.
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.
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.
TranslateByDegree(Double, Double)¶
This method moves a base shape from one location to another based on a distance and a direction in degrees.
public void TranslateByDegree(double distance, double angleInDegrees)
Parameters¶
distance 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
A number between 0 and 360 degrees that represents the direction you wish to move the shape, with 0 being up.
Exceptions¶
ArgumentOutOfRangeException
Passing an invalid angleInDegrees which is not between 0 and 360 will throw an 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.
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.
TranslateByDegreeCore(Double, Double, GeographyUnit, DistanceUnit)¶
This method moves a base shape from one location to another based on a distance and a direction in degrees.
protected 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 DistanceUnit 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 geographic unit of the shape you are performing the operation
on.
distanceUnit 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.
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.
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.
Overriding:
Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Rotate(BaseShape, PointShape, Single)¶
This method returns a shape rotated by a number of degrees based on a pivot point.
public static BaseShape Rotate(BaseShape sourceBaseShape, PointShape pivotPoint, float degreeAngle)
Parameters¶
sourceBaseShape BaseShape
This parameter is the basis for the rotation.
pivotPoint PointShape
The pivotPoint represents the center of rotation.
degreeAngle Single
The number of degrees of rotation required, from 0 to 360.
Returns¶
This method returns a shape rotated by a number of degrees based on a pivot
point.
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.
NotImplementedException
In the event you attempt to call this method and the CanRotate property returns false, it will throw a NotImplementedException.
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.
Rotate(Feature, PointShape, Single)¶
This method returns a feature rotated by a number of degrees based on a pivot point.
public static BaseShape Rotate(Feature targetFeature, PointShape pivotPoint, float degreeAngle)
Parameters¶
targetFeature Feature
This parameter is the basis for the rotation.
pivotPoint PointShape
The pivotPoint represents the center of rotation.
degreeAngle Single
The number of degrees of rotation required, from 0 to 360.
Returns¶
This method returns a shape rotated by a number of degrees based on a pivot
point.
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.
NotImplementedException
In the event you attempt to call this method and the CanRotate property returns false, it will throw a NotImplementedException.
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.
Rotate(PointShape, Double)¶
This method rotates a shape a number of degrees based on a pivot point.
public void Rotate(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.
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.
NotImplementedException
In the event you attempt to call this method and the CanRotate property returns false, it will throw a NotImplementedException.
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.
RotateCore(PointShape, Double)¶
This method rotates a shape a number of degrees based on a pivot point.
protected 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.
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.
NotImplementedException
In the event you attempt to call this method and the CanRotate property returns false, it will throw a NotImplementedException.
Remarks:
This method rotates a shape 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.
Overriding:
Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
GetShortestLineTo(BaseShape, GeographyUnit)¶
This method returns the shortest LineShape between this shape and the targetShape parameter.
public MultilineShape GetShortestLineTo(BaseShape targetShape, GeographyUnit shapeUnit)
Parameters¶
targetShape BaseShape
The shape you are trying to find the distance to.
shapeUnit GeographyUnit
The geographic unit of the Shape you are trying to find the distance to.
Returns¶
A LineShape representing the shortest distance between the shape you're calling the
method on and the targetShape.
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.
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.
GetShortestLineTo(Feature, GeographyUnit)¶
This method returns the shortest LineShape between this shape and the targetFeature. parameter.
public MultilineShape GetShortestLineTo(Feature targetFeature, GeographyUnit shapeUnit)
Parameters¶
targetFeature Feature
The feature you are trying to find the distance to.
shapeUnit GeographyUnit
The geographic unit of the feature you are trying to find the distance to.
Returns¶
A MultiLineShape representing the shortest distance between the shape you're calling the
method on and the targetFeature.
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.
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.
GetShortestLineToCore(BaseShape, GeographyUnit)¶
This method returns the shortest LineShape between this shape and the targetShape parameter.
protected MultilineShape GetShortestLineToCore(BaseShape targetShape, GeographyUnit shapeUnit)
Parameters¶
targetShape BaseShape
The shape you are trying to find the distance to.
shapeUnit GeographyUnit
The geographic unit of the shape you are trying to find the distance to.
Returns¶
A LineShape representing the shortest distance between the shape you're calling the
method on and the targetShape.
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.
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.
GetClosestPointTo(BaseShape, GeographyUnit)¶
This method returns the point of the current shape that is closest to the target shape.
public PointShape GetClosestPointTo(BaseShape targetShape, GeographyUnit shapeUnit)
Parameters¶
targetShape BaseShape
The shape you are trying to find the closest point to.
shapeUnit GeographyUnit
The geographic unit of the shape you are trying to find the closet point to.
Returns¶
A PointShape representing the closest point of the current shape to the
targetShape.
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.
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.
GetClosestPointTo(Feature, GeographyUnit)¶
This method returns the point of the current shape that is closest to the target feature.
public PointShape GetClosestPointTo(Feature targetFeature, GeographyUnit shapeUnit)
Parameters¶
targetFeature Feature
The feature you are trying to find the closest point to.
shapeUnit GeographyUnit
The geographic unit of the feature you are trying to find the closet point to.
Returns¶
A PointShape representing the closest point of the current shape to the
targetFeature.
Exceptions¶
ArgumentException
If you pass in a targetFeature which does not have any points, we will throw an ArgumentException.
ArgumentNullException
If you pass a null as the targetFeature, we will throw an ArgumentNullException.
InvalidOperationException
In the event you attempt to call this method on a feature 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.
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.
GetClosestPointToCore(BaseShape, GeographyUnit)¶
This method returns the point of the current shape that is closest to the target shape.
protected PointShape GetClosestPointToCore(BaseShape targetShape, GeographyUnit shapeUnit)
Parameters¶
targetShape BaseShape
The shape you are trying to find the closest point to.
shapeUnit GeographyUnit
The geographic unit of the shape you are trying to find the closet point to.
Returns¶
A PointShape representing the closest point of the current shape to the
targetShape.
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.
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.
Overriding:
Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
GetCenterPoint()¶
This method returns the center point of the current shape's bounding box.
public PointShape GetCenterPoint()
Returns¶
A PointShape representing the center point of the current shape's bounding
box.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
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.
GetCenterPointCore()¶
This method returns the center point of the current shape's bounding box.
protected PointShape GetCenterPointCore()
Returns¶
A PointShape representing the center point of the current shape's bounding
box.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
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.
Overriding:
Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Buffer(Double, GeographyUnit, DistanceUnit)¶
This method computes the area containing all of the points within a given distance from this shape.
public MultipolygonShape Buffer(double distance, GeographyUnit shapeUnit, DistanceUnit distanceUnit)
Parameters¶
distance 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 GeographyUnit
This is the geographic unit of the shape you are performing the operation
on.
distanceUnit 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.
Returns¶
The return type is a MultiPolygonShape that represents all of the points within a
given distance from the shape.
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.
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
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.
Buffer(Double, Int32, GeographyUnit, DistanceUnit)¶
This method computes the area containing all of the points within a given distance from this shape.
public MultipolygonShape Buffer(double distance, int quadrantSegments, GeographyUnit shapeUnit, DistanceUnit distanceUnit)
Parameters¶
distance 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
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 GeographyUnit
This is the geographic unit of the shape you are performing the operation
on.
distanceUnit 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.
Returns¶
The return type is a MultiPolygonShape that represents all of the points within a
given distance from the shape.
Exceptions¶
ArgumentOutOfRangeException
Passing an invalid number of quadrant segments which is not between 3 and 100 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.
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.
Buffer(Double, Int32, BufferCapType, GeographyUnit, DistanceUnit)¶
This method computes the area containing all of the points within a given distance from this shape.
public MultipolygonShape Buffer(double distance, int quadrantSegments, BufferCapType bufferCapType, GeographyUnit shapeUnit, DistanceUnit distanceUnit)
Parameters¶
distance 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
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 BufferCapType
The bufferCapType determines how the caps of the buffered object look. They
range from rounded to squared off.
shapeUnit GeographyUnit
This is the geographic unit of the shape you are performing the operation
on.
distanceUnit 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.
Returns¶
The return type is a MultiPolygonShape that represents all of the points within a
given distance from the shape.
Exceptions¶
ArgumentOutOfRangeException
Passing an invalid number of quadrant segments which is not between 3 and 100 will throw an ArgumentOutOfRangeException.
ArgumentOutOfRangeException
If you pass in a bufferCapType 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.
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.
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.
BufferCore(Double, Int32, BufferCapType, GeographyUnit, DistanceUnit)¶
This method computes the area containing all of the points within a given distance from this shape.
protected MultipolygonShape BufferCore(double distance, int quadrantSegments, BufferCapType bufferCapType, GeographyUnit shapeUnit, DistanceUnit distanceUnit)
Parameters¶
distance 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
The number of quadrantSegments used in the buffer logic.
bufferCapType BufferCapType
The bufferCapType used in the buffer logic.
shapeUnit GeographyUnit
This is the geographic unit of the shape you are performing the operation
on.
distanceUnit 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.
Returns¶
The return type is a MultiPolygonShape that represents all of the points within a
given distance from the shape.
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.
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 bufferCapType that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.
ArgumentOutOfRangeException
Passing an invalid quadrantSegments which is not between 3 and 100 will throw an ArgumentOutOfRangeException.
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.
GetDistanceTo(BaseShape, GeographyUnit, DistanceUnit)¶
This method computes the distance between the current shape and the targetShape.
public double GetDistanceTo(BaseShape targetShape, GeographyUnit shapeUnit, DistanceUnit distanceUnit)
Parameters¶
targetShape BaseShape
The shape you are trying to find the distance to.
shapeUnit GeographyUnit
This parameter is the unit of the shape you are getting the distance to.
distanceUnit DistanceUnit
This parameter is the unit of the distance you want the return value to be
in.
Returns¶
The return type is the distance between this shape and the targetShape in the
GeographyUnit of the shape.
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.
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.
GetDistanceTo(Feature, GeographyUnit, DistanceUnit)¶
This method computes the distance between the current shape and the targetFeature.
public double GetDistanceTo(Feature targetFeature, GeographyUnit shapeUnit, DistanceUnit distanceUnit)
Parameters¶
targetFeature Feature
The feature you are trying to find the distance to.
shapeUnit GeographyUnit
This parameter is the unit of the shape which is contained in the targetFeature you are getting the distance to.
distanceUnit DistanceUnit
This parameter is the unit of the distance you want the return value to be
in.
Returns¶
The return type is the distance between this shape and the targetFeature in the
GeographyUnit of the shape.
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.
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.
GetDistanceToCore(BaseShape, GeographyUnit, DistanceUnit)¶
This method computes the distance between the current shape and the targetShape.
protected double GetDistanceToCore(BaseShape targetShape, GeographyUnit shapeUnit, DistanceUnit distanceUnit)
Parameters¶
targetShape BaseShape
The shape you are trying to find the distance to.
shapeUnit GeographyUnit
the geographic unit of the targetShape.
distanceUnit DistanceUnit
The returning distance unit.
Returns¶
The return type is the distance between this shape and the targetShape in the
GeographyUnit of the shape.
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.
Remarks:
In this method we compute the closest distance between the two shapes. The returned unit will be in the unit of distance specified.
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.
public BaseShape Register(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.
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.
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.
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.
public BaseShape Register(Feature fromPoint, Feature toPoint, DistanceUnit fromUnit, GeographyUnit toUnit)
Parameters¶
fromPoint Feature
This parameter is the anchor PointFeature in the coordinate of origin.
toPoint Feature
This parameter is the anchor PointFeature 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.
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.
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.
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 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.
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.
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.
Overriding:
Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Validate(ShapeValidationMode)¶
This method returns a ShapeValidationResult based on a series of tests.
public ShapeValidationResult Validate(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¶
This method returns a ShapeValidationResult based on a series of
tests.
Exceptions¶
ArgumentOutOfRangeException
If you pass in a validationMode that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.
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.
ValidateCore(ShapeValidationMode)¶
This method returns a ShapeValidationResult based on a series of tests.
protected 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¶
This method returns a ShapeValidationResult based on a series of
tests.
Exceptions¶
ArgumentOutOfRangeException
If you pass in a validationMode that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.
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.
Overriding:
Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
IsDisjointed(BaseShape)¶
This method returns if the current shape and the targetShape have no points in common.
public bool IsDisjointed(BaseShape targetShape)
Parameters¶
targetShape BaseShape
The shape you wish to compare the current one to.
Returns¶
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.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
ArgumentException
If you pass in a targetShape which is invalid, we will throw an ArgumentException.
ArgumentNullException
If you pass a null as the targetShape, we will throw an ArgumentNullException.
Remarks:
None
IsDisjointed(Feature)¶
This method returns if the current shape and the targetFeature have no points in common.
public bool IsDisjointed(Feature targetFeature)
Parameters¶
targetFeature Feature
The feature you wish to compare the current one to.
Returns¶
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.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
ArgumentException
If you pass in a targetShape which is invalid, we will throw an ArgumentException.
ArgumentNullException
If you pass a null as the targetShape, we will throw an ArgumentNullException.
Remarks:
None
IsDisjointedCore(BaseShape)¶
This method returns if the current shape and the targetShape have no points in common.
protected bool IsDisjointedCore(BaseShape targetShape)
Parameters¶
targetShape BaseShape
The shape you wish to compare the current one to.
Returns¶
This method returns if the current shape and the targetShape have no points in
common.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
ArgumentException
If you pass in a targetShape which is invalid, we will throw an ArgumentException.
ArgumentNullException
If you pass a null as the targetShape, we will throw an ArgumentNullException.
Remarks:
Overriding:
Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Intersects(BaseShape)¶
This method returns if the current shape and the targetShape have at least one point in common.
public bool Intersects(BaseShape targetShape)
Parameters¶
targetShape BaseShape
The shape you wish to compare the current one to.
Returns¶
This method returns if the current shape and the targetShape have at least one
point in common.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
ArgumentException
If you pass in a targetShape which is invalid, we will throw an ArgumentException.
ArgumentNullException
If you pass a null as the targetShape, we will throw an ArgumentNullException.
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.
Intersects(Feature)¶
This method returns if the current shape and the targetFeature have at least one point in common.
public bool Intersects(Feature targetFeature)
Parameters¶
targetFeature Feature
The targetFeature you wish to compare the current one to.
Returns¶
This method returns if the current shape and the targetFeature have at least one
point in common.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
ArgumentException
If you pass in a targetShape which is invalid, we will throw an ArgumentException.
ArgumentNullException
If you pass a null as the targetShape, we will throw an ArgumentNullException.
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.
IntersectsCore(BaseShape)¶
This method returns if the current shape and the targetShape have at least one point in common.
protected bool IntersectsCore(BaseShape targetShape)
Parameters¶
targetShape BaseShape
The shape you wish to compare the current one to.
Returns¶
This method returns if the current shape and the targetShape have at least one
point in common.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
ArgumentException
If you pass in a targetShape which is invalid, we will throw an ArgumentException.
ArgumentNullException
If you pass a null as the targetShape, we will throw an ArgumentNullException.
Remarks:
Overriding:
Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Touches(BaseShape)¶
This method returns if the current shape and the targetShape have at least one boundary point in common, but no interior points.
public bool Touches(BaseShape targetShape)
Parameters¶
targetShape BaseShape
The shape you wish to compare the current one to.
Returns¶
This method returns if the current shape and the targetShape have at least one
boundary point in common, but no interior points.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
ArgumentException
If you pass in a targetShape which is invalid, we will throw an ArgumentException.
ArgumentNullException
If you pass a null as the targetShape, we will throw an ArgumentNullException.
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.
Touches(Feature)¶
This method returns of the current shape and the targetFeature have at least one boundary point in common, but no interior points.
public bool Touches(Feature targetFeature)
Parameters¶
targetFeature Feature
The targetFeature which contains a shape that you wish to compare the current one to.
Returns¶
This method returns of the current shape and the targetFeature have at least one
boundary point in common, but no interior points.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
ArgumentException
If you pass in a targetShape which is invalid, we will throw an ArgumentException.
ArgumentNullException
If you pass a null as the targetShape, we will throw an ArgumentNullException.
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.
TouchesCore(BaseShape)¶
This method returns if the current shape and the targetShape have at least one boundary point in common, but no interior points.
protected bool TouchesCore(BaseShape targetShape)
Parameters¶
targetShape BaseShape
The shape you wish to compare the current one to.
Returns¶
This method returns if the current shape and the targetShape have at least one
boundary point in common, but no interior points.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
ArgumentException
If you pass in a targetShape which is invalid, we will throw an ArgumentException.
ArgumentNullException
If you pass a null as the targetShape, we will throw an ArgumentNullException.
Remarks:
Overriding:
Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Crosses(BaseShape)¶
This method returns if the current shape and the targetShape share some but not all interior points.
public bool Crosses(BaseShape targetShape)
Parameters¶
targetShape BaseShape
The shape you wish to compare the current one to.
Returns¶
This method returns if the current shape and the targetShape share some but not
all interior points.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
ArgumentException
If you pass in a targetShape which is invalid, we will throw an ArgumentException.
ArgumentNullException
If you pass a null as the targetShape, we will throw an ArgumentNullException.
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.
Crosses(Feature)¶
This method returns if the current shape and the targetFeature share some but not all interior points.
public bool Crosses(Feature targetFeature)
Parameters¶
targetFeature Feature
The targetFeature that contains a shape you wish to compare the current one to.
Returns¶
This method returns if the current shape and the targetFeature share some but not
all interior points.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
ArgumentException
If you pass in a targetShape which is invalid, we will throw an ArgumentException.
ArgumentNullException
If you pass a null as the targetShape, we will throw an ArgumentNullException.
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.
CrossesCore(BaseShape)¶
This method returns if the current shape and the targetShape share some but not all interior points.
protected bool CrossesCore(BaseShape targetShape)
Parameters¶
targetShape BaseShape
The shape you wish to compare the current one to.
Returns¶
This method returns if the current shape and the targetShape share some but not
all interior points.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
ArgumentException
If you pass in a targetShape which is invalid, we will throw an ArgumentException.
ArgumentNullException
If you pass a null as the targetShape, we will throw an ArgumentNullException.
Remarks:
Overriding:
Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
IsWithin(BaseShape)¶
This method returns if the current shape lies within the interior of the targetShape.
public bool IsWithin(BaseShape targetShape)
Parameters¶
targetShape BaseShape
The shape you wish to compare the current one to.
Returns¶
This method returns if the current shape lies within the interior of the
targetShape.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
ArgumentException
If you pass in a targetShape which is invalid, we will throw an ArgumentException.
ArgumentNullException
If you pass a null as the targetShape, we will throw an ArgumentNullException.
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.
IsWithin(Feature)¶
This method returns if the current shape lies within the interior of the targetFeature.
public bool IsWithin(Feature targetFeature)
Parameters¶
targetFeature Feature
The targetFeature that contains a shape you wish to compare the current one to.
Returns¶
This method returns if the current shape lies within the interior of the
targetFeature.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
ArgumentException
If you pass in a targetShape which is invalid, we will throw an ArgumentException.
ArgumentNullException
If you pass a null as the targetShape, we will throw an ArgumentNullException.
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.
IsWithinCore(BaseShape)¶
This method returns if the current shape lies within the interior of the targetShape.
protected bool IsWithinCore(BaseShape targetShape)
Parameters¶
targetShape BaseShape
The shape you wish to compare the current one to.
Returns¶
This method returns if the current shape lies within the interior of the
targetShape.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
ArgumentException
If you pass in a targetShape which is invalid, we will throw an ArgumentException.
ArgumentNullException
If you pass a null as the targetShape, we will throw an ArgumentNullException.
Remarks:
Overriding:
Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Contains(BaseShape)¶
This method returns if the targetShape lies within the interior of the current shape.
public bool Contains(BaseShape targetShape)
Parameters¶
targetShape BaseShape
The shape you wish to compare the current one to.
Returns¶
This method returns if the targetShape lies within the interior of the current
shape.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
ArgumentException
If you pass in a targetShape which is invalid, we will throw an ArgumentException.
ArgumentNullException
If you pass a null as the targetShape, we will throw an ArgumentNullException.
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.
Contains(Feature)¶
This method returns if the targetFeature lies within the interior of the current shape.
public bool Contains(Feature targetFeature)
Parameters¶
targetFeature Feature
The targetFeature that contains a shape you wish to compare the current one to.
Returns¶
This method returns if the targetFeature lies within the interior of the current
shape.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
ArgumentException
If you pass in a targetShape which is invalid, we will throw an ArgumentException.
ArgumentNullException
If you pass a null as the targetShape, we will throw an ArgumentNullException.
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.
ContainsCore(BaseShape)¶
This method returns if the targetShape lies within the interior of the current shape.
protected bool ContainsCore(BaseShape targetShape)
Parameters¶
targetShape BaseShape
The shape you wish to compare the current one to.
Returns¶
This method returns if the targetShape lies within the interior of the current
shape.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
ArgumentException
If you pass in a targetShape which is invalid, we will throw an ArgumentException.
ArgumentNullException
If you pass a null as the targetShape, we will throw an ArgumentNullException.
Remarks:
Overriding:
Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Overlaps(BaseShape)¶
This method returns if the current shape and the targetShape share some but not all points in common.
public bool Overlaps(BaseShape targetShape)
Parameters¶
targetShape BaseShape
The shape you wish to compare the current one to.
Returns¶
This method returns if the current shape and the targetShape share some but not
all points in common.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
ArgumentException
If you pass in a targetShape which is invalid, we will throw an ArgumentException.
ArgumentNullException
If you pass a null as the targetShape, we will throw an ArgumentNullException.
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.
Overlaps(Feature)¶
This method returns if the current shape and the targetFeature share some but not all points in common.
public bool Overlaps(Feature targetFeature)
Parameters¶
targetFeature Feature
The targetFeature that contains a shape you wish to compare the current one to.
Returns¶
This method returns if the current shape and the targetFeature share some but not
all points in common.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
ArgumentException
If you pass in a targetShape which is invalid, we will throw an ArgumentException.
ArgumentNullException
If you pass a null as the targetShape, we will throw an ArgumentNullException.
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.
OverlapsCore(BaseShape)¶
This method returns if the current shape and the targetShape share some but not all points in common.
protected bool OverlapsCore(BaseShape targetShape)
Parameters¶
targetShape BaseShape
The shape you wish to compare the current one to.
Returns¶
This method returns if the current shape and the targetShape share some but not
all points in common.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
ArgumentException
If you pass in a targetShape which is invalid, we will throw an ArgumentException.
ArgumentNullException
If you pass a null as the targetShape, we will throw an ArgumentNullException.
Remarks:
Overriding:
Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
IsTopologicallyEqual(BaseShape)¶
This method returns if the current shape and the targetShape are topologically equal.
public bool IsTopologicallyEqual(BaseShape targetShape)
Parameters¶
targetShape BaseShape
The shape you wish to compare the current one to.
Returns¶
This method returns if the current shape and the targetShape are topologically
equal.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
ArgumentException
If you pass in a targetShape which is invalid, we will throw an ArgumentException.
ArgumentNullException
If you pass a null as the targetShape, we will throw an ArgumentNullException.
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.
IsTopologicallyEqual(Feature)¶
This method returns if the current shape and the targetFeature are topologically equal.
public bool IsTopologicallyEqual(Feature targetFeature)
Parameters¶
targetFeature Feature
The targetFeature that contains a shape you wish to compare the current one to.
Returns¶
This method returns if the current shape and the targetFeature are topologically
equal.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
ArgumentException
If you pass in a targetShape which is invalid, we will throw an ArgumentException.
ArgumentNullException
If you pass a null as the targetShape, we will throw an ArgumentNullException.
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.
IsTopologicallyEqualCore(BaseShape)¶
This method returns if the current shape and the targetShape are topologically equal.
protected bool IsTopologicallyEqualCore(BaseShape targetShape)
Parameters¶
targetShape BaseShape
The shape you wish to compare the current one to.
Returns¶
This method returns if the current shape and the targetShape are topologically
equal.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a shape which has no points, it will throw an InvalidOperationException.
ArgumentException
If you pass in a targetShape which is invalid, we will throw an ArgumentException.
ArgumentNullException
If you pass a null as the targetShape, we will throw an ArgumentNullException.
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.
GetFeature()¶
Get a corresponding feature which has the same Id and BaseShape as the current shape.
public Feature GetFeature()
Returns¶
The feature with the same Id and BaseShape as the current BaseShape, and with empty
columnValues in it.
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.
public Feature GetFeature(IDictionary<string, string> columnValues)
Parameters¶
columnValues IDictionary<String, String>
The columnValues will be passed into returning feature.
Returns¶
The feature with the same Id and BaseShape as the current BaseShape and with empty
columnValues in it, substituted with the passed-in columnValues.
GetCrossing(BaseShape)¶
This method returns the crossing points between the current shape and the passed-in target shape.
public MultipointShape GetCrossing(BaseShape targetShape)
Parameters¶
targetShape BaseShape
The target shape you wish to get crossing points with.
Returns¶
This method returns the crossing points between the current shape and the passed-in target shape.
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.
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.
GetCrossingCore(BaseShape)¶
This method returns the crossing points between the current shape and the passed-in target shape.
protected MultipointShape GetCrossingCore(BaseShape targetShape)
Parameters¶
targetShape BaseShape
The target shape you wish to get crossing with.
Returns¶
This method returns the crossing points between the current shape and the passed-in target shape.
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.
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.
ScaleTo(BaseShape, Double)¶
This method increases or decreases the size of the shape by the specified scale factor given in the parameter.
public static BaseShape ScaleTo(BaseShape baseShape, double scale)
Parameters¶
baseShape BaseShape
Represents a shape which you want to resize
scale Double
Pepresents a value which scaleFactor to.
Returns¶
This method is useful when you would like to increase or decrease the size of 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
Is you pass in the scale is not bigger than zero, it will throw ArgumentOutOfRangeException.
Remarks:
It will call the instanced method ScaleTo internally.
ScaleTo(Double)¶
This method increases or decreases the size of the shape by the specified scale factor given in the parameter.
public void ScaleTo(double scale)
Parameters¶
scale Double
Pepresents a value which scaleFactor to
Exceptions¶
ArgumentOutOfRangeException
Is you pass in the scale is not bigger than zero, it will throw ArgumentOutOfRangeException.
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.
ScaleToCore(Double)¶
This method increases or decreases the size of the shape by the specified scale factor given in the parameter.
protected void ScaleToCore(double scale)
Parameters¶
scale Double
Pepresents a value which scaleFactor to
Exceptions¶
ArgumentOutOfRangeException
Is you pass in the scale is not bigger than zero, it will throw ArgumentOutOfRangeException.
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.