Summary

Constructor

Methods

applyTransform(callback)

给定一个函数，用来修改几何对象的坐标值。该方法可能改变原几何对象的坐标值，如果需要保留原几何对象，可以使用clone方法复制为副本。

Parameters:

Name	Type	Description
callback	function	用于处理坐标值的回调函数，回调函数的参数为坐标对象，该回调函数会作用在几何对象的每个坐标上

atApproximatePoint(coord) → {Boolean}

检测一个坐标是否在几何对象的边界范围以内。 本计算基于边界盒与坐标的相交运算，不包含高程方向的计算，一般用于近似相交判断。注意：与边界盒相交的坐标不一定在几何对象内，可能会在几何对象的边缘以外附近。
边界盒：即几何对象的地理范围构成的多边形区域。

Parameters:

Name	Type	Description
coord	module:basetype~Coordinate	地理坐标

Returns:

Boolean -

返回true表示在几何对象的边界盒范围以内；返回false表示不在几何对象的边界盒范围以内

clone() → {module:geom~Geometry}

复制一个几何对象。

Returns:

module:geom~Geometry -

几何对象。

copyTo(coordinate) → {module:geom~Geometry}

复制当前几何对象对象，将得到的几何对象对象的地理范围中心变成传参的coordinate。不改变原来的geometry对象。

Parameters:

Name	Type	Description
coordinate	module:basetype~Coordinate	地理坐标

Returns:

module:geom~Geometry -

新的geometry对象，geometry类型和调用该方法的对象的类型一致。

destroy()

销毁几何对象对象。

Example

geometry.destroy();

distanceTo(geometry, options) → {Number|Object}

计算两个地理几何对象之间的距离（X-Y平面内）。

Parameters:

Name	Type	Description
geometry	module:geom~Geometry	地理几何对象，继承module:geom~Geometry的任意几何对象
options	Object	距离计算时的可选配置项 Name Type Description details Boolean 指定返回结果的格式，默认为false 若为true，则返回一个对象:{"distance":xxx,"x0":xxx,"y0":xxx,"x1":xxx,"y1":xxx}。其中 distance 表示几何对象到目标几何对象的距离；x0 和 y0 属性表示几何对象上最靠近目标几何对象的点；x1 和 y1 表示目标几何对象上最近的点。 若为false，则返回几何对象到目标几何对象的距离值，距离的单位跟当前地图的坐标系使用的长度单位保持一致。 edge Boolean 计算一个几何图形到目标几何图形边缘的最近距离，默认为true 如果为true， 一个几何图形完全包含在目标几何图形中时，计算距离为负数， 如果为false，两个几何图形相交情况下 计算距离为0。

Returns:

Number | Object -

返回的距离信息，根据options.details参数值给出不同的距离信息。但当options.details为false时，结果只返回一个距离值。

getBBox()

计算几何对象的三维包围盒

getClosestPoint(coord) → {module:geom~Point}

从构成几何对象的所有点中，获取离传入坐标最近的一个点。

Parameters:

Name	Type	Description
coord	module:basetype~Coordinate	一个地理坐标

Returns:

module:geom~Point -

几何对象上的一个点

getExtent() → {module:basetype~Extent}

计算几何对象的地理范围。该地理范围界定了X-Y平面的边界，不含高程信息。

Returns:

module:basetype~Extent -

几何对象的地理范围

getType() → {String}

获取几何对象类型。

Returns:

String -

几何对象类型

intersectsExtent(extent) → {Boolean}

检测几何对象与地理范围是否相交。

Parameters:

Name	Type	Description
extent	module:basetype~Extent	地理范围

Returns:

Boolean -

为true时表示相交，为false时表示不相交

intersectsGeometry(geom) → {Boolean}

检测与另一个几何对象是否相交。

Parameters:

Name	Type	Description
geom	module:basetype~Geometry	另一个几何对象

Returns:

Boolean -

返回true表示相交；返回false表示不相交

isSelfIntersects() → {Boolean}

自相交判断。

Returns:

Boolean -

返回true表示相交；返回false表示不相交

moveByDelta(deltaX, deltaY, deltaZ) → {module:geom~Geometry}

沿坐标轴正方向，将几何对象的所有坐标按给定的参数偏移。如果参数为负，则向坐标轴负向偏移。该方法不会改变几何对象的形状，但可能改变原几何对象的位置，如果需要保留原几何对象，需要事先使用clone方法复制为副本。

Parameters:

Name	Type	Description
deltaX	Number	X坐标轴方向的平移量
deltaY	Number	Y坐标轴方向的平移量
deltaZ	Number	Z坐标轴方向的平移量

Returns:

module:geom~Geometry -

移动后的几何对象

rotate(axis, angle, center)

以某个坐标为中心，绕坐标轴旋转。绕轴旋转的本质如下： 绕Z轴旋转即是在XY平面内旋转；绕X轴旋转即是在YZ平面内旋转；绕Y轴旋转即是在XZ平面内旋转

Parameters:

Name	Type	Description
axis	String	坐标轴。可选值为"X","Y","Z"
angle	Number	旋转的角度，超过360度时，取angle/360的余数。逆时针旋转为正，顺时针旋转为负
center	module:basetype~Coordinate	旋转（环绕中心），可选项。参数为空时，仅环绕坐标轴旋转

Throws:

• Error -

  当axis不是'X'、’Y‘、’Z‘三者之一时，抛出异常

• TypeError -

  当angle不是数字，或者传入的center参数类型不是hmap.basetype.Coordinate时，抛出类型错误异常

scale(xFactor, yFactor, zFactor, origin) → {module:geom~Geometry}

按各坐标轴的缩放比例和指定的缩放原点进行缩放。（该方法可能改变原几何对象的坐标值，如果需要保留原几何对象，可以使用clone方法复制为副本。

Parameters:

Name	Type	Description
xFactor	Number	X坐标值缩放比例，必须大于0
yFactor	Number	Y坐标值缩放比例，必须大于0
zFactor	Number	Z坐标值缩放比例，必须大于0
origin	module:basetype~Coordinate	缩放原点，以该点为参考点进行缩放。默认以几何对象地理范围的中心点进行缩放

Throws:

• RangeError -

  当xFactor, yFactor, zFactor的值不为正时

• TypeError -

  origin类型错误时。

Returns:

module:geom~Geometry -

返回缩放后的几何对象

transform(source, destination) → {module:geom~Geometry}

将一个几何对象中点所对应的地理坐标从源坐标系转换到目标坐标系。该方法可能改变原几何对象的坐标值，如果需要保留原几何对象，可以使用clone方法复制为副本。

Parameters:

Name	Type	Description
source	String	源坐标系，考虑到实际转换时，数据量可能较大，故传入crs的SRID，而非crs实例，以减少crs实例数量，进而降低内存成本
destination	String	目标坐标系

Throws:

如果给定的坐标系未找到，则抛出异常。

Returns:

module:geom~Geometry -

坐标转换后的几何对象