API Reference > core-frontend > Tiles > MapCartoRectangle

MapCartoRectangle Class

Beta  

A specialization of Range2d representing a Cartographic region on the surface of the Earth, used by MapTiles. The x components of the low and high points refer to the western and eastern longitudes, respectively. The y components of the low and high points refer to the southern and northern latitudes, respectively. Longitudes are stored in radians in the range [-pi, pi]. Latitudes are stored in radians in the range [-pi/2, pi/2].

Extends

Methods

Name Description
constructor(west: number, south: number, east: number, north: number): MapCartoRectangle Protected Construct a new rectangle with angles specified in radians.  
containsCartographic(carto: Cartographic): boolean Returns true if the specified cartographic location is contained within this rectangle's area, ignoring elevation.  
fractionFromCartographic(carto: Cartographic): undefined | Point2d Computes fractional coordinates of the specified position within this rectangle's area.  
getCenter(result?: Cartographic): Cartographic Returns the position at the center of this rectangle, at an elevation of zero.  
setRadians(west: number = 0, south: number = 0, east: number = 0, north: number = 0): void Reinitialize this rectangle using angles specified in radians.  
createMaximum(): MapCartoRectangle Static Create a rectangle encompassing all points on the surface of the Earth.  
createZero(): MapCartoRectangle Static Create a rectangle with all angles set to zero.  
fromDegrees(west: number, south: number, east: number, north: number, result?: MapCartoRectangle): MapCartoRectangle Static Create a new rectangle with angles specified in degrees.  
fromRadians(west: number, south: number, east: number, north: number, result?: MapCartoRectangle): MapCartoRectangle Static Create a new rectangle with angles specified in radians.  

Inherited methods

Name Inherited from Description
clone(result?: MapCartoRectangle): MapCartoRectangle Range2d return a clone of this range (or copy to optional result)
containsPoint(point: Readonly<WritableXAndY>): boolean Range2d Test if a point is within the range.
containsRange(other: Readonly<WritableLowAndHighXY>): boolean Range2d Test of other range is within this range
containsXY(x: number, y: number): boolean Range2d Test if a point given as x,y is within the range.
corners3d(asLoop?: boolean, z?: number): Point3d[] Range2d Return an array with the 4 corners.
diagonal(result?: Vector2d): Vector2d Range2d return the diagonal vector.
diagonalFractionToPoint(fraction: number, result?: Point2d): Point2d Range2d return the point at the specified fraction along the diagonal vector.
distanceToPoint(point: Readonly<WritableXAndY>): number Range2d Return 0 if the point is within the range, otherwise the distance to the closest face or corner
distanceToRange(other: Readonly<WritableLowAndHighXY>): number Range2d Return 0 if the point is within the range, otherwise the distance to the closest face or corner
expandInPlace(delta: number): void Range2d move all limits by a fixed amount.
extendPoint(point: Readonly<WritableXAndY>): void Range2d Expand this range to include a point.
extendRange(other: Readonly<WritableLowAndHighXY>): void Range2d Expand this range to include a range.
extendTransformedXY(transform: Transform, x: number, y: number): void Range2d Expand this range to include a point given by x,y
extendXY(x: number, y: number): void Range2d Expand this range to include a point given by x,y
fractionToPoint(fractionX: number, fractionY: number, result?: Point2d): Point2d Range2d return a point given by fractional positions on the XY axes.
freeze(): Readonly<MapCartoRectangle> Range2d Freeze this instance (and its members) so it is read-only
intersect(other: Readonly<WritableLowAndHighXY>, result?: Range2d): Range2d Range2d Return the intersection of ranges.
intersectsRange(other: Readonly<WritableLowAndHighXY>): boolean Range2d Test if there is any intersection with other range
isAlmostEqual(other: Range2d): boolean Range2d Returns true if this and other have equal low and high parts, or both are null ranges.
maxAbs(): number Range2d Largest absolute value among any coordinates in the box corners.
scaleAboutCenterInPlace(scaleFactor: number): void Range2d move low and high points by scaleFactor around the center point.
setFrom(other: Readonly<WritableLowAndHighXY>): void Range2d copy all content from any other that has low and high xy data.
setFromJSON(json: Range2dProps): void Range2d treat any array of numbers as numbers to be inserted !!!
setNull(): void Range2d reset the low and high to null range state.
setXY(x: number, y: number): void Range2d Set low and hight to a single xy value.
toFloat64Array(): Float64Array Range2d Flatten the low and high coordinates of this instance into an array of 4 doubles
toJSON(): Range2dProps Range2d return json array with two points as produced by Point2d.toJSON
union(other: Readonly<WritableLowAndHighXY>, result?: Range2d): Range2d Range2d Return the union of ranges.
worldToLocal(point: Point2d, result?: Point2d): undefined | Point2d Range2d Return fractional coordinates of point within the range.
xLength(): number Range2d Length of the box in the x direction
yLength(): number Range2d Length of the box in the y direction
coordinateToRangeAbsoluteDistance(x: number, low: number, high: number): number Static Range2d Given a coordinate and pair of range limits, return the smallest distance to the range.
createArray<T extends Range2d<T>>(points: Point2d[], result?: T): T Static Range2d Create a range around an array of points.
createFrom<T extends Range2d<T>>(other: Readonly<WritableLowAndHighXY>, result?: T): T Static Range2d create a new Range2d from any other that has low and high xy data.
createNull<T extends Range2d<T>>(result?: T): T Static Range2d create a range with no content.
createXY<T extends Range2d<T>>(x: number, y: number, result?: T): T Static Range2d Create a single point box
createXYXY<T extends Range2d<T>>(xA: number, yA: number, xB: number, yB: number, result?: T): T Static Range2d Create a box with 2 pairs of xy candidates.
createXYXYOrCorrectToNull<T extends Range2d<T>>(xA: number, yA: number, xB: number, yB: number, result?: T): T Static Range2d Create a box with 2 pairs of xy candidates.
createXYXYXY<T extends Range2d<T>>(xA: number, yA: number, xB: number, yB: number, xC: number, yC: number, result?: T): T Static Range2d Create a box with 3 pairs of xy candidates.
fromArrayBuffer<T extends Range2d<T>>(buffer: ArrayBuffer): T Static Range2d Construct a Range2d from an un-typed array.
fromFloat64Array<T extends Range2d<T>>(f64: Float64Array): T Static Range2d Construct a Range2d from an array of double-precision values
fromJSON<T extends Range2d<T>>(json?: Range2dProps): T Static Range2d Use setFromJSON to parse json into a new Range2d instance.
isExtremePoint2d(xy: Point2d): boolean Static Range2d Return true if either of x,y is outside the range `[_EXTREME_NEGATIVE, _EXTREME_POSITIVE]'
isExtremePoint3d(xyz: Point3d): boolean Static Range2d Return true if any x or y or z is outside the range `[_EXTREME_NEGATIVE, _EXTREME_POSITIVE]'
isExtremeValue(x: number): boolean Static Range2d Return true if x is outside the range `[_EXTREME_NEGATIVE, _EXTREME_POSITIVE]'
isNull(range: Readonly<WritableLowAndHighXY>): boolean Static Range2d Test if the box has high strictly less than low for any of x,y, condition.
multiplyIfPositive(q: number, factor: number, defaultValue?: number): number Static Range2d if a > 0, return (extrapolationFactor * a); otherwise return defaultValue
npcScaleFactor(low: number, high: number): number ProtectedStatic Range2d Return 0 if high<= low, otherwise 1/(high-low) for use in fractionalizing
rangeToRangeAbsoluteDistance(lowA: number, highA: number, lowB: number, highB: number): number Static Range2d Return the min absolute distance from any point of [lowA,highA]' to any point of [lowB,highB]'.
toFloat64Array(val: Readonly<WritableLowAndHighXY>): Float64Array Static Range2d Flatten the low and high coordinates of any json object with low.x ..

Properties

Name Type Description
cartoCenter Accessor ReadOnly Cartographic The cartographic center of this rectangle.  
east Accessor number The eastern longitude in radians.  
globalLocation Accessor ReadOnly GlobalLocation The MapCartoRectangle.globalLocationArea and MapCartoRectangle.cartoCenter of this rectangle.  
globalLocationArea Accessor ReadOnly GlobalLocationArea A pair of Cartographics representing the same area as this rectangle.  
latLongString Accessor ReadOnly string A non-localized string representation of this rectangle, for debugging purposes.  
north Accessor number The northern latitude in radians.  
south Accessor number The southern latitude in radians.  
west Accessor number The western longitude in radians.  

Inherited properties

Name Type Inherited from Description
_EXTREME_NEGATIVE ProtectedStaticReadonly number Range2d Number considered to be impossibly negative for a coordinate in a range.
_EXTREME_POSITIVE ProtectedStaticReadonly number Range2d Number considered impossibly large possibly for a coordinate in a range.
center Accessor ReadOnly Point2d Range2d Return the midpoint of the diagonal. No test for null range.
high Point2d Range2d low point coordinates.
isAlmostZeroX Accessor ReadOnly boolean Range2d Test if the x direction size is nearly zero
isAlmostZeroY Accessor ReadOnly boolean Range2d Test if the y direction size is nearly zero
isNull Accessor ReadOnly boolean Range2d Test if the box has high<low for any of x,y, condition. Note that a range around a single point is NOT null.
isSinglePoint Accessor ReadOnly boolean Range2d Test of the range contains a single point.
low Point2d Range2d low point coordinates.
xHigh Accessor ReadOnly number Range2d return the high x coordinate
xLow Accessor ReadOnly number Range2d return the low x coordinate
yHigh Accessor ReadOnly number Range2d return the high y coordinate
yLow Accessor ReadOnly number Range2d return the low y coordinate

Defined in

Last Updated: 20 June, 2023