Layer3DDataset (iObjects Java Help)

java.lang.Object
- com.supermap.data.InternalHandle
- - com.supermap.realspace.Layer3D
  - - com.supermap.realspace.Layer3DDataset

直接已知子类:

Layer3DVideo, LayerVideoDataset, LayerVideoGrid, LayerVideoVector
```
public class Layer3DDataset
extends Layer3D
```
三维数据集图层类。该类继承自Layer3D 类。

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`void`	`addSteppedListener(SteppedListener l)`
`boolean`	`convertStyledRegionsToDataset(Datasource datasource, String value)` 已过时。
`Layer3DSetting`	`getAdditionalSetting()` 返回三维图层扩展设置信息。
`float`	`getBrightness()` 获取影像颜色的亮度。
`float`	`getConstantPolygonOffset()` 获取多边形偏移常量，默认值为1.0。
`float`	`getConstrast()` 获取影像颜色的对比度。
`CullModeType`	`getCullMode()` 获取单双面绘制模式。
`Dataset`	`getDataset()` 返回当前图层对应的数据集对象。
`QueryParameter`	`getDisplayFilter()` 返回在三维图层中显示过滤条件。
`CacheFileType`	`getFileType()` 获取三维数据集生成三维切片缓存时采用的数据格式类型。
`float`	`getGamma()` 获取影像颜色的明度。
`float`	`getHue()` 获取影像颜色的色相。
`HypsometricSetting`	`getHypsometricSetting()` 获取三维实体模型分层设色。
`boolean`	`getIsBuildOSGBCache()` 获取该数据集图层是否生成三维切片缓存。
`int`	`getLODCount()` 获取数据集图层的LOD层数。
`double`	`getLODRangeScale()` 获取数据集图层设置LOD缩放比例,仅对模型数据集图层起作用。
`double`	`getMaxDataValue()` 获取三维图层数据的最大属性值
`double`	`getMinDataValue()` 获取三维图层数据的最小属性值
`PipeLayerSettings`	`getPipeLayerSettings()`
`String`	`getPreCachePath()` 返回预缓存路径。
`double`	`getRegionOffsettingSize()` 获取多边形外扩。
`float`	`getSaturation()` 获取影像颜色的饱和度。
`boolean`	`getSCPRelated()` 获取是否关联SCP文件字段。
`String`	`getSCPRelatedField()` 获取是否关联SCP文件的字段。
`float`	`getSlopeScalePolygonOffset()` 获取多边形偏移深度斜率因子，默认值0.0。
`Theme3D`	`getTheme()` 返回当前的三维专题图层的专题图对象，针对专题图层。
`double`	`getTileWidth()` 获取数据集图层的切块大小。
`WireFrameType`	`getWireFrameMode()` 获取模型线框显示模式。
`boolean`	`isBuildOSGBPipeCache()` 获取是否生成管线缓存。
`boolean`	`isColorByCategory()` 获取是否根据w位显示效果。
`void`	`removeSteppedListener(SteppedListener l)`
`void`	`setAdditionalSetting(Layer3DSetting value)` 设置三维图层扩展设置信息。
`void`	`setBrightness(float value)` 设置影像颜色的亮度。
`void`	`setBuildOSGBPipeCache(boolean isBuildOSGBPipeCache)` 设置是否生成管线缓存。
`void`	`setColorByCategory(boolean value)` 设置是否根据w位显示效果，
`void`	`setConstantPolygonOffset(float value)` 设置多边形偏移常量，默认值为1.0。
`void`	`setConstrast(float value)` 设置影像颜色的对比度。
`void`	`setCullMode(CullModeType value)` 设置单双面绘制模式。
`void`	`setDisplayFilter(QueryParameter queryParameter)` 设置在三维图层中显示过滤条件。
`void`	`setFileType(CacheFileType value)` 设置三维数据集生成三维切片缓存时采用的数据格式类型。
`void`	`setGamma(float value)` 设置影像颜色的明度。
`void`	`setHue(float value)` 设置影像颜色的色相。
`void`	`setHypsometricSetting(HypsometricSetting value)` 设置三维实体模型分层设色。
`void`	`setIsBuildOSGBCache(boolean value)` 设置该数据集图层是否生成三维切片缓存。
`void`	`setLODCount(int value)` 设置数据集图层的LOD层数。
`void`	`setLODRangeScale(double value)` 设置数据集图层设置LOD缩放比例,仅对模型数据集图层起作用。
`void`	`setObjectsVisible(int[] ids, boolean visible)` 用于设置对象ID列表的可见性。
`void`	`setPipeLayerSettings(PipeLayerSettings settings)`
`void`	`setPreCachePath(String value)` 设置预缓存路径。
`void`	`setRegionOffsettingSize(double value)` 设置多边形外扩。
`void`	`setSaturation(float value)` 设置影像颜色的饱和度。
`void`	`setSCPRelated(boolean value)` 设置是否关联SCP文件字段。
`void`	`setSCPRelatedField(String value)` 设置是否关联SCP文件的字段。
`void`	`setSlopeScalePolygonOffset(float value)` 设置多边形偏移深度斜率因子，默认值0.0。
`void`	`setTileWidth(double value)` 设置数据集图层的切块大小。
`void`	`setWireFrameMode(WireFrameType value)` 设置模型线框显示模式。
`boolean`	`toDatasetVector(Datasource datasource, String datasetName)` 将三维数据集类型的图层保存为 CAD 模型数据集。
`void`	`updateTheme3DStyle()` 更新文本风格

从类继承的方法 com.supermap.realspace.Layer3D
clearCustomClipPlane, clipByBox, fromXML, getAlphaReject, getBounds, getBoxClipPart, getCaption, getClipBox, getClipLineColor, getCustomClipCross, getCustomClipPlane, getDataName, getDescription, getEditFeature, getExtendXML, getFeatures, getFilterPixelSize, getMapServiceType, getMaxObjectVisibleDistance, getMaxVisibleAltitude, getMinObjectVisibleDistance, getMinVisibleAltitude, getMixColorType, getName, getParentGroup, getParentLayer, getPassword, getReceiveSunLight, getReleaseWhenInvisible, getSelection, getShdowType, getSnap, getSwipeRegion, getType, getVisibleDistance, getVisibleInViewport, hasLocalCache, isAlwaysRender, isChangedToLayerStyle, isDisposed, isEditable, isSelectable, isShadowEnable, isSketchMode, isSwipeEnable, isVisible, isWebDatasource, setAlphaReject, setAlwaysRender, setCaption, setChangedToLayerStyle, setClipLineColor, setCustomClipCross, setCustomClipPlane, setDescription, setEditable, setFilterPixelSize, setLocalCache, setMaxObjectVisibleDistance, setMaxVisibleAltitude, setMinObjectVisibleDistance, setMinVisibleAltitude, setMixColorType, setParentGroup, setParentLayer, setReceiveSunLight, setReleaseWhenInvisible, setSelectable, setSelection, setShadowEnable, setShadowType, setSkecthMode, setSketchMode, setSnap, setSwipeEnable, setSwipeRegion, setVisible, setVisibleDistance, setVisibleInViewport, toXML, updateData

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

- 方法详细资料
  - getHypsometricSetting
```
public HypsometricSetting getHypsometricSetting()
```
    获取三维实体模型分层设色。
    
    返回:
    
    分层设色类
  - setHypsometricSetting
```
public void setHypsometricSetting(HypsometricSetting value)
```
    设置三维实体模型分层设色。
    
    参数:
    
    value - 分层设色类
  - getPipeLayerSettings
```
public PipeLayerSettings getPipeLayerSettings()
```
  - setPipeLayerSettings
```
public void setPipeLayerSettings(PipeLayerSettings settings)
```
  - getDataset
```
public Dataset getDataset()
```
    返回当前图层对应的数据集对象。
    图层是对数据集的引用，因而，一个图层与一个数据集相对应。
    
    返回:
    
    当前图层对应的数据集对象。
  - convertStyledRegionsToDataset
```
@Deprecated
public boolean convertStyledRegionsToDataset(Datasource datasource,
                                                          String value)
```
    已过时。
  - toDatasetVector
```
public boolean toDatasetVector(Datasource datasource,
                               String datasetName)
```
    将三维数据集类型的图层保存为 CAD 模型数据集。
    该方法适用于对三维数据集类型的图层进行如下设置后调用，所生成的 CAD 模型数据集加载到三维场景中时的风格与进过设置后的图层效果一样。
    1.对三维数据集类型的图层可对其制作专题图。
    
    2.对点或线类型的三维数据集图层设置三维点或线符号。
    
    3.面类型的数据集设置图层属性（如设置高度模式和拉伸高度等）。
    
    参数:
    
    datasource - 用户指定的目标数据源，若为空则生成到当前图层所在的数据源。
    
    datasetName - 用户指定生成的数据集名称，若为空则采用默认的 NewCADDataset 命名，若有重名，则加“_1”。
    
    返回:
    
    成功返回 true，失败返回 false。
  - getTheme
```
public Theme3D getTheme()
```
    返回当前的三维专题图层的专题图对象，针对专题图层。三维图层的专题图类型是在添加数据集作为一个三维图层显示时指定，即通过 Layer3Ds 类的 add() 方法中指定，之后不可更改其专题图类型，只可以对其专题图风格进行修改。
    
    返回:
    
    当前的三维专题图层的专题图对象。
  - getDisplayFilter
```
public QueryParameter getDisplayFilter()
```
    返回在三维图层中显示过滤条件。
    通过设置显示过滤条件，可以使图层中的一些要素显示，而另一些要素不显示，以便重点分析感兴趣的要素，而过滤掉其他要素。比如说通过连接（JoinItem）的方式将一个外部表的字段作为专题图的表达字段，在生成专题图后进行显示时，需要设置本方法，否则专题图创建失败。
    注意：在空间查询中，该方法仅对属性数据起作用，对空间数据不起作用。
    
    返回:
    
    在三维图层中显示过滤条件。
  - setDisplayFilter
```
public void setDisplayFilter(QueryParameter queryParameter)
```
    设置在三维图层中显示过滤条件。
    通过设置显示过滤条件，可以使图层中的一些要素显示，而另一些要素不显示，以便重点分析感兴趣的要素，而过滤掉其他要素。比如说通过连接（JoinItem）的方式将一个外部表的字段作为专题图的表达字段，在生成专题图后进行显示时，需要设置本方法，否则专题图创建失败。
    注意：在空间查询中，该方法仅对属性数据起作用，对空间数据不起作用。
    
    参数:
    
    queryParameter - 三维图层中显示过滤条件。
  - getAdditionalSetting
```
public Layer3DSetting getAdditionalSetting()
```
    返回三维图层扩展设置信息。有关三维图层扩展设置，请参见 Layer3DSetting 类。
    
    返回:
    
    三维图层扩展设置信息。
  - setAdditionalSetting
```
public void setAdditionalSetting(Layer3DSetting value)
```
    设置三维图层扩展设置信息。有关三维图层扩展设置，请参见 Layer3DSetting 类。
    
    参数:
    
    value - 三维图层扩展设置信息。
  - addSteppedListener
```
public void addSteppedListener(SteppedListener l)
```
  - removeSteppedListener
```
public void removeSteppedListener(SteppedListener l)
```
  - getPreCachePath
```
public String getPreCachePath()
```
    返回预缓存路径。数据集动态发布时使用。
    
    返回:
    
    预缓存路径。
  - setPreCachePath
```
public void setPreCachePath(String value)
```
    设置预缓存路径。数据集动态发布时使用。
    
    参数:
    
    value - 指定的路径。
  - getIsBuildOSGBCache
```
public boolean getIsBuildOSGBCache()
```
    获取该数据集图层是否生成三维切片缓存。
    
    返回:
  - setIsBuildOSGBCache
```
public void setIsBuildOSGBCache(boolean value)
```
    设置该数据集图层是否生成三维切片缓存。
    当数据集类型是矢量数据时，设置“layer3Ddataset.setIsBuildOSGBCache(false);”，则生成矢量缓存，其配置文件为 *.scv 格式。设置“layer3Ddataset.setIsBuildOSGBCache(true);”，则生成三维切片缓存，其配置文件为 *.scp 格式。
  - setObjectsVisible
```
public void setObjectsVisible(int[] ids,
                              boolean visible)
```
    用于设置对象ID列表的可见性。该方法只支持模型数据集，暂不支持其他类型数据集。
    
    参数:
    
    ids - 对象ID队列。
    
    visible - 对象的可见性。
  - getFileType
```
public CacheFileType getFileType()
```
    获取三维数据集生成三维切片缓存时采用的数据格式类型。
    
    返回:
    
    数据格式类型。
  - setFileType
```
public void setFileType(CacheFileType value)
```
    设置三维数据集生成三维切片缓存时采用的数据格式类型。
    
    参数:
    
    value - 指定的数据格式类型。
  - isBuildOSGBPipeCache
```
public boolean isBuildOSGBPipeCache()
```
    获取是否生成管线缓存。
    
    返回:
    
    true表示生成管线缓存成功，false表示生成管线缓存失败。
  - setBuildOSGBPipeCache
```
public void setBuildOSGBPipeCache(boolean isBuildOSGBPipeCache)
```
    设置是否生成管线缓存。
    
    参数:
    
    isBuildOSGBPipeCache - 是否生成。
  - getTileWidth
```
public double getTileWidth()
```
    获取数据集图层的切块大小。单位与数据集范围的单位一致。
    
    返回:
    
    数据集图层的切块大小。
  - setTileWidth
```
public void setTileWidth(double value)
```
    设置数据集图层的切块大小。单位与数据集范围的单位一致。
    
    参数:
    
    value - 指定的切块大小。
  - getWireFrameMode
```
public WireFrameType getWireFrameMode()
```
    获取模型线框显示模式。
    
    返回:
    
    线框显示模式。
  - setWireFrameMode
```
public void setWireFrameMode(WireFrameType value)
```
    设置模型线框显示模式。
    
    参数:
    
    value - 指定的线框显示模式。
  - getSCPRelated
```
public boolean getSCPRelated()
```
    获取是否关联SCP文件字段。
    
    返回:
    
    是否关联SCP文件字段。
  - setSCPRelated
```
public void setSCPRelated(boolean value)
```
    设置是否关联SCP文件字段。
    
    参数:
    
    value - 指定是否关联SCP文件字段。
  - getSCPRelatedField
```
public String getSCPRelatedField()
```
    获取是否关联SCP文件的字段。
    
    返回:
    
    是否关联SCP文件的字段。
  - setSCPRelatedField
```
public void setSCPRelatedField(String value)
```
    设置是否关联SCP文件的字段。
    
    参数:
    
    value - 指定字段。
  - getBrightness
```
public float getBrightness()
```
    获取影像颜色的亮度。
    
    返回:
    
    亮度。
  - setBrightness
```
public void setBrightness(float value)
```
    设置影像颜色的亮度。
    
    参数:
    
    value - 指定的亮度。
  - getConstrast
```
public float getConstrast()
```
    获取影像颜色的对比度。
    
    返回:
    
    对比度。
  - setConstrast
```
public void setConstrast(float value)
```
    设置影像颜色的对比度。
    
    参数:
    
    value - 指定的对比度。
  - getHue
```
public float getHue()
```
    获取影像颜色的色相。
    
    返回:
    
    色相。
  - setHue
```
public void setHue(float value)
```
    设置影像颜色的色相。
    
    参数:
    
    value - 指定的色相。
  - getSaturation
```
public float getSaturation()
```
    获取影像颜色的饱和度。
    
    返回:
    
    饱和度。
  - setSaturation
```
public void setSaturation(float value)
```
    设置影像颜色的饱和度。
    
    参数:
    
    value - 指定的饱和度。
  - getGamma
```
public float getGamma()
```
    获取影像颜色的明度。
    
    返回:
    
    明度。
  - setGamma
```
public void setGamma(float value)
```
    设置影像颜色的明度。
    
    参数:
    
    value - 指定的明度。
  - getConstantPolygonOffset
```
public float getConstantPolygonOffset()
```
    获取多边形偏移常量，默认值为1.0。当值为正值时，表示多边形朝屏幕外偏移；为负值时，表示多边形朝屏幕内偏移。
    
    返回:
    
    多边形偏移常量。
  - setConstantPolygonOffset
```
public void setConstantPolygonOffset(float value)
```
    设置多边形偏移常量，默认值为1.0。当值为正值时，表示多边形朝屏幕外偏移；为负值时，表示多边形朝屏幕内偏移。
    
    参数:
    
    value - 指定的多边形偏移常量。
  - isColorByCategory
```
public boolean isColorByCategory()
```
    获取是否根据w位显示效果。
    
    返回:
    
    是否根据w位显示效果。
  - setColorByCategory
```
public void setColorByCategory(boolean value)
```
    设置是否根据w位显示效果，
    
    参数:
    
    value - 指定是否根据w位显示效果。
  - getLODCount
```
public int getLODCount()
```
    获取数据集图层的LOD层数。
    
    返回:
    
    LOD层数。
  - setLODCount
```
public void setLODCount(int value)
```
    设置数据集图层的LOD层数。
    
    参数:
    
    value - 指定的LOD层数。
  - getLODRangeScale
```
public double getLODRangeScale()
```
    获取数据集图层设置LOD缩放比例,仅对模型数据集图层起作用。
    
    返回:
    
    LOD缩放比例。
  - setLODRangeScale
```
public void setLODRangeScale(double value)
```
    设置数据集图层设置LOD缩放比例,仅对模型数据集图层起作用。
    
    参数:
    
    value - 指定的LOD缩放比例。
  - getSlopeScalePolygonOffset
```
public float getSlopeScalePolygonOffset()
```
    获取多边形偏移深度斜率因子，默认值0.0。深度斜率是指当贯穿一个多边形时，用X坐标（或Y坐标）的变化量除以Z坐标的变化量所得的比值。
    
    返回:
    
    多边形偏移深度斜率因子。
  - setSlopeScalePolygonOffset
```
public void setSlopeScalePolygonOffset(float value)
```
    设置多边形偏移深度斜率因子，默认值0.0。深度斜率是指当贯穿一个多边形时，用X坐标（或Y坐标）的变化量除以Z坐标的变化量所得的比值。
    
    参数:
    
    value - 指定的多边形偏移深度斜率因子。
  - getRegionOffsettingSize
```
public double getRegionOffsettingSize()
```
    获取多边形外扩。
    
    返回:
    
    多边形外扩。
  - setRegionOffsettingSize
```
public void setRegionOffsettingSize(double value)
```
    设置多边形外扩。
    
    参数:
    
    value - 指定的多边形外扩。
  - getCullMode
```
public CullModeType getCullMode()
```
    获取单双面绘制模式。
    
    返回:
    
    单双面绘制模式。
  - setCullMode
```
public void setCullMode(CullModeType value)
```
    设置单双面绘制模式。
    
    参数:
    
    value - 指定的单双面绘制模式。
  - updateTheme3DStyle
```
public void updateTheme3DStyle()
```
    更新文本风格
  - getMinDataValue
```
public double getMinDataValue()
```
    获取三维图层数据的最小属性值
    
    返回:
    
    三维图层数据的最小属性值
  - getMaxDataValue
```
public double getMaxDataValue()
```
    获取三维图层数据的最大属性值
    
    返回:
    
    三维图层数据的最大属性值

类 Layer3DDataset

方法概要

从类继承的方法 com.supermap.realspace.Layer3D

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

方法详细资料

getHypsometricSetting

setHypsometricSetting

getPipeLayerSettings

setPipeLayerSettings

getDataset

convertStyledRegionsToDataset

toDatasetVector

getTheme

getDisplayFilter

setDisplayFilter

getAdditionalSetting

setAdditionalSetting

addSteppedListener

removeSteppedListener

getPreCachePath

setPreCachePath

getIsBuildOSGBCache

setIsBuildOSGBCache

setObjectsVisible

getFileType

setFileType

isBuildOSGBPipeCache

setBuildOSGBPipeCache

getTileWidth

setTileWidth

getWireFrameMode

setWireFrameMode

getSCPRelated

setSCPRelated

getSCPRelatedField

setSCPRelatedField

getBrightness

setBrightness

getConstrast

setConstrast

getHue

setHue

getSaturation

setSaturation

getGamma

setGamma

getConstantPolygonOffset

setConstantPolygonOffset

isColorByCategory

setColorByCategory

getLODCount

setLODCount

getLODRangeScale

setLODRangeScale

getSlopeScalePolygonOffset

setSlopeScalePolygonOffset

getRegionOffsettingSize

setRegionOffsettingSize

getCullMode

setCullMode

updateTheme3DStyle

getMinDataValue

getMaxDataValue