User Tools

Site Tools


thinkgeo.mapsuite.core.rectangleshape

This is an old revision of the document!


Table of Contents

ThinkGeo.MapSuite.Core.RectangleShape

This class represents a rectangle, which is defined as an upper left point and a lower right point.

Inheritance Hierarchy

  • System.Object
    • ThinkGeo.MapSuite.Core.BaseShape
      • ThinkGeo.MapSuite.Core.AreaBaseShape
        • ThinkGeo.MapSuite.Core.RectangleShape

Members Summary

Public Constructors

RectangleShape

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:This constructor creates a RectangleShape.

RectangleShape

  • DeclaringType:N/A
  • Summary:This constructor creates a RectangleShape.

RectangleShape

  • Parameters:Double,Double,Double,Double
  • DeclaringType:N/A
  • Summary:This constructor creates a RectangleShape.

RectangleShape

  • Parameters:String
  • DeclaringType:N/A
  • Summary:This constructor creates a RectangleShape.

RectangleShape

  • Parameters:Byte[]
  • DeclaringType:N/A
  • Summary:This constructor creates a RectangleShape.

Protected Constructors

Public Methods

Buffer

Buffer

Buffer

CloneDeep

  • Parameters:N/A
  • DeclaringType:BaseShape
  • Summary:N/A

Contains

Contains

Crosses

Crosses

Equals

  • Parameters:Object
  • DeclaringType:Object
  • Summary:N/A

ExpandToInclude

  • Parameters:BaseShape
  • DeclaringType:N/A
  • Summary:This method will expand the current RectangleShape to include the targetShape parameter.

ExpandToInclude

  • Parameters:IEnumerable<BaseShape>
  • DeclaringType:N/A
  • Summary:This method will expand the current RectangleShape to include the shapes in the targetShapes parameter.

ExpandToInclude

  • Parameters:Feature
  • DeclaringType:N/A
  • Summary:This method will expand the current RectangleShape to include the target feature parameter.

ExpandToInclude

  • Parameters:IEnumerable<Feature>
  • DeclaringType:N/A
  • Summary:This method will expand the current RectangleShape to include the features in the targetFeatures parameter.

GetAccurateArea

GetAccurateArea

GetAccuratePerimeter

GetAccuratePerimeter

GetArea

GetBoundingBox

  • Parameters:N/A
  • DeclaringType:BaseShape
  • Summary:N/A

GetCenterPoint

  • Parameters:N/A
  • DeclaringType:BaseShape
  • Summary:N/A

GetClosestPointTo

GetClosestPointTo

GetConvexHull

GetCrossing

GetDifference

GetDifference

GetDistanceTo

GetDistanceTo

GetFeature

  • Parameters:N/A
  • DeclaringType:BaseShape
  • Summary:N/A

GetFeature

  • Parameters:IDictionary<String,String>
  • DeclaringType:BaseShape
  • Summary:N/A

GetGeoJson

  • Parameters:N/A
  • DeclaringType:BaseShape
  • Summary:N/A

GetHashCode

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

GetIntersection

GetIntersection

GetIntersection

  • Parameters:RectangleShape
  • DeclaringType:N/A
  • Summary:This method returns the intersection of the current RectangleShape and the target shape, defined as the set of all points which lie in both the current shape and the target shape.

GetPerimeter

GetShortestLineTo

GetShortestLineTo

GetSymmetricalDifference

GetSymmetricalDifference

GetType

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

GetWellKnownBinary

GetWellKnownBinary

GetWellKnownBinary

GetWellKnownBinary

  • Parameters:N/A
  • DeclaringType:BaseShape
  • Summary:N/A

GetWellKnownText

  • Parameters:N/A
  • DeclaringType:BaseShape
  • Summary:N/A

GetWellKnownText

GetWellKnownType

  • Parameters:N/A
  • DeclaringType:BaseShape
  • Summary:N/A

Intersects

Intersects

IsDisjointed

IsDisjointed

IsTopologicallyEqual

IsTopologicallyEqual

IsWithin

IsWithin

LoadFromWellKnownData

  • Parameters:Byte[]
  • DeclaringType:BaseShape
  • Summary:N/A

LoadFromWellKnownData

  • Parameters:String
  • DeclaringType:BaseShape
  • Summary:N/A

Overlaps

Overlaps

Register

Register

Rotate

ScaleDown

ScaleTo

  • Parameters:Double
  • DeclaringType:BaseShape
  • Summary:N/A

ScaleUp

Simplify

Simplify

ToPolygon

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:This method returns the current shape as a PolygonShape.

ToString

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:This method returns a formatted representation of the UpperLeftPoint.X, UpperLeftPoint.Y, LowerRightPoint.X and LowerRightPoint.Y value.

Touches

Touches

TranslateByDegree

  • Parameters:Double,Double
  • DeclaringType:BaseShape
  • Summary:N/A

TranslateByDegree

TranslateByOffset

TranslateByOffset

  • Parameters:Double,Double
  • DeclaringType:BaseShape
  • Summary:N/A

Union

Union

Validate

Protected Methods

BufferCore

CloneDeepCore

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:This method returns a complete copy of the shape without any references in common.

ContainsCore

  • Parameters:BaseShape
  • DeclaringType:N/A
  • Summary:This method returns if the targetShape lies within the interior of the current shape.

CrossesCore

ExpandToIncludeCore

  • Parameters:BaseShape
  • DeclaringType:N/A
  • Summary:This method will expand the current RectangleShape to include the shape in the targetShape parameter.

Finalize

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

GetAccurateAreaCore

GetAccuratePerimeterCore

GetAreaCore

  • DeclaringType:N/A
  • Summary:This method returns the area of the shape (defined as the size of the region enclosed by the figure).

GetBoundingBoxCore

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:This method calculates the smallest RectangleShape that encompasses the entire geometry.

GetCenterPointCore

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:This method returns the center point of the current shape's bounding box.

GetClosestPointToCore

  • DeclaringType:N/A
  • Summary:This method returns the point of the current shape that is closest to the target shape.

GetConvexHullCore

GetCrossingCore

  • Parameters:BaseShape
  • DeclaringType:N/A
  • Summary:This method returns the crossing points between the current shape and the passed-in target shape.

GetDifferenceCore

GetDistanceToCore

GetGeoJsonCore

  • Parameters:N/A
  • DeclaringType:BaseShape
  • Summary:N/A

GetIntersectionCore

GetPerimeterCore

  • DeclaringType:N/A
  • Summary:This method returns the perimeter of the shape (defined as the sum of the lengths of all its sides).

GetShortestLineToCore

GetSymmetricalDifferenceCore

GetWellKnownBinaryCore

  • DeclaringType:N/A
  • Summary:This method returns a byte array that represents the shape in well-known binary.

GetWellKnownTextCore

  • Parameters:RingOrder
  • DeclaringType:N/A
  • Summary:This method returns the well-known text representation of this shape.

GetWellKnownTypeCore

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:This method returns the well-known type for the shape.

IntersectsCore

IsDisjointedCore

  • Parameters:BaseShape
  • DeclaringType:N/A
  • Summary:This method returns whether the current shape and the targetShape have no points in common.

IsTopologicallyEqualCore

IsWithinCore

LoadFromWellKnownDataCore

  • Parameters:Byte[]
  • DeclaringType:N/A
  • Summary:This method hydrates the current shape with its data from well-known binary.

LoadFromWellKnownDataCore

  • Parameters:String
  • DeclaringType:N/A
  • Summary:This method hydrates the current shape with its data from well-known text.

MemberwiseClone

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

OverlapsCore

RegisterCore

  • DeclaringType:N/A
  • Summary:This method returns a MultipointShape which has been registered from its original coordinate system to another based on two anchor PointShapes.

RotateCore

ScaleDownCore

  • Parameters:Double
  • DeclaringType:N/A
  • Summary:This method decreases the size of the area shape by the percentage given in the percentage parameter.

ScaleToCore

  • Parameters:Double
  • DeclaringType:BaseShape
  • Summary:N/A

ScaleUpCore

  • Parameters:Double
  • DeclaringType:N/A
  • Summary:This method increases the size of the area shape by the percentage given in the percentage parameter.

SimplifyCore

TouchesCore

TranslateByDegreeCore

  • Parameters:Double,Double,GeographyUnit,DistanceUnit
  • DeclaringType:N/A
  • Summary:This method moves the shape from one location to another, based on a direction in degrees and distance.

TranslateByOffsetCore

  • Parameters:Double,Double,GeographyUnit,DistanceUnit
  • DeclaringType:N/A
  • Summary:This method moves the base shape from one location to another, based on an X and Y offset distance.

UnionCore

ValidateCore

  • DeclaringType:N/A
  • Summary:This method returns a ShapeValidationResult based on a series of tests.

Public Properties

CanRotate

  • Return:Boolean
  • Summary:N/A

Height

  • Return:Double
  • Summary:This property returns the height of the RectangleShape in the unit of the shape.

Id

  • Return:String
  • Summary:N/A

LowerLeftPoint

  • Return:PointShape
  • Summary:This property returns the PointShape that represents the lower left point of the RectangleShape.

LowerRightPoint

  • Return:PointShape
  • Summary:This property returns or sets the PointShape that represents the lower right point of the RectangleShape.

Tag

  • Return:Object
  • Summary:N/A

UpperLeftPoint

  • Return:PointShape
  • Summary:This property returns or sets the PointShape that represents the upper left point of the RectangleShape.

UpperRightPoint

  • Return:PointShape
  • Summary:This property returns the PointShape that represents the upper right point of the RectangleShape.

Width

  • Return:Double
  • Summary:This property returns the width of the RectangleShape in the unit of the shape.

Protected Properties

Public Events

Public Constructors

RectangleShape()

This constructor creates a RectangleShape.

Remarks

None

Parameters

RectangleShape(PointShape,PointShape)

This constructor creates a RectangleShape.

Remarks

None

Parameters

upperLeftPoint

  • Description:This parameter specifies the upper left point of the rectangle. lowerRightPoint * Type:PointShape * Description:This parameter specifies the lower right point of the rectangle.

Go Back

RectangleShape(Double,Double,Double,Double)

This constructor creates a RectangleShape.

Remarks

None

Parameters

minX

  • Type:Double
  • Description:This property specifies the minimum X value. This is also the upper left X. maxY * Type:Double * Description:This property specifies the maximum Y value. This is also the upper left Y.

maxX

  • Type:Double
  • Description:This property specifies the maximum X value. This is also the lower right X. minY * Type:Double * Description:This property specifies the minimum Y value. This is also the lower right Y.

Go Back

RectangleShape(String)

This constructor creates a RectangleShape.

Remarks

None

Parameters

wellKnownText

  • Type:String
  • Description:This parameter is the well-known text used to build the shape. Go Back === RectangleShape(Byte[]) === This constructor creates a RectangleShape. ==== Remarks ==== None ==== Parameters ==== wellKnownBinary * Type:Byte[] * Description:This parameter is the well-known binary used to build the shape.

Go Back

Protected Constructors

Public Methods

Buffer(Double,Int32,GeographyUnit,DistanceUnit)

N/A

Remarks

N/A

Return Value

Parameters

distance

  • Type:Double
  • Description:N/A

quadrantSegments

  • Type:Int32
  • Description:N/A

shapeUnit

distanceUnit

Go Back

Buffer(Double,GeographyUnit,DistanceUnit)

N/A

Remarks

N/A

Return Value

Parameters

distance

  • Type:Double
  • Description:N/A

shapeUnit

distanceUnit

Go Back

Buffer(Double,Int32,BufferCapType,GeographyUnit,DistanceUnit)

N/A

Remarks

N/A

Return Value

Parameters

distance

  • Type:Double
  • Description:N/A

quadrantSegments

  • Type:Int32
  • Description:N/A

bufferCapType

shapeUnit

distanceUnit

Go Back

CloneDeep()

N/A

Remarks

N/A

Return Value

Parameters

Contains(Feature)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetFeature

Go Back

Contains(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

Crosses(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

Crosses(Feature)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetFeature

Go Back

Equals(Object)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

obj

  • Type:Object
  • Description:N/A

Go Back

ExpandToInclude(BaseShape)

This method will expand the current RectangleShape to include the targetShape parameter.

Remarks

There is also an overload that can expand the RectangleShape using a list of multiple shapes.

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

targetShape

  • Type:BaseShape
  • Description:This parameter is used to expand the current rectangle.

Go Back

ExpandToInclude(IEnumerable<BaseShape>)

This method will expand the current RectangleShape to include the shapes in the targetShapes parameter.

Remarks

There is also an overload that can expand the RectangleShape using a single shape.

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

targetShapes

  • Type:IEnumerable<BaseShape>
  • Description:This parameter is used to expand the current rectangle.

Go Back

ExpandToInclude(Feature)

This method will expand the current RectangleShape to include the target feature parameter.

Remarks

There is also an overload that can expand the RectangleShape using a collection of features.

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

targetFeature

  • Type:Feature
  • Description:This parameter is used to expand the current feature.

Go Back

ExpandToInclude(IEnumerable<Feature>)

This method will expand the current RectangleShape to include the features in the targetFeatures parameter.

Remarks

There also is an overload that can expand the RectangleShape using a single feature.

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

targetFeatures

  • Type:IEnumerable<Feature>
  • Description:This parameter is a group of features used to expand the current rectangle.

Go Back

GetAccurateArea(Int32,AreaUnit,DistanceCalculationMode)

N/A

Remarks

N/A

Return Value

  • Return Type:Double
  • Description:N/A

Parameters

shapeSrid

  • Type:Int32
  • Description:N/A

returningUnit

distanceCalculationMode

Go Back

GetAccurateArea(String,AreaUnit,DistanceCalculationMode)

N/A

Remarks

N/A

Return Value

  • Return Type:Double
  • Description:N/A

Parameters

shapeProj4ProjectionParameters

  • Type:String
  • Description:N/A

returningUnit

distanceCalculationMode

Go Back

GetAccuratePerimeter(Int32,DistanceUnit,DistanceCalculationMode)

N/A

Remarks

N/A

Return Value

  • Return Type:Double
  • Description:N/A

Parameters

shapeSrid

  • Type:Int32
  • Description:N/A

returningUnit

distanceCalculationMode

Go Back

GetAccuratePerimeter(String,DistanceUnit,DistanceCalculationMode)

N/A

Remarks

N/A

Return Value

  • Return Type:Double
  • Description:N/A

Parameters

shapeProj4ProjectionParameters

  • Type:String
  • Description:N/A

returningUnit

distanceCalculationMode

Go Back

GetArea(GeographyUnit,AreaUnit)

N/A

Remarks

N/A

Return Value

  • Return Type:Double
  • Description:N/A

Parameters

shapeUnit

returningUnit

Go Back

GetBoundingBox()

N/A

Remarks

N/A

Return Value

Parameters

GetCenterPoint()

N/A

Remarks

N/A

Return Value

Parameters

GetClosestPointTo(BaseShape,GeographyUnit)

N/A

Remarks

N/A

Return Value

Parameters

targetShape

shapeUnit

Go Back

GetClosestPointTo(Feature,GeographyUnit)

N/A

Remarks

N/A

Return Value

Parameters

targetFeature

shapeUnit

Go Back

GetConvexHull()

N/A

Remarks

N/A

Return Value

Parameters

GetCrossing(BaseShape)

N/A

Remarks

N/A

Return Value

Parameters

targetShape

Go Back

GetDifference(AreaBaseShape)

N/A

Remarks

N/A

Return Value

Parameters

targetShape

Go Back

GetDifference(Feature)

N/A

Remarks

N/A

Return Value

Parameters

targetFeature

Go Back

GetDistanceTo(Feature,GeographyUnit,DistanceUnit)

N/A

Remarks

N/A

Return Value

  • Return Type:Double
  • Description:N/A

Parameters

targetFeature

shapeUnit

distanceUnit

Go Back

GetDistanceTo(BaseShape,GeographyUnit,DistanceUnit)

N/A

Remarks

N/A

Return Value

  • Return Type:Double
  • Description:N/A

Parameters

targetShape

shapeUnit

distanceUnit

Go Back

GetFeature()

N/A

Remarks

N/A

Return Value

  • Return Type:Feature
  • Description:N/A

Parameters

GetFeature(IDictionary<String,String>)

N/A

Remarks

N/A

Return Value

  • Return Type:Feature
  • Description:N/A

Parameters

columnValues

  • Type:IDictionary<String,String>
  • Description:N/A

Go Back

GetGeoJson()

N/A

Remarks

N/A

Return Value

  • Return Type:String
  • Description:N/A

Parameters

GetHashCode()

N/A

Remarks

N/A

Return Value

  • Return Type:Int32
  • Description:N/A

Parameters

GetIntersection(Feature)

N/A

Remarks

N/A

Return Value

Parameters

targetFeature

Go Back

GetIntersection(AreaBaseShape)

N/A

Remarks

N/A

Return Value

Parameters

targetShape

Go Back

GetIntersection(RectangleShape)

This method returns the intersection of the current RectangleShape and the target shape, defined as the set of all points which lie in both the current shape and the target shape.

Remarks

None

Return Value

  • Return Type:RectangleShape
  • Description:The return type is a RectangleShape that contains the set of all points which lie in both the current shape and the target shape.

Parameters

targetShape

  • Description:The shape you are trying to find the intersection with.

Go Back

GetPerimeter(GeographyUnit,DistanceUnit)

N/A

Remarks

N/A

Return Value

  • Return Type:Double
  • Description:N/A

Parameters

shapeUnit

returningUnit

Go Back

GetShortestLineTo(BaseShape,GeographyUnit)

N/A

Remarks

N/A

Return Value

Parameters

targetShape

shapeUnit

Go Back

GetShortestLineTo(Feature,GeographyUnit)

N/A

Remarks

N/A

Return Value

Parameters

targetFeature

shapeUnit

Go Back

GetSymmetricalDifference(AreaBaseShape)

N/A

Remarks

N/A

Return Value

Parameters

targetShape

Go Back

GetSymmetricalDifference(Feature)

N/A

Remarks

N/A

Return Value

Parameters

targetFeature

Go Back

GetType()

N/A

Remarks

N/A

Return Value

  • Return Type:Type
  • Description:N/A

Parameters

GetWellKnownBinary(RingOrder,WkbByteOrder)

N/A

Remarks

N/A

Return Value

  • Return Type:Byte[]
  • Description:N/A

Parameters

outerRingOrder

byteOrder

Go Back

GetWellKnownBinary(RingOrder)

N/A

Remarks

N/A

Return Value

  • Return Type:Byte[]
  • Description:N/A

Parameters

outerRingOrder

Go Back

GetWellKnownBinary(WkbByteOrder)

N/A

Remarks

N/A

Return Value

  • Return Type:Byte[]
  • Description:N/A

Parameters

byteOrder

Go Back

GetWellKnownBinary()

N/A

Remarks

N/A

Return Value

  • Return Type:Byte[]
  • Description:N/A

Parameters

GetWellKnownText()

N/A

Remarks

N/A

Return Value

  • Return Type:String
  • Description:N/A

Parameters

GetWellKnownText(RingOrder)

N/A

Remarks

N/A

Return Value

  • Return Type:String
  • Description:N/A

Parameters

outerRingOrder

Go Back

GetWellKnownType()

N/A

Remarks

N/A

Return Value

Parameters

Intersects(Feature)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetFeature

Go Back

Intersects(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

IsDisjointed(Feature)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetFeature

Go Back

IsDisjointed(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

IsTopologicallyEqual(Feature)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetFeature

Go Back

IsTopologicallyEqual(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

IsWithin(Feature)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetFeature

Go Back

IsWithin(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

LoadFromWellKnownData(Byte[])

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

wellKnownBinary

  • Type:Byte[]
  • Description:N/A

Go Back

LoadFromWellKnownData(String)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

wellKnownText

  • Type:String
  • Description:N/A

Go Back

Overlaps(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

Overlaps(Feature)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetFeature

Go Back

Register(Feature,Feature,DistanceUnit,GeographyUnit)

N/A

Remarks

N/A

Return Value

Parameters

fromPoint

toPoint

fromUnit

toUnit

Go Back

Register(PointShape,PointShape,DistanceUnit,GeographyUnit)

N/A

Remarks

N/A

Return Value

Parameters

fromPoint

toPoint

fromUnit

toUnit

Go Back

Rotate(PointShape,Single)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

pivotPoint

degreeAngle

  • Type:Single
  • Description:N/A

Go Back

ScaleDown(Double)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

percentage

  • Type:Double
  • Description:N/A

Go Back

ScaleTo(Double)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

scale

  • Type:Double
  • Description:N/A

Go Back

ScaleUp(Double)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

percentage

  • Type:Double
  • Description:N/A

Go Back

Simplify(Double,SimplificationType)

N/A

Remarks

N/A

Return Value

Parameters

tolerance

  • Type:Double
  • Description:N/A

simplificationType

Go Back

Simplify(GeographyUnit,Double,DistanceUnit,SimplificationType)

N/A

Remarks

N/A

Return Value

Parameters

shapeUnit

tolerance

  • Type:Double
  • Description:N/A

toleranceUnit

simplificationType

Go Back

ToPolygon()

This method returns the current shape as a PolygonShape.

Remarks

This method is mainly used to convert this GIS non-standard shape to a GIS standard shape.

Return Value

  • Return Type:PolygonShape
  • Description:This method returns the current shape as a PolygonShape.

Parameters

ToString()

This method returns a formatted representation of the UpperLeftPoint.X, UpperLeftPoint.Y, LowerRightPoint.X and LowerRightPoint.Y value.

Remarks

The value will be formatted in the standard string format: -180,90,180,-90“

Return Value

  • Return Type:String
  • Description:This method returns a formatted representation of the UpperLeftPoint.X, UpperLeftPoint.Y, LowerRightPoint.X and LowerRightPoint.Y value.

Parameters

Touches(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

Touches(Feature)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetFeature

Go Back

TranslateByDegree(Double,Double)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

distance

  • Type:Double
  • Description:N/A

angleInDegrees

  • Type:Double
  • Description:N/A

Go Back

TranslateByDegree(Double,Double,GeographyUnit,DistanceUnit)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

distance

  • Type:Double
  • Description:N/A

angleInDegrees

  • Type:Double
  • Description:N/A

shapeUnit

distanceUnit

Go Back

TranslateByOffset(Double,Double,GeographyUnit,DistanceUnit)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

xOffsetDistance

  • Type:Double
  • Description:N/A

yOffsetDistance

  • Type:Double
  • Description:N/A

shapeUnit

distanceUnit

Go Back

TranslateByOffset(Double,Double)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

xOffsetDistance

  • Type:Double
  • Description:N/A

yOffsetDistance

  • Type:Double
  • Description:N/A

Go Back

Union(Feature)

N/A

Remarks

N/A

Return Value

Parameters

targetFeature

Go Back

Union(AreaBaseShape)

N/A

Remarks

N/A

Return Value

Parameters

targetShape

Go Back

Validate(ShapeValidationMode)

N/A

Remarks

N/A

Return Value

Parameters

validationMode

Go Back

Protected Methods

BufferCore(Double,Int32,BufferCapType,GeographyUnit,DistanceUnit)

N/A

Remarks

N/A

Return Value

Parameters

distance

  • Type:Double
  • Description:N/A

quadrantSegments

  • Type:Int32
  • Description:N/A

bufferCapType

shapeUnit

distanceUnit

Go Back

CloneDeepCore()

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

Remarks

When you override this method, you need to ensure that there are no references in common between the original and copy.

Return Value

  • Return Type:BaseShape
  • Description:This method returns a complete copy of the shape without any references in common.

Parameters

ContainsCore(BaseShape)

This method returns if the targetShape lies within the interior of the current shape.

Remarks

Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

Return Value

  • Return Type:Boolean
  • Description:This method returns if the targetShape lies within the interior of the current shape.

Parameters

targetShape

  • Type:BaseShape
  • Description:The shape you wish to compare the current one to.

Go Back

CrossesCore(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

ExpandToIncludeCore(BaseShape)

This method will expand the current RectangleShape to include the shape in the targetShape parameter.

Remarks

There is also an overload that can expand the RectangleShape using a list of shapes.

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

targetShape

  • Type:BaseShape
  • Description:This parameter is used to expand the current rectangle.

Go Back

Finalize()

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

GetAccurateAreaCore(String,AreaUnit,DistanceCalculationMode)

N/A

Remarks

N/A

Return Value

  • Return Type:Double
  • Description:N/A

Parameters

shapeProj4ProjectionParameters

  • Type:String
  • Description:N/A

returningUnit

distanceCalculationMode

Go Back

GetAccuratePerimeterCore(String,DistanceUnit,DistanceCalculationMode)

N/A

Remarks

N/A

Return Value

  • Return Type:Double
  • Description:N/A

Parameters

shapeProj4ProjectionParameters

  • Type:String
  • Description:N/A

returningUnit

distanceCalculationMode

Go Back

GetAreaCore(GeographyUnit,AreaUnit)

This method returns the area of the shape (defined as the size of the region enclosed by the figure).

Remarks

You would use this method to find the area inside the shape.

Return Value

  • Return Type:Double
  • Description:The return unit is based on the AreaUnit you specify in the returningUnit parameter, regardless of the shape's GeographyUnit.

Parameters

shapeUnit

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

returningUnit

  • Type:AreaUnit
  • Description:This is the AreaUnit you would like to use as the return value. For example, if you select square miles as your returningUnit, then the distance will be returned in square miles.

Go Back

GetBoundingBoxCore()

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

Remarks

The GetBoundingBox method calculates the smallest RectangleShape that can encompass the entire geometry by examining each point in the geometry. Depending on the number of PointShapes and complexity of the geometry, this operation can take longer for larger objects. If the shape is a PointShape, then the bounding box's upper left and lower right points will be equal. This will create a RectangleShape with no area.

Return Value

  • Return Type:RectangleShape
  • Description:The RectangleShape returned is the smallest RectangleShape that can encompass the entire geometry.

Parameters

GetCenterPointCore()

This method returns the center point of the current shape's bounding box.

Remarks

This method returns the center point of the current shape's bounding box. It is important to note that this is the center point of the bounding box. There are numerous ways to calculate the “center” of a geometry such, as its weighted center, etc. You can find other centers by examining the various methods of the shape itself. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

Return Value

  • Return Type:PointShape
  • Description:A PointShape representing the center point of the current shape's bounding box.

Parameters

GetClosestPointToCore(BaseShape,GeographyUnit)

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

Remarks

This method returns the point of the current shape that is closest to the target shape. It is often the case that the point returned is not a point of the object itself. An example would be a line with two points that are far apart from each other. If you set the targetShape to be a point midway between the points but a short distance away from the line, the method would return a point that is on the line but not either of the two points that make up the line.

Return Value

  • Return Type:PointShape
  • Description:A PointShape representing the closest point of the current shape to the targetShape.

Parameters

targetShape

  • Type:BaseShape
  • Description:The shape you are trying to find the closest point to.

shapeUnit

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

Go Back

GetConvexHullCore()

N/A

Remarks

N/A

Return Value

Parameters

GetCrossingCore(BaseShape)

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

Remarks

As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.

Return Value

  • Return Type:MultipointShape
  • Description:This method returns the crossing points between the current shape and the passed-in target shape.

Parameters

targetShape

  • Type:BaseShape
  • Description:The target shape you wish to get crossing with.

Go Back

GetDifferenceCore(AreaBaseShape)

N/A

Remarks

N/A

Return Value

Parameters

targetShape

Go Back

GetDistanceToCore(BaseShape,GeographyUnit,DistanceUnit)

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

Remarks

In this method, we compute the closest distance between the two shapes. The returned unit will be in the unit of distance specified.

Return Value

  • Return Type:Double
  • Description:The return type is the distance between this shape and the targetShape in the GeographyUnit of the shape. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

Parameters

targetShape

  • Type:BaseShape
  • Description:The shape you are trying to find the distance to.

shapeUnit

  • Description:The GeographyUnit of the targetShape.

distanceUnit

  • Description:The DistanceUnit of the returned value.

Go Back

GetGeoJsonCore()

N/A

Remarks

N/A

Return Value

  • Return Type:String
  • Description:N/A

Parameters

GetIntersectionCore(AreaBaseShape)

N/A

Remarks

N/A

Return Value

Parameters

targetShape

Go Back

GetPerimeterCore(GeographyUnit,DistanceUnit)

This method returns the perimeter of the shape (defined as the sum of the lengths of all its sides).

Remarks

You would use this method to find the distance around the area shape.

Return Value

  • Return Type:Double
  • Description:The return unit is based on the LengthUnit you specify in the returningUnit parameter, regardless of the shape's GeographyUnit.

Parameters

shapeUnit

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

returningUnit

  • Description:This is the DistanceUnit you would like to use as the return value. For example, if you select miles as your returningUnit, then the distance will be returned in miles.

Go Back

GetShortestLineToCore(BaseShape,GeographyUnit)

N/A

Remarks

N/A

Return Value

Parameters

targetShape

shapeUnit

Go Back

GetSymmetricalDifferenceCore(AreaBaseShape)

N/A

Remarks

N/A

Return Value

Parameters

targetShape

Go Back

GetWellKnownBinaryCore(RingOrder,WkbByteOrder)

This method returns a byte array that represents the shape in well-known binary.

Remarks

This method returns a byte array that represents the shape in well-known binary. Well-known binary allows you to describe a geometry as a binary array. Well-known binary is useful when you want to save a geometry in an efficient format using as little space as possible. An alternative to well-known binary is well-known text, which is a textual representation of a geometry object. We have methods that work with well-known text as well.

Return Value

  • Return Type:Byte[]
  • Description:This method returns a byte array that represents the shape in well-known binary.

Parameters

outerRingOrder

byteOrder

  • Description:This parameter specifies whether the byte order is big- or little-endian.

Go Back

GetWellKnownTextCore(RingOrder)

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

Remarks

This method returns a string that represents the shape in well-known text. Well-known text allows you to describe a geometry as a string of text. Well-known text is useful when you want to save a geometry in a format such as a text file, or when you simply want to cut and paste the text between other applications. An alternative to well-known text is well-known binary, which is a binary representation of a geometry object. We have methods that work with well-known binary as well. Below are some samples of what well-known text might look like for various kinds of geometric shapes.POINT(5 17)LINESTRING(4 5,10 50,25 80)POLYGON1)MULTIPOINT(3.7 9.7,4.9 11.6)MULTILINESTRING2)MULTIPOLYGON3),4))

Return Value

  • Return Type:String
  • Description:This method returns a string that represents the shape in well-known text.

Parameters

outerRingOrder

Go Back

GetWellKnownTypeCore()

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

Remarks

None

Return Value

  • Return Type:WellKnownType
  • Description:This method returns the well-known type for the shape.

Parameters

IntersectsCore(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

IsDisjointedCore(BaseShape)

This method returns whether the current shape and the targetShape have no points in common.

Remarks

Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

Return Value

  • Return Type:Boolean
  • Description:This method returns whether the current shape and the targetShape have no points in common.

Parameters

targetShape

  • Type:BaseShape
  • Description:The shape you wish to compare the current one to.

Go Back

IsTopologicallyEqualCore(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

IsWithinCore(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

LoadFromWellKnownDataCore(Byte[])

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

Remarks

This is used when you want to hydrate a shape based on well-known binary. You can create the shape and then load the well-known binary using this method.

Return Value

  • Return Type:Void
  • Description:None

Parameters

wellKnownBinary

  • Type:Byte[]
  • Description:This parameter is the well-known binary used to populate the shape.

Go Back

LoadFromWellKnownDataCore(String)

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

Remarks

None

Return Value

  • Return Type:Void
  • Description:None

Parameters

wellKnownText

  • Type:String
  • Description:This parameter is the well-known text you will use to hydrate your object.

Go Back

MemberwiseClone()

N/A

Remarks

N/A

Return Value

  • Return Type:Object
  • Description:N/A

Parameters

OverlapsCore(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

RegisterCore(PointShape,PointShape,DistanceUnit,GeographyUnit)

This method returns a MultipointShape which has been registered from its original coordinate system to another based on two anchor PointShapes.

Remarks

The register method is useful, for example, when a group of points represented by a MultipointShape has been generated in a non-geographic coordinate in meters, and you want to plot the points on a map that is in decimal degrees.

Return Value

  • Return Type:BaseShape
  • Description:This method returns a MultipointShape which has been registered from its original coordinate system to another based on two anchor PointShapes.

Parameters

fromPoint

  • Description:This parameter is the anchor PointShape in the coordinate of origin.

toPoint

  • Description:This parameter is the anchor PointShape in the coordinate of destination.

fromUnit

  • Description:This parameter is the GeographyUnit of the coordinate of origin.

toUnit

  • Description:This parameter is the GeographyUnit of the coordinate of destination.

Go Back

RotateCore(PointShape,Single)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

pivotPoint

degreeAngle

  • Type:Single
  • Description:N/A

Go Back

ScaleDownCore(Double)

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

Remarks

None

Return Value

  • Return Type:Void
  • Description:This method is useful when you would like to decrease the size of the shape. Note that a larger percentage will scale the shape down faster, as you are applying the operation multiple times. There is also a ScaleUp method that will enlarge the shape.

Parameters

percentage

  • Type:Double
  • Description:This is the percentage by which to decrease the shape's size.

Go Back

ScaleToCore(Double)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

scale

  • Type:Double
  • Description:N/A

Go Back

ScaleUpCore(Double)

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

Remarks

This method is useful when you would like to increase the size of the shape. Note that a larger percentage will scale the shape up faster, as you are applying the operation multiple times. There is also a ScaleDown method that will shrink the shape.

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

percentage

  • Type:Double
  • Description:This is the percentage by which to increase the shape's size.

Go Back

SimplifyCore(Double,SimplificationType)

N/A

Remarks

N/A

Return Value

Parameters

tolerance

  • Type:Double
  • Description:N/A

simplificationType

Go Back

TouchesCore(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

TranslateByDegreeCore(Double,Double,GeographyUnit,DistanceUnit)

This method moves the shape from one location to another, based on a direction in degrees and distance.

Remarks

This method moves the base shape from one location to another, based on an angleInDegrees and distance parameter. With this overload, it is important to note that the distance units are the same GeographicUnit as the shape. For example, if your shape is in decimal degrees and you call this method with a distance of 1, you're going to move this shape 1 decimal degree in direction of the angleInDegrees. In many cases it is more useful to specify the DistanceUnit of movement, such as in miles or yards, so for these scenarios there is another overload you may want to use instead.If you pass a distance of 0, then the operation is ignored.

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

distance

  • Type:Double
  • Description:The distance is the number of units to move the shape in the angle specified. The distance unit will be the same as the GeographyUnit for the shape. The distance must be greater than or equal to 0.

angleInDegrees

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

shapeUnit

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

distanceUnit

  • Description:This is the DistanceUnit you would like to use as the measure for the move. For example, if you select miles as your distanceUnit, then the xOffsetDistance and yOffsetDistance will be calculated in miles.

Go Back

TranslateByOffsetCore(Double,Double,GeographyUnit,DistanceUnit)

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

Remarks

This method moves the 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 1 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 to on the X axis and 3 miles on the Y axis.

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

xOffsetDistance

  • Type:Double
  • Description:This is the number of horizontal units of movement in the DistanceUnit specified as the distanceUnit.

yOffsetDistance

  • Type:Double
  • Description:This is the number of horizontal units of movement in the DistanceUnit specified as the distanceUnit.

shapeUnit

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

distanceUnit

  • Description:This is the DistanceUnit you would like to use as the measure for the move. For example, if you select miles as your distanceUnit, then the xOffsetDistance and yOffsetDistance will be calculated in miles.

Go Back

UnionCore(AreaBaseShape)

N/A

Remarks

N/A

Return Value

Parameters

targetShape

Go Back

ValidateCore(ShapeValidationMode)

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

Remarks

We use this method, with the simple enumeration, internally before doing any kind of other methods on the shape. In this way, we are able to verify the integrity of the shape itself. If you wish to test things such as whether a polygon self-intersects, we invite you to call this method with the advanced ShapeValidationMode. One thing to consider is that for complex polygon shapes this operation could take some time, which is why we only run the basic, faster test. If you are dealing with polygon shapes that are suspect, we suggest you run the advanced test.

Return Value

  • Description:This method returns a ShapeValidationResult based on a series of tests.

Parameters

validationMode

  • Description:This parameter determines whether the test is simple or advanced. In some cases, the advanced tests can take some time. The simple test is designed to always be fast.

Go Back

Public Properties

CanRotate

N/A

Remarks

N/A

Return Value

Return Type:Boolean

Go Back

Height

This property returns the height of the RectangleShape in the unit of the shape.

Remarks

None

Return Value

Return Type:Double

Go Back

Id

N/A

Remarks

N/A

Return Value

Return Type:String

Go Back

LowerLeftPoint

This property returns the PointShape that represents the lower left point of the RectangleShape.

Remarks

None

Return Value

Return Type:PointShape

Go Back

LowerRightPoint

This property returns or sets the PointShape that represents the lower right point of the RectangleShape.

Remarks

None

Return Value

Return Type:PointShape

Go Back

Tag

N/A

Remarks

N/A

Return Value

Return Type:Object

Go Back

UpperLeftPoint

This property returns or sets the PointShape that represents the upper left point of the RectangleShape.

Remarks

None

Return Value

Return Type:PointShape

Go Back

UpperRightPoint

This property returns the PointShape that represents the upper right point of the RectangleShape.

Remarks

None

Return Value

Return Type:PointShape

Go Back

Width

This property returns the width of the RectangleShape in the unit of the shape.

Remarks

None

Return Value

Return Type:Double

Go Back

Protected Properties

Public Events

1) 2 2,6 2,6 6,2 6,2 2),(3 3,4 3,4 4,3 4,3 3
2) 4 5,11 51,21 26),(-4 -7,-9 -7,-14 -3
3) (2 2,6 2,6 6,2 6,2 2),(3 3,4 3,4 4,3 4,3 3
4) 4 4,7 3,7 5,4 4
thinkgeo.mapsuite.core.rectangleshape.1442486302.txt.gz · Last modified: 2015/09/17 10:38 by admin