Fog (iObjects Java Help)

java.lang.Object
- com.supermap.data.InternalHandle
- - com.supermap.data.InternalHandleDisposable
  - - com.supermap.realspace.Fog

所有已实现的接口:: IDisposable

public class Fog
extends com.supermap.data.InternalHandleDisposable

雾类。

该类包括了雾效果的设置信息，这些设置会影响雾的视觉效果。

示范代码:

以下代码示范了显示三维场景窗口，同时设置三维场景的雾对象。

     public void TestFog()
    {
        //构造一个雾对象，并对其进行设置
        Fog fog = new Fog();
        fog.setColor(Color.BLUE);
        fog.setDensity(0.6);
        fog.setEnable(true);
        fog.setFogMode(FogMode.LINEAR);

        //返回当前三维场景窗口的三维场景对象，同时设置三维场景的雾对象
        SceneControl sceneControl = new SceneControl();
        Scene sceneObject = sceneControl.getScene();
        sceneObject.setFogVisibleAltitude(10000000);
        sceneObject.setFog(fog);
        sceneObject.refresh();

        //释放占用的资源
        sceneControl.dispose();
        }

构造器概要

构造器
构造器和说明

Fog()
构造一个新的 Fog 对象。

构造器
构造器和说明
`Fog()` 构造一个新的 Fog 对象。

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`dispose()` 释放该对象所占用的资源。
`Color`	`getColor()` 返回雾的颜色。
`double`	`getDensity()` 返回雾的密度。
`double`	`getEndDistance()` 返回雾的终止距离。
`FogMode`	`getFogMode()` 返回雾的模式。
`double`	`getStartDistance()` 返回雾的开始距离。
`boolean`	`isEnable()` 返回是否启用雾效果。
`void`	`setColor(Color value)` 设置雾的颜色。
`void`	`setDensity(double value)` 设置雾的密度。
`void`	`setEnable(boolean value)` 设置是否启用雾效果。
`void`	`setEndDistance(double value)` 设置雾的终止距离。
`void`	`setFogMode(FogMode value)` 设置雾的模式。
`static void`	`setIsDisposable(com.supermap.data.InternalHandleDisposable obj, boolean disposable)`
`void`	`setStartDistance(double value)` 设置雾的开始距离。
`String`	`toString()` 输出一个字符串来表示当前的雾对象，格式为：{Mode=,Color=,Density=,StartDistance=,EndDistance=,IsEnabled= }。

从类继承的方法 com.supermap.data.InternalHandleDisposable
makeSureNativeObjectLive

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

- 构造器详细资料
  - Fog
```
public Fog()
```
    构造一个新的 Fog 对象。
- 方法详细资料
  - getFogMode
```
public FogMode getFogMode()
```
    返回雾的模式。
    
    返回:
    
    雾的模式。
    
    默认值:
    
    默认值为 EXP。
  - setFogMode
```
public void setFogMode(FogMode value)
```
    设置雾的模式。
    
    参数:
    
    value - 雾的模式。
  - getColor
```
public Color getColor()
```
    返回雾的颜色。
    
    返回:
    
    雾的颜色。
    
    默认值:
    
    默认值为 Color [A=255, R=255, G=255, B=255]。
  - setColor
```
public void setColor(Color value)
```
    设置雾的颜色。
    
    参数:
    
    value - 雾的颜色。
  - getDensity
```
public double getDensity()
```
    返回雾的密度。雾的密度决定了大气环境的透明度。该返回值的范围为 [0,1]，默认值为1。
    
    返回:
    
    雾的密度。
    
    默认值:
    
    默认值为1。
  - setDensity
```
public void setDensity(double value)
```
    设置雾的密度。雾的密度决定了大气环境的透明度。
    
    参数:
    
    value - 雾的密度。
  - getStartDistance
```
public double getStartDistance()
```
    返回雾的开始距离。单位为米。该方法只在雾的模式为 LINEAR 时有效。
    
    返回:
    
    雾的开始距离。单位为米。
    
    默认值:
    
    默认值为0，单位为米。
  - setStartDistance
```
public void setStartDistance(double value)
```
    设置雾的开始距离。单位为米。该方法只在雾的模式为 LINEAR 时有效。
    
    参数:
    
    value - 雾的开始距离。单位为米。
  - getEndDistance
```
public double getEndDistance()
```
    返回雾的终止距离。单位为米。该方法只在雾的模式为 LINEAR 时有效。
    
    返回:
    
    雾的终止距离。单位为米。
    
    默认值:
    
    默认值为1，单位为米。
  - setEndDistance
```
public void setEndDistance(double value)
```
    设置雾的终止距离。单位为米。该方法只在雾的模式为 LINEAR 时有效。
    
    参数:
    
    value - 雾的终止距离。单位为米。
  - isEnable
```
public boolean isEnable()
```
    返回是否启用雾效果。
    
    返回:
    
    启用雾效果返回 true；否则 false。
    
    默认值:
    
    默认值为false。
  - setEnable
```
public void setEnable(boolean value)
```
    设置是否启用雾效果。
    
    参数:
    
    value - 一个布尔值指定是否启用雾效果。
  - toString
```
public String toString()
```
    输出一个字符串来表示当前的雾对象，格式为：{Mode=,Color=,Density=,StartDistance=,EndDistance=,IsEnabled= }。
    
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    一个包含当前雾对象信息的字符串。
  - dispose
```
public void dispose()
```
    释放该对象所占用的资源。当调用该方法之后，此对象不再可用。
  - setIsDisposable
```
public static void setIsDisposable(com.supermap.data.InternalHandleDisposable obj,
                                   boolean disposable)
```

类 Fog

构造器概要

方法概要

从类继承的方法 com.supermap.data.InternalHandleDisposable

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

构造器详细资料

Fog

方法详细资料

getFogMode

setFogMode

getColor

setColor

getDensity

setDensity

getStartDistance

setStartDistance

getEndDistance

setEndDistance

isEnable

setEnable

toString

dispose

setIsDisposable