Class: BBox | hmap-js

Summary

Methods:

clone	克隆新对象
equals	计算该包围盒是否与另外一个包围盒范围一致。
extendBBox	扩展三维包围盒，使其包含指定的三维包围盒。高程单位需与经纬度单位一致。
extendXYZ	扩展三维包围盒，使其包含指定的坐标。
getCenter	获取包围盒的中心点
getExtent	获取该三维包围盒在XY平面的最大地理范围
getMax	获取由X轴、Y轴、Z轴各方向最大值组成的坐标点
getMaxX	获取X轴方向最大值
getMaxY	获取Y轴方向最大值
getMaxZ	获取Z轴方向最大值，原始值
getMin	获取由X轴、Y轴、Z轴各方向最小值组成的坐标点module:basetype~Coordinate
getMinX	获取X轴方向最小值
getMinY	获取Y轴方向最小值
getMinZ	获取Z轴方向最小值，原始值
intersectBBox	和另一包围盒的相交判断
moveByDelta	在X轴、Y轴、Z轴分别根据参数平移三维包围盒。当参数为正时，沿坐标轴正方向平移；参数为负，则沿坐标轴负方向平移。
setMaxX	设置X轴方向最大值
setMaxY	设置Y轴方向最大值
setMaxZ	设置Z轴方向最大值
setMinX	设置X轴方向最小值
setMinY	设置Y轴方向最小值
setMinZ	设置Z轴方向最小值

Constructor

new BBox(minX, minY, minZ, maxX, maxY, maxZ)

Parameters:

Name	Type	Description
`minX`	Number	X轴方向最小值，应比maxX小，必须
`minY`	Number	Y轴方向最小值，应比maxY小，必须
`minZ`	Number	Z轴方向最小值，应比maxZ小，必须
`maxX`	Number	X轴方向最大值，应比minX大，必须
`maxY`	Number	Y轴方向最大值，应比minY大，必须
`maxZ`	Number	Z轴方向最大值，应比minZ大，必须

Example

let bbox=new hmap.basetype.BBox(120.1,30.1,0,120.2,30.2,0.1)

Methods

clone() → {module:basetype~BBox}

克隆新对象

Returns:

module:basetype~BBox

equals(bbox) → {Boolean}

计算该包围盒是否与另外一个包围盒范围一致。

Parameters:

Name	Type	Description
`bbox`	module:basetype~BBox	三维包围盒

Returns:

Boolean -

范围一致，返回true，不同则返回false。

extendBBox(bbox) → {module:basetype~BBox}

扩展三维包围盒，使其包含指定的三维包围盒。高程单位需与经纬度单位一致。

Parameters:

Name	Type	Description
`bbox`	module:basetype~BBox	指定的三维包围盒。

Returns:

module:basetype~BBox -

返回包围盒本身。

extendXYZ(x, y, z) → {module:basetype~BBox}

扩展三维包围盒，使其包含指定的坐标。

Parameters:

Name	Type	Description
`x`	Number	在X轴方向扩展三维包围盒的值。
`y`	Number	在Y轴方向扩展三维包围盒的值。
`z`	Number	在Z轴方向扩展三维包围盒的值。

Returns:

module:basetype~BBox -

返回包围盒本身。

getCenter() → {module:basetype~Coordinate}

获取包围盒的中心点

Returns:

module:basetype~Coordinate -

包围盒中心点

getExtent() → {module:basetype~Extent}

获取该三维包围盒在XY平面的最大地理范围

Returns:

module:basetype~Extent -

三维包围盒在XY平面的最大地理范围。

getMax() → {module:basetype~Coordinate}

获取由X轴、Y轴、Z轴各方向最大值组成的坐标点

Returns:

module:basetype~Coordinate -

由X轴、Y轴、Z轴各方向最大值组成的坐标点

getMaxX() → {Number}

获取X轴方向最大值

Returns:

Number -

X轴方向最大值

getMaxY() → {Number}

获取Y轴方向最大值

Returns:

Number -

Y轴方向最大值

getMaxZ() → {Number}

获取Z轴方向最大值，原始值

Returns:

Number -

Z轴方向最大值

getMin() → {module:basetype~Coordinate}

获取由X轴、Y轴、Z轴各方向最小值组成的坐标点module:basetype~Coordinate

Returns:

module:basetype~Coordinate -

由X轴、Y轴、Z轴各方向最小值组成的坐标点

getMinX() → {Number}

获取X轴方向最小值

Returns:

Number -

X轴方向最小值

getMinY() → {Number}

获取Y轴方向最小值

Returns:

Number -

Y轴方向最小值

getMinZ() → {Number}

获取Z轴方向最小值，原始值

Returns:

Number -

Z轴方向最小值

intersectBBox(bbox) → {Boolean}

和另一包围盒的相交判断

Parameters:

Name	Type	Description
`bbox`	module:basetype~BBox	另一包围盒对象

Returns:

Boolean -

两个包围盒相交，返回true，否则返回false

moveByDelta(x, y, z) → {module:basetype~BBox}

在X轴、Y轴、Z轴分别根据参数平移三维包围盒。当参数为正时，沿坐标轴正方向平移；参数为负，则沿坐标轴负方向平移。

Parameters:

Name	Type	Description
`x`	Number	x轴方向平移距离
`y`	Number	y轴方向平移距离
`z`	Number	z轴方向平移距离

Returns:

module:basetype~BBox -

返回包围盒本身。

setMaxX(n) → {module:basetype~BBox}

设置X轴方向最大值

Parameters:

Name	Type	Description
`n`	Number	X轴方向最大值

Returns:

module:basetype~BBox -

返回包围盒本身。

setMaxY(n) → {module:basetype~BBox}

设置Y轴方向最大值

Parameters:

Name	Type	Description
`n`	Number	Y轴方向最大值

Returns:

module:basetype~BBox -

返回包围盒本身。

setMaxZ(n) → {module:basetype~BBox}

设置Z轴方向最大值

Parameters:

Name	Type	Description
`n`	Number	Z轴方向最大值

Returns:

module:basetype~BBox -

返回包围盒本身。

setMinX(n) → {module:basetype~BBox}

设置X轴方向最小值

Parameters:

Name	Type	Description
`n`	Number	X轴方向最小值

Returns:

module:basetype~BBox -

返回包围盒本身。

setMinY(n) → {module:basetype~BBox}

设置Y轴方向最小值

Parameters:

Name	Type	Description
`n`	Number	Y轴方向最小值

Returns:

module:basetype~BBox -

返回包围盒本身。

setMinZ(n) → {module:basetype~BBox}

设置Z轴方向最小值

Parameters:

Name	Type	Description
`n`	Number	Z轴方向最小值

Returns:

module:basetype~BBox -

返回包围盒本身。