所有类

概要:
嵌套 |
字段 |
构造器 |
方法

详细资料:
字段 |
构造器 |
方法

java.lang.Object
- com.supermap.realspace.Sun

```
public class Sun
extends Object
```
太阳对象类。
太阳效果用来模拟真实场景中的太阳光影效果。通过对太阳位置的设置，可以模拟出不同时区的光照以及阴影效果。

下面两张图片为开启太阳效果前后的对比图。

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`TimeZone`	`getCurrentTimeZone()` 已过时。
`float`	`getLightCascadeShadowMapLamda()` 返回场景主光源的级联阴影的分割点lamda值。
`Color`	`getLightColor()` 返回场景太阳光颜色。
`double`	`getLightIntensity()` 返回场景太阳光强度。
`float`	`getLightShadowDarkness()` 返回太阳光阴影浓度。
`float`	`getLightShadowDepthBias()` 返回阴影深度偏移。
`double`	`getLightShadowDistance()` 返回场景产生阴影的距离。
`float`	`getLightShadowSharpness()` 返回主光源产生的阴影边缘的锐化程度。
`double`	`getLightShadowVisibleDistance()` 返回阴影的可见距离，单位为米。
`float`	`getLightShaftBloomScale()` 获取场景的太阳光束强度。
`float`	`getLightShaftMaxBrightness()` 获取场景的太阳光束最大亮度。
`Calendar`	`getSunDateTime()` 已过时。
`Point`	`getTimeSliderPos()` 已过时。
`Point3D`	`getViewerGeoPosition()`
`boolean`	`isLightCameraTrackingEnabled()` 返回场景中模拟太阳光源使用时间的时区是否随着相机位置改变而相应修改。
`boolean`	`isLightShadowEnabled()` 返回是否开启了太阳光阴影。
`boolean`	`isLightShaftEnabled()` 返回场景是否开启太阳光束。
`boolean`	`isTimeSliderVisible()` 已过时。
`boolean`	`isVisible()` 返回太阳是否可见。
`void`	`setCurrentTimeZone(TimeZone value)` 已过时。
`void`	`setLightCameraTrackingEnabled(boolean sunLightCameraTrackingEnabled)` 设置场景中模拟太阳光源使用时间的时区是否随着相机位置改变而相应修改。
`void`	`setLightCascadeShadowMapLamda(float sunLightCascadeShadowMapLamda)` 设置场景主光源的级联阴影的分割点lamda值。
`void`	`setLightColor(Color value)` 设置场景太阳光颜色。
`void`	`setLightIntensity(double value)` 设置场景太阳光强度。
`void`	`setLightShadowDarkness(float shadowDarkness)` 设置太阳光阴影浓度。
`void`	`setLightShadowDepthBias(float depthBias)` 设置阴影深度偏移。
`void`	`setLightShadowDistance(double shadowDistance)` 设置场景产生阴影的距离。
`void`	`setLightShadowEnabled(boolean value)` 设置是否开启太阳光阴影
`void`	`setLightShadowSharpness(float mainLightShadowSharpness)` 设置主光源产生的阴影边缘的锐化程度。
`void`	`setLightShadowVisibleDistance(double value)` 设置阴影的可见距离，单位为米。
`void`	`setLightShaftBloomScale(float value)` 设置场景的太阳光束强度。
`void`	`setLightShaftEnabled(boolean value)` 设置场景是否开启太阳光束。
`void`	`setLightShaftMaxBrightness(float value)` 设置场景的太阳光束最大亮度。
`void`	`setSunDateTime(Calendar value)` 已过时。
`void`	`setTimeSliderPos(Point value)` 已过时。
`void`	`setTimeSliderVisible(boolean visible)` 已过时。
`void`	`setViewerGeoPosition(Point3D point3D)`
`void`	`setVisible(boolean value)` 设置太阳是否可见。

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

- 方法详细资料
  - setVisible
```
public void setVisible(boolean value)
```
    设置太阳是否可见。
    
    参数:
    
    value - 类型值为boolean，true表示太阳可见，false表示太阳不可见。
  - isVisible
```
public boolean isVisible()
```
    返回太阳是否可见。
    
    返回:
    
    类型值为boolean，true 表示太阳可见，false 表示太阳不可见。
  - setSunDateTime
```
@Deprecated
public void setSunDateTime(Calendar value)
```
    已过时。
  - getSunDateTime
```
@Deprecated
public Calendar getSunDateTime()
```
    已过时。
  - setCurrentTimeZone
```
@Deprecated
public void setCurrentTimeZone(TimeZone value)
```
    已过时。
  - getCurrentTimeZone
```
@Deprecated
public TimeZone getCurrentTimeZone()
```
    已过时。
  - setTimeSliderVisible
```
@Deprecated
public void setTimeSliderVisible(boolean visible)
```
    已过时。
  - isTimeSliderVisible
```
@Deprecated
public boolean isTimeSliderVisible()
```
    已过时。
  - getTimeSliderPos
```
@Deprecated
public Point getTimeSliderPos()
```
    已过时。
  - setTimeSliderPos
```
@Deprecated
public void setTimeSliderPos(Point value)
```
    已过时。
  - getViewerGeoPosition
```
public Point3D getViewerGeoPosition()
```
  - setViewerGeoPosition
```
public void setViewerGeoPosition(Point3D point3D)
```
  - isLightShaftEnabled
```
public boolean isLightShaftEnabled()
```
    返回场景是否开启太阳光束。默认为false，不开启太阳光束。
    
    返回:
    
    场景是否开启太阳光束。返回true表示开启太阳光束;返回false表示不开启太阳光束。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
    
    从以下版本开始:
    
    12.0.0。
  - setLightShaftEnabled
```
public void setLightShaftEnabled(boolean value)
```
    设置场景是否开启太阳光束。
    默认值为false，表示默认不开启太阳光束。
    
    参数:
    
    value - 是否开启太阳光束。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
    
    从以下版本开始:
    
    12.0.0。
  - setLightShaftBloomScale
```
public void setLightShaftBloomScale(float value)
```
    设置场景的太阳光束强度。
    
    参数:
    
    value - 指定的太阳光束强度,默认值为0.7，范围为[0.0,5.0]。
    只支持渲染引擎V2上使用。
    
    从以下版本开始:
    
    12.0.0。
  - getLightShaftBloomScale
```
public float getLightShaftBloomScale()
```
    获取场景的太阳光束强度。
    
    返回:
    
    场景的太阳光束强度,默认值为0.7。
    只支持渲染引擎V2上使用。
    
    从以下版本开始:
    
    12.0.0。
  - setLightShaftMaxBrightness
```
public void setLightShaftMaxBrightness(float value)
```
    设置场景的太阳光束最大亮度。
    
    参数:
    
    value - 指定的太阳光束最大亮度,默认值为2.0，范围[0.0,20.0]。
    只支持渲染引擎V2上使用。
    
    从以下版本开始:
    
    12.0.0。
  - getLightShaftMaxBrightness
```
public float getLightShaftMaxBrightness()
```
    获取场景的太阳光束最大亮度。
    
    返回:
    
    场景的太阳光束最大亮度,默认值为2.0。
    只支持渲染引擎V2上使用。
    
    从以下版本开始:
    
    12.0.0。
  - getLightIntensity
```
public double getLightIntensity()
```
    返回场景太阳光强度。
    
    返回:
    
    太阳光强度。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
    只支持渲染引擎V2上使用。
    
    从以下版本开始:
    
    12.0.0。
  - setLightIntensity
```
public void setLightIntensity(double value)
```
    设置场景太阳光强度。
    
    参数:
    
    value - 太阳光强度，范围[0 - 8]。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
    只支持渲染引擎V2上使用。
    
    从以下版本开始:
    
    12.0.0。
  - isLightCameraTrackingEnabled
```
public boolean isLightCameraTrackingEnabled()
```
    返回场景中模拟太阳光源使用时间的时区是否随着相机位置改变而相应修改。
    默认值为true,表示当相机漫游至全球任何位置时，都采用太阳轨迹轴上设置的时间，转换为相机位置当地时间，来模拟太阳光照。
    
    返回:
    
    场景中模拟太阳光源使用时间的时区是否随着相机位置改变而相应修改。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
    只支持渲染引擎V2上使用。
    
    从以下版本开始:
    
    12.0.0。
  - setLightCameraTrackingEnabled
```
public void setLightCameraTrackingEnabled(boolean sunLightCameraTrackingEnabled)
```
    设置场景中模拟太阳光源使用时间的时区是否随着相机位置改变而相应修改。
    
    参数:
    
    sunLightCameraTrackingEnabled - 场景中模拟太阳光源使用时间的时区是否随着相机位置改变而相应修改。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
    只支持渲染引擎V2上使用。
    
    从以下版本开始:
    
    12.0.0。
  - getLightColor
```
public Color getLightColor()
```
    返回场景太阳光颜色。
    
    返回:
    
    太阳光颜色。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
    
    从以下版本开始:
    
    12.0.0。
  - setLightColor
```
public void setLightColor(Color value)
```
    设置场景太阳光颜色。
    
    参数:
    
    value - 太阳光颜色。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
    
    从以下版本开始:
    
    12.0.0。
  - getLightCascadeShadowMapLamda
```
public float getLightCascadeShadowMapLamda()
```
    返回场景主光源的级联阴影的分割点lamda值。
    范围是[0,1],默认值是0.5。0表示按等距离分割级联阴影(有利于较远距离的阴影清晰度)；1表示指数分割级联阴影(有利于非常近的阴影清晰度)。介于两者之间为这两种分割方式的混合。
    
    返回:
    
    场景主光源的级联阴影的分割点lamda值。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
    只支持渲染引擎V2上使用。
    
    从以下版本开始:
    
    12.0.0。
  - setLightCascadeShadowMapLamda
```
public void setLightCascadeShadowMapLamda(float sunLightCascadeShadowMapLamda)
```
    设置场景主光源的级联阴影的分割点lamda值。
    
    参数:
    
    sunLightCascadeShadowMapLamda - 场景主光源的级联阴影的分割点lamda值。范围是[0,1],默认值是0.5。0表示按等距离分割级联阴影(有利于较远距离的阴影清晰度)；1表示指数分割级联阴影(有利于非常近的阴影清晰度)。介于两者之间为这两种分割方式的混合。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
    只支持渲染引擎V2上使用。
    
    从以下版本开始:
    
    12.0.0。
  - getLightShadowSharpness
```
public float getLightShadowSharpness()
```
    返回主光源产生的阴影边缘的锐化程度。
    范围是[0,1]，0表示不进行锐化，1表示最大程度锐化。锐化会提高边界清晰度，但会降低柔和感并有微弱锯齿。默认值为0。
    
    返回:
    
    主光源产生的阴影边缘的锐化程度。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
    只支持渲染引擎V2上使用。
    
    从以下版本开始:
    
    12.0.0。
  - setLightShadowSharpness
```
public void setLightShadowSharpness(float mainLightShadowSharpness)
```
    设置主光源产生的阴影边缘的锐化程度。
    
    参数:
    
    mainLightShadowSharpness - 主光源产生的阴影边缘的锐化程度。范围是[0,1]，0表示不进行锐化，1表示最大程度锐化。锐化会提高边界清晰度，但会降低柔和感并有微弱锯齿。默认值为0。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
    只支持渲染引擎V2上使用。
    
    从以下版本开始:
    
    12.0.0。
  - getLightShadowVisibleDistance
```
public double getLightShadowVisibleDistance()
```
    返回阴影的可见距离，单位为米。
    
    返回:
    
    阴影的可见距离。单位为米。
    
    从以下版本开始:
    
    12.0.0。
    
    默认值:
    
    默认值为2000，单位为米。
  - setLightShadowVisibleDistance
```
public void setLightShadowVisibleDistance(double value)
```
    设置阴影的可见距离，单位为米。
    
    参数:
    
    value - 阴影的可见距离。单位为米。
    
    从以下版本开始:
    
    12.0.0。
  - isLightShadowEnabled
```
public boolean isLightShadowEnabled()
```
    返回是否开启了太阳光阴影。
    
    返回:
    
    是否开启了太阳光阴影。
    
    从以下版本开始:
    
    12.0.0。
  - setLightShadowEnabled
```
public void setLightShadowEnabled(boolean value)
```
    设置是否开启太阳光阴影
    
    参数:
    
    value - 是否开启太阳光阴影。
    
    从以下版本开始:
    
    12.0.0。
  - getLightShadowDepthBias
```
public float getLightShadowDepthBias()
```
    返回阴影深度偏移。
    
    返回:
    
    阴影深度偏移。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
    只支持渲染引擎V2上使用。
    
    从以下版本开始:
    
    12.0.0。
  - setLightShadowDepthBias
```
public void setLightShadowDepthBias(float depthBias)
```
    设置阴影深度偏移。
    
    参数:
    
    depthBias - 阴影深度偏移，范围[0 - 1]。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
    只支持渲染引擎V2上使用。
    
    从以下版本开始:
    
    12.0.0。
  - getLightShadowDarkness
```
public float getLightShadowDarkness()
```
    返回太阳光阴影浓度。
    
    返回:
    
    太阳光阴影浓度。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
    
    从以下版本开始:
    
    12.0.0。
  - setLightShadowDarkness
```
public void setLightShadowDarkness(float shadowDarkness)
```
    设置太阳光阴影浓度。
    
    参数:
    
    shadowDarkness - 太阳光阴影浓度，范围[0 - 1]。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
    
    从以下版本开始:
    
    12.0.0。
  - getLightShadowDistance
```
public double getLightShadowDistance()
```
    返回场景产生阴影的距离。
    
    返回:
    
    场景产生阴影距离。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
    
    从以下版本开始:
    
    12.0.0。
  - setLightShadowDistance
```
public void setLightShadowDistance(double shadowDistance)
```
    设置场景产生阴影的距离。
    
    参数:
    
    shadowDistance - 产生阴影距离。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
    
    从以下版本开始:
    
    12.0.0。

跳过导航链接

所有类

概要:
嵌套 |
字段 |
构造器 |
方法

详细资料:
字段 |
构造器 |
方法

类 Sun

方法概要

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

方法详细资料

setVisible

isVisible

setSunDateTime

getSunDateTime

setCurrentTimeZone

getCurrentTimeZone

setTimeSliderVisible

isTimeSliderVisible

getTimeSliderPos

setTimeSliderPos

getViewerGeoPosition

setViewerGeoPosition

isLightShaftEnabled

setLightShaftEnabled

setLightShaftBloomScale

getLightShaftBloomScale

setLightShaftMaxBrightness

getLightShaftMaxBrightness

getLightIntensity

setLightIntensity

isLightCameraTrackingEnabled

setLightCameraTrackingEnabled

getLightColor

setLightColor

getLightCascadeShadowMapLamda

setLightCascadeShadowMapLamda

getLightShadowSharpness

setLightShadowSharpness

getLightShadowVisibleDistance

setLightShadowVisibleDistance

isLightShadowEnabled

setLightShadowEnabled

getLightShadowDepthBias

setLightShadowDepthBias

getLightShadowDarkness

setLightShadowDarkness

getLightShadowDistance

setLightShadowDistance