TerrainLayers (iObjects Java Help)

java.lang.Object
- com.supermap.data.InternalHandle
- - com.supermap.realspace.TerrainLayers

```
public class TerrainLayers
extends com.supermap.data.InternalHandle
```
地形图层集合类。
该类包括了地形图层集合的相关信息，可以通过设置该类对象来对地形图层集合对象进行编辑管理操作。

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`TerrainLayer`	`add(DatasetGrid dataset, boolean addToHead)` 向地形图层集合中添加地形图层（数据集形式）
`TerrainLayer`	`add(DatasetGrid dataset, boolean addToHead, String name)` 向地形图层集合中添加地形图层（数据集形式）
`TerrainLayer`	`add(String file, boolean addToHead)` 向地形图层集合中添加地形图层对象。
`TerrainLayer`	`add(String file, boolean addToHead, String name)` 根据指定的参数向地形图层集合中添加地形图层（SCT文件形式）。
`TerrainLayer`	`add(String file, boolean addToHead, String name, String password)` 向地形图层集合中添加SCT地形图层。
`TerrainLayer`	`add(String iserverURL, String name)` 通过iServer数据服务向地形图层集合中添加地形图层。
`TerrainLayer`	`addSTK(String stkURL, String customLayerName)` 向地形图层集合中添加在线STK World Terrain地形图层。
`void`	`addTerrainLayerAddedListener(TerrainLayerAddedListener l)` 添加一个用于接收地形图层添加事件（`TerrainLayerAddedEvent`）的监听器。
`void`	`addTerrainLayerCaptionChangedListener(TerrainLayerCaptionChangedListener l)` 添加一个用于接收地形图层标题改变事件（`TerrainLayerCaptionChangedEvent`）的监听器。
`void`	`addTerrainLayerRefreshListener(TerrainLayerRefreshListener l)`
`void`	`addTerrainLayerRemovedListener(TerrainLayerRemovedListener l)` 添加一个用于接收地形图层移除事件`TerrainLayerRemovedEvent`的监听器。
`void`	`addTerrainLayerVisibleChangedListener(TerrainLayerVisibleChangedListener l)` 添加一个用于接收地形图层可视状态改变事件（`TerrainLayerVisibleChangedEvent`）的监听器。
`void`	`clear()` 从地形图层集中删除所有地形图层对象。
`boolean`	`contains(String name)` 返回当前地形图层集合是否包含指定名称的地形图层对象。
`TerrainLayer`	`get(int index)` 返回地形图层集合中指定序号的地形图层对象。
`TerrainLayer`	`get(String name)` 返回地形图层集合中指定名称的地形图层对象。
`int`	`getCount()` 返回给定的地形图层集合中地形图层对象的总数。
`FillMode3D`	`getFillMode3D()` TIN地形在场景中获取填充模式。
`Calendar`	`getHistory()` 获取当前浏览的历史数据时间。
`HypsometricSetting`	`getHypsometricSetting()` 用于获取地形图层的等值线设置信息。
`ModifyTerrainSetting`	`getModifyTerrainSetting()` 获取地形修改设置。
`double`	`getSlopeDirectionValues(Point3D position)` 获取场景地形特定位置的坡向。
`SlopeSetting`	`getSlopeSetting()` 用于获取地形图层的坡度分析设置信息。
`double`	`getSlopeValue(Point3D point3d)` 获取坡度分析中某一个三维点所在位置的坡度信息。
`int`	`indexOf(String name)` 返回指定名称的地形图层的序号。
`boolean`	`isNormalEnable()` 获取当前场景的栅格图层是否显示法线。
`boolean`	`moveDown(int index)` 把地形图层集合中指定序号的地形图层对象往下移动一层。
`boolean`	`moveTo(int sourceIndex, int targetIndex)` 把地形图层集合中的某一地形图层移动到指定序号的处。
`boolean`	`moveToBottom(int index)` 把地形图层集合中的指定地形图层移动到最底层。
`boolean`	`moveToTop(int index)` 把地形图层集合中的指定地形图层移动到最顶层。
`boolean`	`moveUp(int index)` 把地形图层集合中指定地形图层往上移动一层。
`void`	`refresh()` 在不显示法线进行坡度坡向分析师，刷新地形场景
`boolean`	`remove(int index)` 从地形图层集合中删除一个指定序号的地形图层对象。
`boolean`	`remove(String name)` 从地形图层集合中删除一个指定名称的地形图层对象。
`void`	`removeTerrainLayerAddedListener(TerrainLayerAddedListener l)` 移除一个用于接收地形图层添加事件（`TerrainLayerAddedEvent`）的监听器。
`void`	`removeTerrainLayerCaptionChangedListener(TerrainLayerCaptionChangedListener l)` 移除一个用于接收地形图层标题改变事件（`TerrainLayerCaptionChangedEvent`）的监听器。
`void`	`removeTerrainLayerRefreshListener(TerrainLayerRefreshListener l)`
`void`	`removeTerrainLayerRemovedListener(TerrainLayerRemovedListener l)` 移除一个用于接收地形图层移除事件`TerrainLayerRemovedEvent`的监听器。
`void`	`removeTerrainLayerVisibleChangedListener(TerrainLayerVisibleChangedListener l)` 移除一个用于接收地形图层可视状态改变事件（`TerrainLayerVisibleChangedEvent`）的监听器。
`void`	`setFillMode3D(FillMode3D mode3D)` TIN地形在场景中设置填充模式。
`void`	`setHistory(Calendar value)` 设置当前浏览的历史数据时间。
`void`	`setHypsometricSetting(HypsometricSetting hypsometricSetting)` 用于设置地形图层的等值线设置信息。
`void`	`setNormalEnable(boolean isNormalEnable)` 设置当前场景的栅格图层是否显示法线。
`void`	`setSlopeSetting(SlopeSetting slopeSetting)` 用于设置地形图层的坡度分析设置信息。

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - getCount
```
public int getCount()
```
    返回给定的地形图层集合中地形图层对象的总数。
    
    返回:
    
    给定的地形图层集合中地形图层对象的总数。
  - get
```
public TerrainLayer get(String name)
```
    返回地形图层集合中指定名称的地形图层对象。
    
    参数:
    
    name - 指定的图层对象名称。
    
    返回:
    
    地形图层集合中指定名称的地形图层对象。
  - get
```
public TerrainLayer get(int index)
```
    返回地形图层集合中指定序号的地形图层对象。
    
    参数:
    
    index - 指定的图层对象的序号。
    
    返回:
    
    地形图层集合中指定序号的地形图层对象。
  - add
```
public TerrainLayer add(String file,
                        boolean addToHead)
```
    向地形图层集合中添加地形图层对象。
    
    参数:
    
    file - 存储地形数据的 SCT 文件全路径。
    
    addToHead - 是否加到最上面。
    
    返回:
    
    地形图层对象。
  - add
```
public TerrainLayer add(String file,
                        boolean addToHead,
                        String name)
```
    根据指定的参数向地形图层集合中添加地形图层（SCT文件形式）。
    
    参数:
    
    file - SCT文件全路径。
    
    addToHead - 是否将新添加的地形图层加到最上面。
    
    name - 指定新添加的地形图层的名称，不区分大小写。如果图层名称已存在则抛出异常。
    
    返回:
    
    新添加的地形图层对象。
  - add
```
public TerrainLayer add(DatasetGrid dataset,
                        boolean addToHead)
```
    向地形图层集合中添加地形图层（数据集形式）
    
    参数:
    
    dataset - Grid数据集
    
    addToHead - 是否加到最上面
    
    返回:
    
    地形图层对象
  - add
```
public TerrainLayer add(DatasetGrid dataset,
                        boolean addToHead,
                        String name)
```
    向地形图层集合中添加地形图层（数据集形式）
    
    参数:
    
    dataset - Grid数据集
    
    addToHead - 是否加到最上面
    
    name - 指定图层的名称，如果已存在会抛出异常，不区分大小写
    
    返回:
    
    地形图层对象
  - add
```
public TerrainLayer add(String file,
                        boolean addToHead,
                        String name,
                        String password)
```
    向地形图层集合中添加SCT地形图层。
    
    参数:
    
    file - SCT文件全路径。
    
    addToHead - 是否将新加载的图层加到最上面。
    
    name - 指定新添加图层的名称，如果已存在会抛出异常，不区分大小写。
    
    password - 加载数据需要的密码，该密码为生产缓存时指定的密码。
    
    返回:
    
    新添加的地形图层对象。
  - add
```
public TerrainLayer add(String iserverURL,
                        String name)
```
    通过iServer数据服务向地形图层集合中添加地形图层。
    
    参数:
    
    iserverURL - iServer数据服务的URL
    
    name - 用户指定的地形图层名称。
    
    返回:
    
    新添加的地形图层对象。
  - remove
```
public boolean remove(int index)
```
    从地形图层集合中删除一个指定序号的地形图层对象。
    
    参数:
    
    index - 要删除的地形图层的序号。
    
    返回:
    
    删除成功则返回 true；否则返回 false。
  - remove
```
public boolean remove(String name)
```
    从地形图层集合中删除一个指定名称的地形图层对象。
    
    参数:
    
    name - 要删除地形图层的名称。
    
    返回:
    
    删除成功则返回 true；否则返回 false。
  - clear
```
public void clear()
```
    从地形图层集中删除所有地形图层对象。
  - indexOf
```
public int indexOf(String name)
```
    返回指定名称的地形图层的序号。
    
    参数:
    
    name - 指定的地形图层对象的名称。
    
    返回:
    
    指定地形图层对象的序号，如果未找到对应的序号，则返回-1。
  - contains
```
public boolean contains(String name)
```
    返回当前地形图层集合是否包含指定名称的地形图层对象。
    
    参数:
    
    name - 指定的地形图层对象的名称。
    
    返回:
    
    如果当前地形图层集合中包含指定名称的地形图层对象，返回 true；否则，返回 false。
  - moveToTop
```
public boolean moveToTop(int index)
```
    把地形图层集合中的指定地形图层移动到最顶层。
    
    参数:
    
    index - 要移动到最顶层的地形图层的序号。该序号应大于或等于1。
    
    返回:
    
    移动成功返回true；否则返回 false。
  - moveToBottom
```
public boolean moveToBottom(int index)
```
    把地形图层集合中的指定地形图层移动到最底层。
    
    参数:
    
    index - 要移动到最底层的地形图层的序号。
    
    返回:
    
    移动成功返回 true；否则返回 false。
  - moveUp
```
public boolean moveUp(int index)
```
    把地形图层集合中指定地形图层往上移动一层。
    
    参数:
    
    index - 指定的要向上移动一层的地形图层对象在集合中的序号。
    
    返回:
    
    移动成功返回 true；否则返回 false。
  - moveDown
```
public boolean moveDown(int index)
```
    把地形图层集合中指定序号的地形图层对象往下移动一层。
    
    参数:
    
    index - 指定序号的地形图层对象。
    
    返回:
    
    移动成功返回 true；否则返回 false。
  - moveTo
```
public boolean moveTo(int sourceIndex,
                      int targetIndex)
```
    把地形图层集合中的某一地形图层移动到指定序号的处。
    
    参数:
    
    sourceIndex - 指定的地形图层对象移动之前的序号。
    
    targetIndex - 指定的地形图层对象移动的目标序号。
    
    返回:
    
    移动成功返回 true；否则返回 false。
  - getModifyTerrainSetting
```
public ModifyTerrainSetting getModifyTerrainSetting()
```
    获取地形修改设置。
    
    返回:
  - getHistory
```
public Calendar getHistory()
```
    获取当前浏览的历史数据时间。
    
    返回:
    
    当前时间。
  - setHistory
```
public void setHistory(Calendar value)
```
    设置当前浏览的历史数据时间。
    
    参数:
    
    value - 待设置的历史数据时间。
  - addSTK
```
public TerrainLayer addSTK(String stkURL,
                           String customLayerName)
```
    向地形图层集合中添加在线STK World Terrain地形图层。
    
    参数:
    
    stkURL - 指定的STK地形服务URL。
    
    customLayerName - 用户指定的地形图层名称。
    
    返回:
    
    新添加的地形图层对象。
  - addTerrainLayerRefreshListener
```
public void addTerrainLayerRefreshListener(TerrainLayerRefreshListener l)
```
  - removeTerrainLayerRefreshListener
```
public void removeTerrainLayerRefreshListener(TerrainLayerRefreshListener l)
```
  - addTerrainLayerAddedListener
```
public void addTerrainLayerAddedListener(TerrainLayerAddedListener l)
```
    添加一个用于接收地形图层添加事件（TerrainLayerAddedEvent）的监听器。
    
    参数:
    
    l - 一个用于接收地形图层添加事件的监听器。
  - removeTerrainLayerAddedListener
```
public void removeTerrainLayerAddedListener(TerrainLayerAddedListener l)
```
    移除一个用于接收地形图层添加事件（TerrainLayerAddedEvent）的监听器。
    
    参数:
    
    l - 一个用于接收地形图层添加事件的监听器。
  - addTerrainLayerRemovedListener
```
public void addTerrainLayerRemovedListener(TerrainLayerRemovedListener l)
```
    添加一个用于接收地形图层移除事件TerrainLayerRemovedEvent的监听器。
    
    参数:
    
    l - 一个用于接收地形图层移除事件的监听器。
  - removeTerrainLayerRemovedListener
```
public void removeTerrainLayerRemovedListener(TerrainLayerRemovedListener l)
```
    移除一个用于接收地形图层移除事件TerrainLayerRemovedEvent的监听器。
    
    参数:
    
    l - 一个用于接收地形图层移除事件的监听器。
  - addTerrainLayerCaptionChangedListener
```
public void addTerrainLayerCaptionChangedListener(TerrainLayerCaptionChangedListener l)
```
    添加一个用于接收地形图层标题改变事件（TerrainLayerCaptionChangedEvent）的监听器。
    
    参数:
    
    l - 一个用于接收地形图层标题改变事件的监听器。
  - removeTerrainLayerCaptionChangedListener
```
public void removeTerrainLayerCaptionChangedListener(TerrainLayerCaptionChangedListener l)
```
    移除一个用于接收地形图层标题改变事件（TerrainLayerCaptionChangedEvent）的监听器。
    
    参数:
    
    l - 一个用于接收地形图层标题改变事件的监听器。
  - addTerrainLayerVisibleChangedListener
```
public void addTerrainLayerVisibleChangedListener(TerrainLayerVisibleChangedListener l)
```
    添加一个用于接收地形图层可视状态改变事件（TerrainLayerVisibleChangedEvent）的监听器。
    
    参数:
    
    l - 一个用于接收地形图层可视状态改变事件的监听器。
  - removeTerrainLayerVisibleChangedListener
```
public void removeTerrainLayerVisibleChangedListener(TerrainLayerVisibleChangedListener l)
```
    移除一个用于接收地形图层可视状态改变事件（TerrainLayerVisibleChangedEvent）的监听器。
    
    参数:
    
    l - 一个用于接收地形图层可视状态改变事件的监听器。
  - getSlopeSetting
```
public SlopeSetting getSlopeSetting()
```
    用于获取地形图层的坡度分析设置信息。
    
    返回:
    
    坡度分析设置信息
  - setSlopeSetting
```
public void setSlopeSetting(SlopeSetting slopeSetting)
```
    用于设置地形图层的坡度分析设置信息。
    
    参数:
    
    slopeSetting - 坡度分析设置信息
  - getHypsometricSetting
```
public HypsometricSetting getHypsometricSetting()
```
    用于获取地形图层的等值线设置信息。
    
    返回:
    
    等值线设置信息
  - setHypsometricSetting
```
public void setHypsometricSetting(HypsometricSetting hypsometricSetting)
```
    用于设置地形图层的等值线设置信息。
    
    参数:
    
    hypsometricSetting - 等值线设置信息
  - getSlopeValue
```
public double getSlopeValue(Point3D point3d)
```
    获取坡度分析中某一个三维点所在位置的坡度信息。
    
    参数:
    
    point3d - 指定一个三维点
    
    返回:
    
    坡度值
  - isNormalEnable
```
public boolean isNormalEnable()
```
    获取当前场景的栅格图层是否显示法线。
    
    返回:
    
    是否显示法线
  - setNormalEnable
```
public void setNormalEnable(boolean isNormalEnable)
```
    设置当前场景的栅格图层是否显示法线。
    
    参数:
    
    isNormalEnable - 是否显示法线
  - getFillMode3D
```
public FillMode3D getFillMode3D()
```
    TIN地形在场景中获取填充模式。
    
    返回:
    
    填充模式
  - setFillMode3D
```
public void setFillMode3D(FillMode3D mode3D)
```
    TIN地形在场景中设置填充模式。
    
    参数:
    
    mode3D - 填充模式
  - getSlopeDirectionValues
```
public double getSlopeDirectionValues(Point3D position)
```
    获取场景地形特定位置的坡向。
    
    参数:
    
    position - 特定位置
    
    返回:
    
    坡向值
  - refresh
```
public void refresh()
```
    在不显示法线进行坡度坡向分析师，刷新地形场景

类 TerrainLayers

方法概要

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

方法详细资料

getCount

get

get

add

add

add

add

add

add

remove

remove

clear

indexOf

contains

moveToTop

moveToBottom

moveUp

moveDown

moveTo

getModifyTerrainSetting

getHistory

setHistory

addSTK

addTerrainLayerRefreshListener

removeTerrainLayerRefreshListener

addTerrainLayerAddedListener

removeTerrainLayerAddedListener

addTerrainLayerRemovedListener

removeTerrainLayerRemovedListener

addTerrainLayerCaptionChangedListener

removeTerrainLayerCaptionChangedListener

addTerrainLayerVisibleChangedListener

removeTerrainLayerVisibleChangedListener

getSlopeSetting

setSlopeSetting

getHypsometricSetting

setHypsometricSetting

getSlopeValue

isNormalEnable

setNormalEnable

getFillMode3D

setFillMode3D

getSlopeDirectionValues

refresh