This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
thinkgeo.mapsuite.silverlightcore.baseshape [2015/09/21 03:19] admin |
thinkgeo.mapsuite.silverlightcore.baseshape [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== ThinkGeo.MapSuite.SilverlightCore.BaseShape ====== | ====== ThinkGeo.MapSuite.SilverlightCore.BaseShape ====== | ||
+ | |||
+ | {{section>upgrade_map_suite_to_10.0}} | ||
+ | |||
The abstract class from which area shapes, line shapes, and point shapes inherit from. | The abstract class from which area shapes, line shapes, and point shapes inherit from. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
Line 13: | Line 16: | ||
** {{wiki:ProtectedMethod.gif|}} BaseShape() ** | ** {{wiki:ProtectedMethod.gif|}} BaseShape() ** | ||
- | This is the default constructor for BaseShape. | + | * //This is the default constructor for BaseShape.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Parameters == | == Parameters == | ||
<div newline></div> | <div newline></div> | ||
Line 21: | Line 24: | ||
** {{wiki:PublicMethod.gif|}} LoadFromWellKnownData(String) ** | ** {{wiki:PublicMethod.gif|}} LoadFromWellKnownData(String) ** | ||
- | This method hydrates the current shape with its data from well-known text. | + | * //This method hydrates the current shape with its data from well-known text.// |
== Remarks == | == 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. | + | * //As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 37: | Line 40: | ||
** {{wiki:PublicMethod.gif|}} GetWellKnownText() ** | ** {{wiki:PublicMethod.gif|}} GetWellKnownText() ** | ||
- | This method returns the well-known text representation of this shape. | + | * //This method returns the well-known text representation of this shape.// |
== Remarks == | == 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. | + | * //This method returns a string that represents the shape in well-known text. Well-known text allows you to describe geometries as a string of text. Well-known text is useful when you want to save a geometry in a format such as a text file, or when you simply want to cut and paste the text between other applications. An alternative to well-known text is well-known binary, which is a binary representation of a geometry object. We have methods that work with well-known binary as well. Below are some samples of what well-known text might look like for various kinds of geometries.POINT(5 17)LINESTRING(4 5,10 50,25 80)POLYGON((2 2,6 2,6 6,2 6,2 2),(3 3,4 3,4 4,3 4,3 3))MULTIPOINT(3.7 9.7,4.9 11.6)MULTILINESTRING((4 5,11 51,21 26),(-4 -7,-9 -7,-14 -3))MULTIPOLYGON(((2 2,6 2,6 6,2 6,2 2),(3 3,4 3,4 4,3 4,3 3)),((4 4,7 3,7 5,4 4))) As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 49: | Line 52: | ||
** {{wiki:PublicMethod.gif|}} LoadFromWellKnownData(Byte[]) ** | ** {{wiki:PublicMethod.gif|}} LoadFromWellKnownData(Byte[]) ** | ||
- | This method hydrates the current shape with its data from well-known binary. | + | * //This method hydrates the current shape with its data from well-known binary.// |
== Remarks == | == 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. | + | * //This is used when you want to hydrate a shape based on well-known binary. You can create the shape and then load the well-known binary using this method. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 65: | Line 68: | ||
** {{wiki:PublicMethod.gif|}} GetWellKnownBinary() ** | ** {{wiki:PublicMethod.gif|}} GetWellKnownBinary() ** | ||
- | This method returns a byte array that represents the shape in well-known binary. | + | * //This method returns a byte array that represents the shape in well-known binary.// |
== Remarks == | == 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. | + | * //This method returns a byte array that represents the shape in well-known binary. Well-known binary allows you to describe geometries as a binary array. Well-known binary is useful when you want to save a geometry in an efficient format using as little space as possible. An alternative to well-known binary is well-known text, which is a textual representation of a geometry object. We have methods that work with well known text as well. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 77: | Line 80: | ||
** {{wiki:PublicMethod.gif|}} GetWellKnownBinary(WkbByteOrder) ** | ** {{wiki:PublicMethod.gif|}} GetWellKnownBinary(WkbByteOrder) ** | ||
- | This method returns a byte array that represents the shape in well-known binary. | + | * //This method returns a byte array that represents the shape in well-known binary.// |
== Remarks == | == 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. | + | * //This method returns a byte array that represents the shape in well-known binary. Well-known binary allows you to describe geometries as a binary array. Well-known binary is useful when you want to save a geometry in an efficient format using as little space as possible. An alternative to well-known binary is well-known text, which is a textual representation of a geometry object. We have methods that work with well known text as well. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 93: | Line 96: | ||
** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | ||
- | This method calculates the smallest RectangleShape that encompasses the entire geometry. | + | * //This method calculates the smallest RectangleShape that encompasses the entire geometry.// |
== Remarks == | == 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. | + | * //The GetBoundingBox method calculates the smallest RectangleShape that can encompass the entire geometry by examining each point in the geometry. Depending on the number of PointShapes and complexity of the geometry, this operation can take longer for larger objects. If the shape is a PointShape, then the bounding box's upper left and lower right points will be equal. This will create a RectangleShape with no area. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 105: | Line 108: | ||
** {{wiki:PublicMethod.gif|}} GetWellKnownType() ** | ** {{wiki:PublicMethod.gif|}} GetWellKnownType() ** | ||
- | This method returns the well-known type for the shape. | + | * //This method returns the well-known type for the shape.// |
== Remarks == | == 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. | + | * //As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 117: | Line 120: | ||
** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ||
- | This method returns a complete copy of the shape without any references in common. | + | * //This method returns a complete copy of the shape without any references in common.// |
== Remarks == | == 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. | + | * //As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 129: | Line 132: | ||
** {{wiki:PublicMethod.gif|}} TranslateByOffset(Double,Double,GeographyUnit,DistanceUnit) ** | ** {{wiki:PublicMethod.gif|}} TranslateByOffset(Double,Double,GeographyUnit,DistanceUnit) ** | ||
- | This method moves a base shape from one location to another based on an X and Y offset distance. | + | * //This method moves a base shape from one location to another based on an X and Y offset distance.// |
== Remarks == | == 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. | + | * //This method moves a base shape from one location to another based on an X and Y offset distance. With this overload, it is important to note that the X and Y offset units are based on the distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with an X offset of 1 and a Y offset of 1, you're going to move this shape one unit of the distanceUnit in the horizontal direction and one unit of the distanceUnit in the vertical direction. In this way, you can easily move a shape in decimal degrees five miles on the X axis and 3 miles on the Y axis. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 157: | Line 160: | ||
** {{wiki:PublicMethod.gif|}} TranslateByOffset(Double,Double) ** | ** {{wiki:PublicMethod.gif|}} TranslateByOffset(Double,Double) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 177: | Line 180: | ||
** {{wiki:PublicMethod.gif|}} TranslateByDegree(Double,Double,GeographyUnit,DistanceUnit) ** | ** {{wiki:PublicMethod.gif|}} 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. | + | * //This method moves a base shape from one location to another based on a distance and a direction in degrees.// |
== Remarks == | == 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. | + | * //This method moves a base shape from one location to another based on angleInDegrees and distance parameter. With this overload, it is important to note that the distance is based on the supplied distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with a distanceUnit of miles, you're going to move this shape a number of miles based on the distance value and the angleInDegrees. In this way, you can easily move a shape in decimal degrees five miles to the north.If you pass a distance of 0, then the operation is ignored. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 205: | Line 208: | ||
** {{wiki:PublicMethod.gif|}} TranslateByDegree(Double,Double) ** | ** {{wiki:PublicMethod.gif|}} TranslateByDegree(Double,Double) ** | ||
- | This method moves a base shape from one location to another based on a distance and a direction in degrees. | + | * //This method moves a base shape from one location to another based on a distance and a direction in degrees.// |
== Remarks == | == 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. | + | * //This method moves a base shape from one location to another based on angleInDegrees and distance parameter. With this overload, it is important to note that the distance is based on the supplied distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with a distanceUnit of miles, you're going to move this shape a number of miles based on the distance value and the angleInDegrees. In this way, you can easily move a shape in decimal degrees five miles to the north.If you pass a distance of 0, then the operation is ignored. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 225: | Line 228: | ||
** {{wiki:PublicMethod.gif|}} Rotate(PointShape,Single) ** | ** {{wiki:PublicMethod.gif|}} Rotate(PointShape,Single) ** | ||
- | This method rotates a shape a number of degrees based on a pivot point. | + | * //This method rotates a shape a number of degrees based on a pivot point.// |
== Remarks == | == 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. | + | * //This method returns a shape rotated by a number of degrees based on a pivot point. By placing the pivot point in the center of the shape you can achieve in-place rotation. By moving the pivot point outside of the center of the shape you can translate the shape in a circular motion. Moving the pivot point further outside of the center will make the circular area larger. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 245: | Line 248: | ||
** {{wiki:PublicMethod.gif|}} GetShortestLineTo(BaseShape,GeographyUnit) ** | ** {{wiki:PublicMethod.gif|}} GetShortestLineTo(BaseShape,GeographyUnit) ** | ||
- | This method returns the shortest LineShape between this shape and the targetShape parameter. | + | * //This method returns the shortest LineShape between this shape and the targetShape parameter.// |
== Remarks == | == 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. | + | * //This method returns a LineShape representing the shortest distance between the shape you're calling the method on and the targetShape. In some instances, based on the GeographicType or Projection, the line may not be straight. This effect is similar to what you might see on an international flight when the displayed flight path is curved. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 265: | Line 268: | ||
** {{wiki:PublicMethod.gif|}} GetShortestLineTo(Feature,GeographyUnit) ** | ** {{wiki:PublicMethod.gif|}} GetShortestLineTo(Feature,GeographyUnit) ** | ||
- | This method returns the shortest LineShape between this shape and the targetFeature. parameter. | + | * //This method returns the shortest LineShape between this shape and the targetFeature. parameter.// |
== Remarks == | == 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. | + | * //This method returns a MultiLineShape representing the shortest distance between the shape you're calling the method on and the targetShape. In some instances, based on the GeographicType or Projection, the line may not be straight. This is effect is similar to what you might see on an international flight when the displayed flight path is curved. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.// |
== Return Value == | == Return Value == | ||
Line 285: | Line 288: | ||
** {{wiki:PublicMethod.gif|}} GetClosestPointTo(BaseShape,GeographyUnit) ** | ** {{wiki:PublicMethod.gif|}} GetClosestPointTo(BaseShape,GeographyUnit) ** | ||
- | This method returns the point of the current shape that is closest to the target shape. | + | * //This method returns the point of the current shape that is closest to the target shape.// |
== Remarks == | == 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. | + | * //This method returns the point of the current shape that is closest to the target shape. It is often the case that the point returned is not a point of the object itself. An example would be a line with two points that are far apart from each other. If you set the targetShape to be a point midway between the points but a short distance away from the line, the method would return a point that is on the line but not either of the two points that make up the line. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 305: | Line 308: | ||
** {{wiki:PublicMethod.gif|}} GetClosestPointTo(Feature,GeographyUnit) ** | ** {{wiki:PublicMethod.gif|}} GetClosestPointTo(Feature,GeographyUnit) ** | ||
- | This method returns the point of the current shape that is closest to the target feature. | + | * //This method returns the point of the current shape that is closest to the target feature.// |
== Remarks == | == 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. | + | * //This method returns the point of the current shape that is closest to the target feature. It is often the case that the point returned is not a point of the object itself. An example would be a line with two points that are far apart from each other. If you set the targetFeature to be a point midway between the points but a short distance away from the line, the method would return a point that is on the line but not either of the two points that make up the line. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 325: | Line 328: | ||
** {{wiki:PublicMethod.gif|}} GetCenterPoint() ** | ** {{wiki:PublicMethod.gif|}} GetCenterPoint() ** | ||
- | This method returns the center point of the current shape's bounding box. | + | * //This method returns the center point of the current shape's bounding box.// |
== Remarks == | == 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. | + | * //This method returns the center point of the current shape's bounding box. It is important to note that this is the center point of the bounding box. There are numerous ways to calculate the "center" of a geometry, such as its weighted center, etc. You can find other centers by examining the various methods of the shape itself. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 337: | Line 340: | ||
** {{wiki:PublicMethod.gif|}} Buffer(Double,GeographyUnit,DistanceUnit) ** | ** {{wiki:PublicMethod.gif|}} Buffer(Double,GeographyUnit,DistanceUnit) ** | ||
- | This method computes the area containing all of the points within a given distance from this shape. | + | * //This method computes the area containing all of the points within a given distance from this shape.// |
== Remarks == | == 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. | + | * //This method computes the area containing all of the points within a given distance from this shape. In this case, you will be using the rounded RoundedBufferCapStyle and the default 8 quadrant segments. The distance unit is determined by the distanceUnit argument. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 361: | Line 364: | ||
** {{wiki:PublicMethod.gif|}} Buffer(Double,Int32,GeographyUnit,DistanceUnit) ** | ** {{wiki:PublicMethod.gif|}} Buffer(Double,Int32,GeographyUnit,DistanceUnit) ** | ||
- | This method computes the area containing all of the points within a given distance from this shape. | + | * //This method computes the area containing all of the points within a given distance from this shape.// |
== Remarks == | == 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. | + | * //This method computes the area containing all of the points within a given distance from this shape. In this case, you will be using the rounded RoundedBufferCapStyle. The distance unit is determined by the distanceUnit argument. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 389: | Line 392: | ||
** {{wiki:PublicMethod.gif|}} Buffer(Double,Int32,BufferCapType,GeographyUnit,DistanceUnit) ** | ** {{wiki:PublicMethod.gif|}} Buffer(Double,Int32,BufferCapType,GeographyUnit,DistanceUnit) ** | ||
- | This method computes the area containing all of the points within a given distance from this shape. | + | * //This method computes the area containing all of the points within a given distance from this shape.// |
== Remarks == | == 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. | + | * //This method computes the area containing all of the points within a given distance from this shape. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 421: | Line 424: | ||
** {{wiki:PublicMethod.gif|}} GetDistanceTo(BaseShape,GeographyUnit,DistanceUnit) ** | ** {{wiki:PublicMethod.gif|}} GetDistanceTo(BaseShape,GeographyUnit,DistanceUnit) ** | ||
- | This method computes the distance between the current shape and the targetShape. | + | * //This method computes the distance between the current shape and the targetShape.// |
== Remarks == | == 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. | + | * //In this method we compute the closest distance between the two shapes. The returned unit will be in the unit of distance specified. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 445: | Line 448: | ||
** {{wiki:PublicMethod.gif|}} GetDistanceTo(Feature,GeographyUnit,DistanceUnit) ** | ** {{wiki:PublicMethod.gif|}} GetDistanceTo(Feature,GeographyUnit,DistanceUnit) ** | ||
- | This method computes the distance between the current shape and the targetFeature. | + | * //This method computes the distance between the current shape and the targetFeature.// |
== Remarks == | == 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. | + | * //In this method we compute the closest distance between a shape and a feature. The returned unit will be in the unit of distance specified. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 469: | Line 472: | ||
** {{wiki:PublicMethod.gif|}} Register(PointShape,PointShape,DistanceUnit,GeographyUnit) ** | ** {{wiki:PublicMethod.gif|}} 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. | + | * //This method returns a BaseShape which has been registered from its original coordinate system to another based on two anchor PointShapes.// |
== Remarks == | == 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. | + | * //Registering allows you to take a geometric shape generated in a planar system and attach it to the ground in a Geographic Unit.A common scenario is integrating geometric shapes from external programs (such as CAD software or a modeling system) and placing them onto a map. You may have the schematics of a building in a CAD system and the relationship between all the points of the building are in feet. You want to then take the CAD image and attach it to where it really exists on a map. You would use the register method to do this.Registering is also useful for scientific modeling, where software models things such as a plume of hazardous materials or the fallout from a volcano. The modeling software typically generates these models in a fictitious planar system. You would then use the register to take the abstract model and attach it to a map with real coordinates. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 497: | Line 500: | ||
** {{wiki:PublicMethod.gif|}} Register(Feature,Feature,DistanceUnit,GeographyUnit) ** | ** {{wiki:PublicMethod.gif|}} 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. | + | * //This method returns a BaseShape which has been registered from its original coordinate system to another based on two anchor PointShapes.// |
== Remarks == | == 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. | + | * //Registering allows you to take a geometric shape generated in a planar system and attach it to the ground in a Geographic Unit.A common scenario is integrating geometric shapes from external programs (such as CAD software or a modeling system) and placing them onto a map. You may have the schematics of a building in a CAD system and the relationship between all the points of the building are in feet. You want to then take the CAD image and attach it to where it really exists on a map. You would use the register method to do this.Registering is also useful for scientific modeling, where software models things such as a plume of hazardous materials or the fallout from a volcano. The modeling software typically generates these models in a fictitious planar system. You would then use the register to take the abstract model and attach it to a map with real coordinates. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 525: | Line 528: | ||
** {{wiki:PublicMethod.gif|}} Validate(ShapeValidationMode) ** | ** {{wiki:PublicMethod.gif|}} Validate(ShapeValidationMode) ** | ||
- | This method returns a ShapeValidationResult based on a series of tests. | + | * //This method returns a ShapeValidationResult based on a series of tests.// |
== Remarks == | == 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. | + | * //We use this method, with the simple enumeration, internally before doing any kind of other methods on the shape. In this way, we are able to verify the integrity of the shape itself. If you wish to test things such as whether a polygon self-intersects, we invite you to call this method with the advanced ShapeValidationMode. One thing to consider is that for complex polygon shapes this operation could take some time, which is why we only run the basic, faster test. If you are dealing with polygon shapes that are suspect, we suggest you run the advanced test. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 541: | Line 544: | ||
** {{wiki:PublicMethod.gif|}} IsDisjointed(BaseShape) ** | ** {{wiki:PublicMethod.gif|}} IsDisjointed(BaseShape) ** | ||
- | This method returns if the current shape and the targetShape have no points in common. | + | * //This method returns if the current shape and the targetShape have no points in common.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 557: | Line 560: | ||
** {{wiki:PublicMethod.gif|}} IsDisjointed(Feature) ** | ** {{wiki:PublicMethod.gif|}} IsDisjointed(Feature) ** | ||
- | This method returns if the current shape and the targetFeature have no points in common. | + | * //This method returns if the current shape and the targetFeature have no points in common.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 573: | Line 576: | ||
** {{wiki:PublicMethod.gif|}} Intersects(BaseShape) ** | ** {{wiki:PublicMethod.gif|}} Intersects(BaseShape) ** | ||
- | This method returns if the current shape and the targetShape have at least one point in common. | + | * //This method returns if the current shape and the targetShape have at least one point in common.// |
== Remarks == | == 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. | + | * //As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 589: | Line 592: | ||
** {{wiki:PublicMethod.gif|}} Intersects(Feature) ** | ** {{wiki:PublicMethod.gif|}} Intersects(Feature) ** | ||
- | This method returns if the current shape and the targetFeature have at least one point in common. | + | * //This method returns if the current shape and the targetFeature have at least one point in common.// |
== Remarks == | == 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. | + | * //As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 605: | Line 608: | ||
** {{wiki:PublicMethod.gif|}} Touches(BaseShape) ** | ** {{wiki:PublicMethod.gif|}} Touches(BaseShape) ** | ||
- | This method returns if the current shape and the targetShape have at least one boundary point in common, but no interior points. | + | * //This method returns if the current shape and the targetShape have at least one boundary point in common, but no interior points.// |
== Remarks == | == 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. | + | * //As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 621: | Line 624: | ||
** {{wiki:PublicMethod.gif|}} Touches(Feature) ** | ** {{wiki:PublicMethod.gif|}} Touches(Feature) ** | ||
- | This method returns of the current shape and the targetFeature have at least one boundary point in common, but no interior points. | + | * //This method returns of the current shape and the targetFeature have at least one boundary point in common, but no interior points.// |
== Remarks == | == 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. | + | * //As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 637: | Line 640: | ||
** {{wiki:PublicMethod.gif|}} Crosses(BaseShape) ** | ** {{wiki:PublicMethod.gif|}} Crosses(BaseShape) ** | ||
- | This method returns if the current shape and the targetShape share some but not all interior points. | + | * //This method returns if the current shape and the targetShape share some but not all interior points.// |
== Remarks == | == 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. | + | * //As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 653: | Line 656: | ||
** {{wiki:PublicMethod.gif|}} Crosses(Feature) ** | ** {{wiki:PublicMethod.gif|}} Crosses(Feature) ** | ||
- | This method returns if the current shape and the targetFeature share some but not all interior points. | + | * //This method returns if the current shape and the targetFeature share some but not all interior points.// |
== Remarks == | == 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. | + | * //As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 669: | Line 672: | ||
** {{wiki:PublicMethod.gif|}} IsWithin(BaseShape) ** | ** {{wiki:PublicMethod.gif|}} IsWithin(BaseShape) ** | ||
- | This method returns if the current shape lies within the interior of the targetShape. | + | * //This method returns if the current shape lies within the interior of the targetShape.// |
== Remarks == | == 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. | + | * //As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 685: | Line 688: | ||
** {{wiki:PublicMethod.gif|}} IsWithin(Feature) ** | ** {{wiki:PublicMethod.gif|}} IsWithin(Feature) ** | ||
- | This method returns if the current shape lies within the interior of the targetFeature. | + | * //This method returns if the current shape lies within the interior of the targetFeature.// |
== Remarks == | == 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. | + | * //As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 701: | Line 704: | ||
** {{wiki:PublicMethod.gif|}} Contains(BaseShape) ** | ** {{wiki:PublicMethod.gif|}} Contains(BaseShape) ** | ||
- | This method returns if the targetShape lies within the interior of the current shape. | + | * //This method returns if the targetShape lies within the interior of the current shape.// |
== Remarks == | == 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. | + | * //As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 717: | Line 720: | ||
** {{wiki:PublicMethod.gif|}} Contains(Feature) ** | ** {{wiki:PublicMethod.gif|}} Contains(Feature) ** | ||
- | This method returns if the targetFeature lies within the interior of the current shape. | + | * //This method returns if the targetFeature lies within the interior of the current shape.// |
== Remarks == | == 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. | + | * //As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 733: | Line 736: | ||
** {{wiki:PublicMethod.gif|}} Overlaps(BaseShape) ** | ** {{wiki:PublicMethod.gif|}} Overlaps(BaseShape) ** | ||
- | This method returns if the current shape and the targetShape share some but not all points in common. | + | * //This method returns if the current shape and the targetShape share some but not all points in common.// |
== Remarks == | == 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. | + | * //As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 749: | Line 752: | ||
** {{wiki:PublicMethod.gif|}} Overlaps(Feature) ** | ** {{wiki:PublicMethod.gif|}} Overlaps(Feature) ** | ||
- | This method returns if the current shape and the targetFeature share some but not all points in common. | + | * //This method returns if the current shape and the targetFeature share some but not all points in common.// |
== Remarks == | == 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. | + | * //As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 765: | Line 768: | ||
** {{wiki:PublicMethod.gif|}} IsTopologicallyEqual(BaseShape) ** | ** {{wiki:PublicMethod.gif|}} IsTopologicallyEqual(BaseShape) ** | ||
- | This method returns if the current shape and the targetShape are topologically equal. | + | * //This method returns if the current shape and the targetShape are topologically equal.// |
== Remarks == | == 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. | + | * //Topologically equal means that the shapes are essentially the same. For example, let's say you have a line with two points, point A and point B. You also have another line that is made up of point A, point B and point C. Point A of line one shares the same vertex as point A of line two, and point B of line one shares the same vertex as point C of line two. They are both straight lines, so point B of line two would lie on the first line. Essentially the two lines are the same, with line 2 having just one extra point. Topologically they are the same line, so this method would return true. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 781: | Line 784: | ||
** {{wiki:PublicMethod.gif|}} IsTopologicallyEqual(Feature) ** | ** {{wiki:PublicMethod.gif|}} IsTopologicallyEqual(Feature) ** | ||
- | This method returns if the current shape and the targetFeature are topologically equal. | + | * //This method returns if the current shape and the targetFeature are topologically equal.// |
== Remarks == | == 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. | + | * //Topologically equal means that the shapes are essentially the same. For example, let's say you have a line with two points, point A and point B. You also have another line that is made up of point A, point B and point C. Point A of line one shares the same vertex as point A of line two, and point B of line one shares the same vertex as point C of line two. They are both straight lines, so point B of line two would lie on the first line. Essentially the two lines are the same, with line 2 having just one extra point. Topologically they are the same line, so this method would return true. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 797: | Line 800: | ||
** {{wiki:PublicMethod.gif|}} GetFeature() ** | ** {{wiki:PublicMethod.gif|}} GetFeature() ** | ||
- | Get a corresponding feature which has the same Id and BaseShape as the current shape. | + | * //Get a corresponding feature which has the same Id and BaseShape as the current shape.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 809: | Line 812: | ||
** {{wiki:PublicMethod.gif|}} GetFeature(IDictionary<String,String>) ** | ** {{wiki:PublicMethod.gif|}} GetFeature(IDictionary<String,String>) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 825: | Line 828: | ||
** {{wiki:PublicMethod.gif|}} GetCrossing(BaseShape) ** | ** {{wiki:PublicMethod.gif|}} GetCrossing(BaseShape) ** | ||
- | This method returns the crossing points between the current shape and the passed-in target shape. | + | * //This method returns the crossing points between the current shape and the passed-in target shape.// |
== Remarks == | == 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. | + | * //As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 841: | Line 844: | ||
** {{wiki:PublicMethod.gif|}} ScaleTo(Double) ** | ** {{wiki:PublicMethod.gif|}} ScaleTo(Double) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 857: | Line 860: | ||
** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 869: | Line 872: | ||
** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 885: | Line 888: | ||
** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 897: | Line 900: | ||
** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 909: | Line 912: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} CreateShapeFromWellKnownData(String) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} CreateShapeFromWellKnownData(String) ** | ||
- | This method creates a BaseShape from a string of well-known text. | + | * //This method creates a BaseShape from a string of well-known text.// |
== Remarks == | == 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))) | + | * //This method creates a BaseShape from a string of well-known text. Well-known text allows you to describe geometries as a string of text. Well-known text is useful when you want to save a geometry in a format such as a text file, or when you simply want to cut and paste the text between other applications. An alternative to well-known text is well-known binary, which is a binary representation of a geometry object. We have methods that work with well-known binary as well. Below are some samples of what well-known text might look like for various kinds of geometries.POINT(5 17)LINESTRING(4 5,10 50,25 80)POLYGON((2 2,6 2,6 6,2 6,2 2),(3 3,4 3,4 4,3 4,3 3))MULTIPOINT(3.7 9.7,4.9 11.6)MULTILINESTRING((4 5,11 51,21 26),(-4 -7,-9 -7,-14 -3))MULTIPOLYGON(((2 2,6 2,6 6,2 6,2 2),(3 3,4 3,4 4,3 4,3 3)),((4 4,7 3,7 5,4 4)))// |
== Return Value == | == Return Value == | ||
Line 925: | Line 928: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} CreateShapeFromWellKnownData(Byte[]) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} CreateShapeFromWellKnownData(Byte[]) ** | ||
- | This method creates a BaseShape from a string of well-known binary. | + | * //This method creates a BaseShape from a string of well-known binary.// |
== Remarks == | == 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. | + | * //This method creates a BaseShape from a string of well-known binary. Well-known binary allows you to describe geometries as a binary array. Well-known binary is useful when you want to save a geometry in an efficient format using as little space as possible. An alternative to well-known binary is well-known text, which is a textual representation of a geometry object. We have methods that work with well-known text as well.// |
== Return Value == | == Return Value == | ||
Line 941: | Line 944: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} TranslateByOffset(BaseShape,Double,Double,GeographyUnit,DistanceUnit) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} 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. | + | * //This method returns a shape repositioned from one location to another based on an X and Y offset distance.// |
== Remarks == | == 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. | + | * //This method returns a shape repositioned from one location to another based on an X and Y offset distance. With this overload, it is important to note that the X and Y offset units are based on the distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with an X offset of 1 and a Y offset of 1, you're going to move this shape one unit of the distanceUnit in the horizontal direction and one unit of the distanceUnit in the vertical direction. In this way, you can easily move a shape in decimal degrees five miles on the X axis and 3 miles on the Y axis. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 973: | Line 976: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} TranslateByOffset(Feature,Double,Double,GeographyUnit,DistanceUnit) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} 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. | + | * //This method returns a feature repositioned from one location to another based on an X and Y offset distance.// |
== Remarks == | == 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. | + | * //This method returns a feature repositioned from one location to another based on an X and Y offset distance. With this overload, it is important to note that the X and Y offset units are based on the distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with an X offset of 1 and a Y offset of 1, you're going to move this shape one unit of the distanceUnit in the horizontal direction and one unit of the distanceUnit in the vertical direction. In this way, you can easily move a shape in decimal degrees five miles on the X axis and 3 miles on the Y axis. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 1005: | Line 1008: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} TranslateByDegree(BaseShape,Double,Double,GeographyUnit,DistanceUnit) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} 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. | + | * //This method returns a shape repositioned from one location to another based on a distance and a direction in degrees.// |
== Remarks == | == 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. | + | * //This method returns a shape repositioned from one location to another based on angleInDegrees and distance parameter. With this overload, it is important to note that the distance is based on the supplied distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with a distanceUnit of miles, you're going to move this shape a number of miles based on the distance value and the angleInDegrees. In this way, you can easily move a shape in decimal degrees five miles to the north.If you pass a distance of 0, then the operation is ignored. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 1037: | Line 1040: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} TranslateByDegree(Feature,Double,Double,GeographyUnit,DistanceUnit) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} 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. | + | * //This method returns a feature repositioned from one location to another, based on a distance and a direction in degrees.// |
== Remarks == | == 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. | + | * //This method returns a feature repositioned from one location to another based on angleInDegrees and distance parameter. With this overload, it is important to note that the distance is based on the supplied distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with a distanceUnit of miles, you're going to move this feature a number of miles based on the distance value and the angleInDegrees. In this way, you can easily move a shape in decimal degrees five miles to the north.If you pass a distance of 0, then the operation is ignored. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 1069: | Line 1072: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} Rotate(BaseShape,PointShape,Single) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} Rotate(BaseShape,PointShape,Single) ** | ||
- | This method returns a shape rotated by a number of degrees based on a pivot point. | + | * //This method returns a shape rotated by a number of degrees based on a pivot point.// |
== Remarks == | == 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. | + | * //This method returns a shape rotated by a number of degrees based on a pivot point. By placing the pivot point in the center of the shape you can achieve in-place rotation. By moving the pivot point outside of the center of the shape you can translate the shape in a circular motion. Moving the pivot point further outside of the center will make the circular area larger. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 1093: | Line 1096: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} Rotate(Feature,PointShape,Single) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} Rotate(Feature,PointShape,Single) ** | ||
- | This method returns a feature rotated by a number of degrees based on a pivot point. | + | * //This method returns a feature rotated by a number of degrees based on a pivot point.// |
== Remarks == | == 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. | + | * //This method returns a feature rotated by a number of degrees based on a pivot point. By placing the pivot point in the center of the feature you can achieve in-place rotation. By moving the pivot point outside of the center of the feature you can translate the feature in a circular motion. Moving the pivot point further outside of the center will make the circular area larger. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 1117: | Line 1120: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ScaleTo(BaseShape,Double) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ScaleTo(BaseShape,Double) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 1138: | Line 1141: | ||
** {{wiki:ProtectedMethod.gif|}} LoadFromWellKnownDataCore(String) ** | ** {{wiki:ProtectedMethod.gif|}} LoadFromWellKnownDataCore(String) ** | ||
- | This method hydrates the current shape with its data from well-known text. | + | * //This method hydrates the current shape with its data from well-known text.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 1154: | Line 1157: | ||
** {{wiki:ProtectedMethod.gif|}} GetWellKnownTextCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetWellKnownTextCore() ** | ||
- | This method returns the well-known text representation of this shape. | + | * //This method returns the well-known text representation of this shape.// |
== Remarks == | == 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. | + | * //This method returns a stringthat represents the shape in well-known text. Well-known text allows you to describe geometries as a string of text. Well-known text is useful when you want to save a geometry in a format such as a text file, or when you simply want to cut and paste the text between other applications. An alternative to well-known text is well-known binary, which is a binary representation of a geometry object. We have methods that work with well-known binary as well. Below are some samples of what well-known text might look like for various kinds of geometries.POINT(5 17)LINESTRING(4 5,10 50,25 80)POLYGON((2 2,6 2,6 6,2 6,2 2),(3 3,4 3,4 4,3 4,3 3))MULTIPOINT(3.7 9.7,4.9 11.6)MULTILINESTRING((4 5,11 51,21 26),(-4 -7,-9 -7,-14 -3))MULTIPOLYGON(((2 2,6 2,6 6,2 6,2 2),(3 3,4 3,4 4,3 4,3 3)),((4 4,7 3,7 5,4 4))) Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.// |
== Return Value == | == Return Value == | ||
Line 1166: | Line 1169: | ||
** {{wiki:ProtectedMethod.gif|}} LoadFromWellKnownDataCore(Byte[]) ** | ** {{wiki:ProtectedMethod.gif|}} LoadFromWellKnownDataCore(Byte[]) ** | ||
- | This method hydrates the current shape with its data from well-known binary. | + | * //This method hydrates the current shape with its data from well-known binary.// |
== Remarks == | == 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. | + | * //This is used when you want to hydrate a shape based on well-known binary. You can create the shape and then load the well-known binary using this method.// |
== Return Value == | == Return Value == | ||
Line 1182: | Line 1185: | ||
** {{wiki:ProtectedMethod.gif|}} GetWellKnownBinaryCore(WkbByteOrder) ** | ** {{wiki:ProtectedMethod.gif|}} GetWellKnownBinaryCore(WkbByteOrder) ** | ||
- | This method returns a byte array that represents the shape in well-known binary. | + | * //This method returns a byte array that represents the shape in well-known binary.// |
== Remarks == | == 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. | + | * //This method returns a byte array that represents the shape in well-known binary. Well-known binary allows you to describe geometries as a binary array. Well-known binary is useful when you want to save a geometry in an efficient format using as little space as possible. An alternative to well-known binary is well-known text, which is a textual representation of a geometry object. We have methods that work with well known text as well. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.// |
== Return Value == | == Return Value == | ||
Line 1198: | Line 1201: | ||
** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** | ||
- | This method calculates the smallest RectangleShape that encompasses the entire geometry. | + | * //This method calculates the smallest RectangleShape that encompasses the entire geometry.// |
== Remarks == | == 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. | + | * //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.// |
== Return Value == | == Return Value == | ||
Line 1210: | Line 1213: | ||
** {{wiki:ProtectedMethod.gif|}} GetWellKnownTypeCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetWellKnownTypeCore() ** | ||
- | This method returns the well-known type for the shape. | + | * //This method returns the well-known type for the shape.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 1222: | Line 1225: | ||
** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ||
- | This method returns a complete copy of the shape without any references in common. | + | * //This method returns a complete copy of the shape without any references in common.// |
== Remarks == | == Remarks == | ||
- | When you override this method, you need to ensure that there are no references in common between the original and copy. | + | * //When you override this method, you need to ensure that there are no references in common between the original and copy.// |
== Return Value == | == Return Value == | ||
Line 1234: | Line 1237: | ||
** {{wiki:ProtectedMethod.gif|}} TranslateByOffsetCore(Double,Double,GeographyUnit,DistanceUnit) ** | ** {{wiki:ProtectedMethod.gif|}} TranslateByOffsetCore(Double,Double,GeographyUnit,DistanceUnit) ** | ||
- | This method moves a base shape from one location to another based on an X and Y offset distance. | + | * //This method moves a base shape from one location to another based on an X and Y offset distance.// |
== Remarks == | == 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. | + | * //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.// |
== Return Value == | == Return Value == | ||
Line 1262: | Line 1265: | ||
** {{wiki:ProtectedMethod.gif|}} TranslateByDegreeCore(Double,Double,GeographyUnit,DistanceUnit) ** | ** {{wiki:ProtectedMethod.gif|}} 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. | + | * //This method moves a base shape from one location to another based on a distance and a direction in degrees.// |
== Remarks == | == 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. | + | * //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.// |
== Return Value == | == Return Value == | ||
Line 1290: | Line 1293: | ||
** {{wiki:ProtectedMethod.gif|}} RotateCore(PointShape,Single) ** | ** {{wiki:ProtectedMethod.gif|}} RotateCore(PointShape,Single) ** | ||
- | This method rotates a shape a number of degrees based on a pivot point. | + | * //This method rotates a shape a number of degrees based on a pivot point.// |
== Remarks == | == 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. | + | * //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.// |
== Return Value == | == Return Value == | ||
Line 1310: | Line 1313: | ||
** {{wiki:ProtectedMethod.gif|}} GetShortestLineToCore(BaseShape,GeographyUnit) ** | ** {{wiki:ProtectedMethod.gif|}} GetShortestLineToCore(BaseShape,GeographyUnit) ** | ||
- | This method returns the shortest LineShape between this shape and the targetShape parameter. | + | * //This method returns the shortest LineShape between this shape and the targetShape parameter.// |
== Remarks == | == 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. | + | * //This method returns a LineShape representing the shortest distance between the shape you're calling the method on and the targetShape. In some instances, based on the GeographicType or Projection, the line may not be straight. This is effect is similar to what you might see on an international flight when the displayed flight path is curved. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.// |
== Return Value == | == Return Value == | ||
Line 1330: | Line 1333: | ||
** {{wiki:ProtectedMethod.gif|}} GetClosestPointToCore(BaseShape,GeographyUnit) ** | ** {{wiki:ProtectedMethod.gif|}} GetClosestPointToCore(BaseShape,GeographyUnit) ** | ||
- | This method returns the point of the current shape that is closest to the target shape. | + | * //This method returns the point of the current shape that is closest to the target shape.// |
== Remarks == | == 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. | + | * //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.// |
== Return Value == | == Return Value == | ||
Line 1350: | Line 1353: | ||
** {{wiki:ProtectedMethod.gif|}} GetCenterPointCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetCenterPointCore() ** | ||
- | This method returns the center point of the current shape's bounding box. | + | * //This method returns the center point of the current shape's bounding box.// |
== Remarks == | == 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. | + | * //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.// |
== Return Value == | == Return Value == | ||
Line 1362: | Line 1365: | ||
** {{wiki:ProtectedMethod.gif|}} BufferCore(Double,Int32,BufferCapType,GeographyUnit,DistanceUnit) ** | ** {{wiki:ProtectedMethod.gif|}} BufferCore(Double,Int32,BufferCapType,GeographyUnit,DistanceUnit) ** | ||
- | This method computes the area containing all of the points within a given distance from this shape. | + | * //This method computes the area containing all of the points within a given distance from this shape.// |
== Remarks == | == 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. | + | * //This method computes the area containing all of the points within a given distance from this shape. In this case, you will be using the rounded RoundedBufferCapStyle and the default 8 quadrant segments. The distance unit is determined by the distanceUnit argument. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.// |
== Return Value == | == Return Value == | ||
Line 1394: | Line 1397: | ||
** {{wiki:ProtectedMethod.gif|}} GetDistanceToCore(BaseShape,GeographyUnit,DistanceUnit) ** | ** {{wiki:ProtectedMethod.gif|}} GetDistanceToCore(BaseShape,GeographyUnit,DistanceUnit) ** | ||
- | This method computes the distance between the current shape and the targetShape. | + | * //This method computes the distance between the current shape and the targetShape.// |
== Remarks == | == Remarks == | ||
- | In this method we compute the closest distance between the two shapes. The returned unit will be in the unit of distance specified. | + | * //In this method we compute the closest distance between the two shapes. The returned unit will be in the unit of distance specified.// |
== Return Value == | == Return Value == | ||
Line 1418: | Line 1421: | ||
** {{wiki:ProtectedMethod.gif|}} RegisterCore(PointShape,PointShape,DistanceUnit,GeographyUnit) ** | ** {{wiki:ProtectedMethod.gif|}} 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. | + | * //This method returns a BaseShape which has been registered from its original coordinate system to another based on two anchor PointShapes.// |
== Remarks == | == 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. | + | * //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.// |
== Return Value == | == Return Value == | ||
Line 1446: | Line 1449: | ||
** {{wiki:ProtectedMethod.gif|}} ValidateCore(ShapeValidationMode) ** | ** {{wiki:ProtectedMethod.gif|}} ValidateCore(ShapeValidationMode) ** | ||
- | This method returns a ShapeValidationResult based on a series of tests. | + | * //This method returns a ShapeValidationResult based on a series of tests.// |
== Remarks == | == 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. | + | * //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.// |
== Return Value == | == Return Value == | ||
Line 1462: | Line 1465: | ||
** {{wiki:ProtectedMethod.gif|}} IsDisjointedCore(BaseShape) ** | ** {{wiki:ProtectedMethod.gif|}} IsDisjointedCore(BaseShape) ** | ||
- | This method returns if the current shape and the targetShape have no points in common. | + | * //This method returns if the current shape and the targetShape have no points in common.// |
== Remarks == | == Remarks == | ||
- | Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above. | + | * //Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.// |
== Return Value == | == Return Value == | ||
Line 1478: | Line 1481: | ||
** {{wiki:ProtectedMethod.gif|}} IntersectsCore(BaseShape) ** | ** {{wiki:ProtectedMethod.gif|}} IntersectsCore(BaseShape) ** | ||
- | This method returns if the current shape and the targetShape have at least one point in common. | + | * //This method returns if the current shape and the targetShape have at least one point in common.// |
== Remarks == | == Remarks == | ||
- | Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above. | + | * //Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.// |
== Return Value == | == Return Value == | ||
Line 1494: | Line 1497: | ||
** {{wiki:ProtectedMethod.gif|}} TouchesCore(BaseShape) ** | ** {{wiki:ProtectedMethod.gif|}} TouchesCore(BaseShape) ** | ||
- | This method returns if the current shape and the targetShape have at least one boundary point in common, but no interior points. | + | * //This method returns if the current shape and the targetShape have at least one boundary point in common, but no interior points.// |
== Remarks == | == Remarks == | ||
- | Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above. | + | * //Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.// |
== Return Value == | == Return Value == | ||
Line 1510: | Line 1513: | ||
** {{wiki:ProtectedMethod.gif|}} CrossesCore(BaseShape) ** | ** {{wiki:ProtectedMethod.gif|}} CrossesCore(BaseShape) ** | ||
- | This method returns if the current shape and the targetShape share some but not all interior points. | + | * //This method returns if the current shape and the targetShape share some but not all interior points.// |
== Remarks == | == Remarks == | ||
- | Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above. | + | * //Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.// |
== Return Value == | == Return Value == | ||
Line 1526: | Line 1529: | ||
** {{wiki:ProtectedMethod.gif|}} IsWithinCore(BaseShape) ** | ** {{wiki:ProtectedMethod.gif|}} IsWithinCore(BaseShape) ** | ||
- | This method returns if the current shape lies within the interior of the targetShape. | + | * //This method returns if the current shape lies within the interior of the targetShape.// |
== Remarks == | == Remarks == | ||
- | Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above. | + | * //Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.// |
== Return Value == | == Return Value == | ||
Line 1542: | Line 1545: | ||
** {{wiki:ProtectedMethod.gif|}} ContainsCore(BaseShape) ** | ** {{wiki:ProtectedMethod.gif|}} ContainsCore(BaseShape) ** | ||
- | This method returns if the targetShape lies within the interior of the current shape. | + | * //This method returns if the targetShape lies within the interior of the current shape.// |
== Remarks == | == Remarks == | ||
- | Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above. | + | * //Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.// |
== Return Value == | == Return Value == | ||
Line 1558: | Line 1561: | ||
** {{wiki:ProtectedMethod.gif|}} OverlapsCore(BaseShape) ** | ** {{wiki:ProtectedMethod.gif|}} OverlapsCore(BaseShape) ** | ||
- | This method returns if the current shape and the targetShape share some but not all points in common. | + | * //This method returns if the current shape and the targetShape share some but not all points in common.// |
== Remarks == | == Remarks == | ||
- | Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above. | + | * //Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.// |
== Return Value == | == Return Value == | ||
Line 1574: | Line 1577: | ||
** {{wiki:ProtectedMethod.gif|}} IsTopologicallyEqualCore(BaseShape) ** | ** {{wiki:ProtectedMethod.gif|}} IsTopologicallyEqualCore(BaseShape) ** | ||
- | This method returns if the current shape and the targetShape are topologically equal. | + | * //This method returns if the current shape and the targetShape are topologically equal.// |
== Remarks == | == 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. | + | * //Topologically equal means that the shapes are essentially the same. For example, let's say you have a line with two points, point A and point B. You also have another line that is made up of point A, point B and point C. Point A of line one shares the same vertex as point A of line two, and point B of line one shares the same vertex as point C of line two. They are both straight lines, so point B of line two would lie on the first line. Essentially the two lines are the same, with line 2 having just one extra point. Topologically they are the same line, so this method would return true. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.// |
== Return Value == | == Return Value == | ||
Line 1590: | Line 1593: | ||
** {{wiki:ProtectedMethod.gif|}} GetCrossingCore(BaseShape) ** | ** {{wiki:ProtectedMethod.gif|}} GetCrossingCore(BaseShape) ** | ||
- | This method returns the crossing points between the current shape and the passed-in target shape. | + | * //This method returns the crossing points between the current shape and the passed-in target shape.// |
== Remarks == | == 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. | + | * //As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
Line 1606: | Line 1609: | ||
** {{wiki:ProtectedMethod.gif|}} ScaleToCore(Double) ** | ** {{wiki:ProtectedMethod.gif|}} ScaleToCore(Double) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 1622: | Line 1625: | ||
** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 1634: | Line 1637: | ||
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == |