com.supermap.realspace
类 GlobalImage

java.lang.Object
  com.supermap.realspace.GlobalImage

public class GlobalImage
extends java.lang.Object

全球底图类。该类提供了在三维场景中返回/设置全球底图透明度、在全球底图上添加/返回/移除挖方区域几何对象等接口。挖方区域几何对象对应的范围将透明显示。

只有当 AltitudeMode.RELATIVE_UNDER_GROUND 且相机高度不大于 10,000 米（即 Camera.getAltitude() 方法的返回值不大于 10,000）时，设置全球地图透明、添加挖方区域几何对象效果才可见，即调用 setTransparency()、addExcavationRegion() 方法的效果可见。

方法摘要

int	addExcavationRegion(Geometry geometry, java.lang.String tag) 添加挖方区域几何对象，添加成功后，该对象所处范围将透明显示。
void	clearExcavationRegions() 清空所有挖方区域几何对象。
BoxClipPart	getBoxClipPart() 返回裁剪分析所指定的裁剪区域类型。
GeoBox	getClipBox() 返回用于裁剪的长方体对象。
float[]	getDepthBias() 获取多边形深度偏移参数。
Geometry	getExcavationRegion(int index) 返回指定索引对应的挖方区域几何对象。
int	getExcavationRegionCount() 返回挖方区域几何对象的总数。
java.lang.String	getExcavationRegionTag(int index) 返回指定索引对应的挖方区域几何对象的标签。
Rectangle2D	getSwipeRegion() 返回全球底图开启卷帘的区域。
int	getTransparency() 返回全球底图的透明度。
java.awt.Color	getUndergroundBackColor() 获取地下区域的背景色。
int	indexOfExcavationRegion(java.lang.String tag) 返回指定标签对应的挖方区域几何对象的索引。
boolean	isSwipeEnable() 返回全球底图是否开启卷帘功能。
boolean	isVisible() 获取全球底图是否可见。
boolean	removeExcavationRegion(int index) 移除指定索引的挖方区域几何对象。
void	setDepthBias(float fConstant, float fScale) 设置多边形深度偏移参数。
boolean	setExcavationRegionTag(int index, java.lang.String tag) 设置指定索引的挖方区域几何对象的标签。
void	setSwipeEnable(boolean enable) 设置全球底图是否开启卷帘功能。
void	setSwipeRegion(Rectangle2D rec) 设置全球底图开启卷帘的区域。
void	setTransparency(int value) 设置全球底图的透明度。
void	setUndergroundBackColor(java.awt.Color value) 设置地下区域的背景色。
void	setVisible(boolean value) 设置全球底图是否可见。

从类 java.lang.Object 继承的方法

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

方法详细信息

getTransparency

public int getTransparency()

返回全球底图的透明度。

返回：

全球底图的透明度，取值范围[0,100]，0 表示全球底图不透明；100 表示完全透明，即底图不可见。

setTransparency

public void setTransparency(int value)

设置全球底图的透明度。 p>只有当 AltitudeMode.RELATIVE_UNDER_GROUND 且相机高度不大于 10,000 米（即 Camera.getAltitude() 方法的返回值不大于 10,000）时，设置全球地图透明、添加挖方区域几何对象效果才可见，即调用 setTransparency()、addExcavationRegion() 方法的效果可见。

参数：

value - 全球底图的透明度，取值范围[0,100]，0 表示全球底图不透明；100 表示完全透明，即底图不可见。

getExcavationRegionCount

public int getExcavationRegionCount()

返回挖方区域几何对象的总数。

返回：

挖方区域几何对象的总数。

addExcavationRegion

public int addExcavationRegion(Geometry geometry,
                               java.lang.String tag)

添加挖方区域几何对象，添加成功后，该对象所处范围将透明显示。

只有当 AltitudeMode.RELATIVE_UNDER_GROUND 且相机高度不大于 10,000 米（即 Camera.getAltitude() 方法的返回值不大于 10,000）时，设置全球地图透明、添加挖方区域几何对象效果才可见，即调用 setTransparency()、addExcavationRegion() 方法的效果可见。

参数：

geometry - 待添加的挖方区域几何对象。

tag - 待添加的挖方区域几何对象的标签，标签不能为空字符串。

返回：

挖方区域几何对象的索引。

clearExcavationRegions

public void clearExcavationRegions()

清空所有挖方区域几何对象。

getExcavationRegion

public Geometry getExcavationRegion(int index)

返回指定索引对应的挖方区域几何对象。

参数：

index - 待返回的挖方区域几何对象的索引。

返回：

指定索引对应的挖方区域几何对象。

getExcavationRegionTag

public java.lang.String getExcavationRegionTag(int index)

返回指定索引对应的挖方区域几何对象的标签。

参数：

index - 指定的挖方区域对象的索引。

返回：

挖方区域对象的标签。

indexOfExcavationRegion

public int indexOfExcavationRegion(java.lang.String tag)

返回指定标签对应的挖方区域几何对象的索引。

参数：

tag - 指定的挖方区域几何对象的标签。

返回：

指定标签对应的挖方区域几何对象的索引。

removeExcavationRegion

public boolean removeExcavationRegion(int index)

移除指定索引的挖方区域几何对象。

参数：

index - 指定的挖方区域几何对象的索引。

返回：

一个布尔值，表示是否移除成功，true 表示成功，false 表示失败。

setExcavationRegionTag

public boolean setExcavationRegionTag(int index,
                                      java.lang.String tag)

设置指定索引的挖方区域几何对象的标签。

参数：

index - 待设置标签的挖方区域对象的索引。

tag - 挖方区域几何对象的新标签。

返回：

一个布尔值，表示设置标签是否成功，true 表示成功，false 表示失败。

isVisible

public boolean isVisible()

获取全球底图是否可见。

返回：

全球底图的可见性。

setVisible

public void setVisible(boolean value)

设置全球底图是否可见。

参数：

value - 指定全球底图的可见性。

setSwipeEnable

public void setSwipeEnable(boolean enable)

设置全球底图是否开启卷帘功能。

参数：

enable - 指定是否开启卷帘功能。

isSwipeEnable

public boolean isSwipeEnable()

返回全球底图是否开启卷帘功能。

返回：

卷帘功能是否开启。

getSwipeRegion

public Rectangle2D getSwipeRegion()

返回全球底图开启卷帘的区域。

返回：

开启卷帘的区域。

setSwipeRegion

public void setSwipeRegion(Rectangle2D rec)

设置全球底图开启卷帘的区域。

参数：

rec - 指定开启卷帘的区域。

getUndergroundBackColor

public java.awt.Color getUndergroundBackColor()

获取地下区域的背景色。

返回：

背景色。

setUndergroundBackColor

public void setUndergroundBackColor(java.awt.Color value)

设置地下区域的背景色。

参数：

value - 待设置颜色。

getDepthBias

public float[] getDepthBias()

获取多边形深度偏移参数。

返回：

多边形深度偏移参数，第一个值是偏移常量，第二个值是偏移缩放比率。

setDepthBias

public void setDepthBias(float fConstant,
                         float fScale)

设置多边形深度偏移参数。

参数：

fConstant - 指定的偏移常量。

fScale - 指定的偏移缩放比率。

getClipBox

public GeoBox getClipBox()

返回用于裁剪的长方体对象。

返回：

用于裁剪的长方体对象。

getBoxClipPart

public BoxClipPart getBoxClipPart()

返回裁剪分析所指定的裁剪区域类型。

返回：

裁剪分析指定的裁剪区域类型。