CIMCubeSDK v3.34.0

Class: Scene

Glodon.CIMCube. Scene

场景

new Scene(map, opts)

场景构造函数
Parameters:
Name Type Description
map Glodon.CIMCube CIMCube实例
opts Object 配置项

Classes

DirectionalLight
GroundSkyBox
PointLight
RealisticRendering
ReflectBox
SpotLight

Members

<readonly> ambientOcclusion :Object

设置AO
Type:
  • Object

aoOptimizeWhenMoving :Boolean

相机移动时是否启用AO性能优化
Type:
  • Boolean

atmosphere :Boolean

开启大气
Type:
  • Boolean

autoUpdateGlobeTransparency :Boolean

全局参数: 引擎内部是否自动更新Globe的透明属性(相机进出地下的场景)
Type:
  • Boolean

backgroundColor :Color

背景颜色
Type:
  • Color

baseMap :Object

底图设置
Type:
  • Object

brightness :Number

场景效果亮度
Type:
  • Number

<readonly> canvas :Object

画布
Type:
  • Object

castShadowAlphaThreshold :Number

全局参数: 当物体的alpha小于等于此阈值时不会投射阴影
Type:
  • Number

colorMode :String

调整色彩模式,默认为HSB;
Type:
  • String

contrast :Number

场景效果对比度
Type:
  • Number

<readonly> cutInstances :Object

剪切实例
Type:
  • Object

debugShowDrawCalls :Boolean

检测三角面数与顶点数(图层为单位),开启/关闭
Type:
  • Boolean

<readonly> debugShowDrawCallsConfig :Boolean

检测三角面数与顶点数参数
Type:
  • Boolean

debugShowFramesPerSecond :Boolean

调试显示帧率
Type:
  • Boolean

debugShowPostRender :Boolean

检测三角面数与顶点数,开启/关闭
Type:
  • Boolean

enableAnimation :Boolean

开启动画
Type:
  • Boolean

enableGlobeTerrainWireframe :Boolean

开启地面三角网格线
Type:
  • Boolean

enableGroundCollisionDetection :Boolean

是否开启地面碰撞检测，启动则返回true，否则返回false
Type:
  • Boolean

enableRealisticRendering :Boolean

全局参数: 是否开启真实感渲染模式（配合realisticRendering属性使用）
Type:
  • Boolean

<readonly> extent :Array

场景地理范围（单位：degree）
Type:
  • Array

firmamentSkyBox :Object

天空盒
Type:
  • Object

fixedLightDirection :Boolean

是否使用固定的光照方向
Type:
  • Boolean

fixedLightTime :String

固定光照的时刻 如'11:00:00'
Type:
  • String

<readonly> flatInstances :Object

平面实例
Type:
  • Object

<readonly> fog :Object

雾化
Type:
  • Object

gamma :Number

场景效果伽马校正
Type:
  • Number

hardwareAA :Boolean

硬件抗锯齿开启/关闭
Type:
  • Boolean

<readonly> height :Number

场景高度（单位：px）
Type:
  • Number

hue :Number

场景效果色相
Type:
  • Number

<readonly> light :Object

光源
Type:
  • Object

lightColor :Color

调整光颜色
Type:
  • Color

lightIntensity :Number

调整光强度
Type:
  • Number

logarithmicDepthBuffer :Boolean

log深度开启
Type:
  • Boolean

maxPitch :Number

相对于椭球体法线的最大倾斜角度，限制用户可以倾斜摄像头的程度。如果为 undefined，则摄像头倾斜角度不受限制。
Type:
  • Number

maxSightDistance :Number

最大视距范围,引擎默认50000000.0,即: 5000万米高空, 地球全貌
Type:
  • Number
Default Value:
  • 50000000.0

<readonly> memoryController :Object

内存控制
Type:
  • Object

minSightDistance :Number

最小视距范围,引擎默认1.0m,地下即负值
Type:
  • Number
Default Value:
  • 1.0

morphComplete :Event

当2D和3D模式转换结束时触发该事件
Type:
  • Event

morphStart :Event

当2D和3D模式转换开始时触发该事件
Type:
  • Event

msaaSamples :number

设置MSAA抗锯齿
Type:
  • number

nephogram :Boolean

开启云图
Type:
  • Boolean

<readonly> postProcessStages :Object

后期处理阶段
Type:
  • Object

<readonly> postProcessWater :PostProcessWaterOptions

后期处理水
Type:

postRender :Event

每帧渲染后触发该事件，传入事件的参数：第一个为Scene实例，第二个参数为当前时间
Type:
  • Event

postUpdate :Event

场景更新后触发该事件，传入事件的参数：第一个为Scene实例，第二个参数为当前时间
Type:
  • Event

preRender :Event

每帧渲染前触发该事件，传入事件的参数：第一个为Scene实例，第二个参数为当前时间
Type:
  • Event

preUpdate :Event

场景更新前触发该事件，传入事件的参数：第一个为Scene实例，第二个参数为当前时间
Type:
  • Event

RAMOverflow :Event

每当内存使用率超过阈值后触发该事件：第一个为当前内存使用情况（字节）
Type:
  • Event

<readonly> realisticRendering :RealisticRenderingOptions

真实感渲染场景
Type:

reflectBox :Glodon.CIMCube.Scene.ReflectBox

反射盒
Type:

<readonly> rendererManager :Object

渲染管理器
Type:
  • Object

renderError :Event

当渲染出错时触发该事件，传入事件的参数：第一个为Scene实例，第二个参数为异常实例
Type:
  • Event

saturation :Number

场景效果饱和度
Type:
  • Number

<readonly> screenSpaceCameraController :Object

根据对画布的鼠标输入来修改相机的位置和方向
Type:
  • Object

screenSpaceEventHandler :Glodon.CIMCube.ScreenSpaceEventHandler

屏幕空间事件处理
Type:
  • Glodon.CIMCube.ScreenSpaceEventHandler

shadowColor :Color

阴影颜色
Type:
  • Color

shadowIntensity :Number

阴影强度
Type:
  • Number

<readonly> shadowMap :Object

获取场景的阴影贴图
Type:
  • Object

shadowOptimizeWhenIdling :Boolean

相机静止时是否启用阴影性能优化
Type:
  • Boolean

shadowOptimizeWhenMoving :Boolean

相机移动时是否启用阴影性能优化
Type:
  • Boolean

shadowQuality :String

阴影质量
Type:
  • String

shadowRange :Number

阴影范围
Type:
  • Number

shadows :Object

阴影
Type:
  • Object

shadowUpdateFrequency :Number

阴影更新频率
Type:
  • Number

skyBox :Glodon.CIMCube.Scene.GroundSkyBox

天空盒
Type:

softShadows :Boolean

软阴影
Type:
  • Boolean

sunLightIntensity :Number

太阳光照强度
Type:
  • Number

terrainExaggeration :Number

地形夸张
Type:
  • Number

terrainProvider :Object

地形提供者
Type:
  • Object

terrainShadows :Glodon.CIMCube.Global.Defines.ShadowMode

阴影模式
Type:

useDefaultLabel :Boolean

使用默认注记
Type:
  • Boolean

useDefaultTerrain :Boolean

使用默认地形
Type:
  • Boolean

usePostProcessWater :Boolean

是否使用后期处理水
Type:
  • Boolean

<readonly> viewer :Object

视图
Type:
  • Object

<readonly> volumetricClouds :Object

体积云
Type:
  • Object

<readonly> width :Number

场景宽度（单位：px）
Type:
  • Number

Methods

addCutInstance(instance)

添加剪切实例
Parameters:
Name Type Description
instance Object 剪切实例
Returns:
Type
void

addFlatInstance(instance)

添加平面实例
Parameters:
Name Type Description
instance Object 平面实例
Returns:
Type
void

addLightSource(lightSource)

添加光源
Parameters:
Name Type Description
lightSource Glodon.CIMCube.Scene.PointLight | Glodon.CIMCube.Scene.SpotLight | Glodon.CIMCube.Scene.DirectionalLight 点光源
Returns:
Type
void

cartesianToWindowCoordinates(cartesian3)

笛卡尔坐标转屏幕坐标
Parameters:
Name Type Description
cartesian3 Cesium.Cartesian3 笛卡尔坐标
Returns:
屏幕坐标
Type
Cesium.Cartesian2

disableDefaultTerrain()

关闭默认地形

disableHdr()

关闭Hdr

disableMoon()

关闭月亮效果

dispose()

销毁场景

drillPick(mousePosition)

通过屏幕坐标获取相交实体
Parameters:
Name Type Description
mousePosition Object Object.x为横向像素坐标，Object.y为纵向像素坐标
Returns:
Type
Array

enableDefaultTerrain()

开启默认地形

enableHdr()

开启Hdr

enableMoon()

开始月亮效果

enableOrbit(bol, type)

是否开启场景姿态调整
Parameters:
Name Type Description
bol Boolean 表示是否开启姿态调整，默认true
type String 姿态调整的鼠标操作方式：默认：right，枚举：left（鼠标左键）、right（右键）、middle（中键）

enablePan(bol, type)

开启鼠标左键平移
Parameters:
Name Type Description
bol Boolean 是否开启平移，默认true
type String 平移的鼠标操作方式：默认：left，枚举：left（鼠标左键）、right（右键）、middle（中键）

enableZoom(bol)

是否开启地图缩放
Parameters:
Name Type Description
bol Boolean 默认：true，默认鼠标中键盘，不支持修改

isDestroyed()

是否销毁
Returns:
Type
Boolean

isOrbitEnabled()

获取当前场景是否开启了姿态调整操作
Returns:
Type
Boolean

isPanEnabled()

获取当前场景是否开启了平移操作
Returns:
Type
Boolean

isZoomEnabled()

获取当前场景是否开启了缩放操作

morphTo2D(duration)

切换到2D场景
Parameters:
Name Type Description
duration Number [optional] 切换时间，单位：秒，默认：2

morphTo3D(duration)

切换到3D场景
Parameters:
Name Type Description
duration Number [optional] 切换时间，单位：秒，默认：2

morphToColumbusView(duration)

切换到2.5D场景
Parameters:
Name Type Description
duration Number [optional] 切换时间，单位：秒，默认：2

pickGeoPoint(mousePosition)

通过屏幕坐标获取地理坐标
Parameters:
Name Type Description
mousePosition Object Object.x为横向像素坐标，Object.y为纵向像素坐标
Returns:
Type
Glodon.CIMCube.Graphic.GeoPoint

pickPosition(cartesian2)

通过屏幕坐标拾取场景坐标,包含地形和模型等场景空间坐标
Parameters:
Name Type Description
cartesian2 Cesium.Cartesian2 屏幕坐标
Returns:
场景坐标
Type
Cesium.Cartesian3

removeCutInstance(instance)

移除剪切实例
Parameters:
Name Type Description
instance Object 剪切实例
Returns:
Type
void

removeFlatInstance(instance)

移除平面实例
Parameters:
Name Type Description
instance Object 平面实例
Returns:
Type
void

removeLightSource(lightSource)

移除光源
Parameters:
Name Type Description
lightSource Glodon.CIMCube.Scene.PointLight | Glodon.CIMCube.Scene.SpotLight | Glodon.CIMCube.Scene.DirectionalLight 点光源
Returns:
Type
void

setImagerLayerColorToAlphaThreshold(layer, alphaThreshold)

影像图层开启透明效果与地球表面透明
Parameters:
Name Type Default Description
layer ImageryLayer 影像图层
alphaThreshold Number 0.15 透明阈值，默认0.15

unsetImagerLayerColorToAlphaThreshold(layer)

取消影像图层开启透明效果与地球表面透明
Parameters:
Name Type Description
layer ImageryLayer 影像图层

updateShadowMap()

强制刷新阴影

windowCoordinatesToCartesian(cartesian2)

屏幕坐标转地表笛卡尔坐标
Parameters:
Name Type Description
cartesian2 Cesium.Cartesian2 屏幕坐标
Returns:
地表笛卡尔坐标
Type
Cesium.Cartesian3

windowCoordinatesToCartographic(cartesian2)

屏幕坐标转地理坐标
Parameters:
Name Type Description
cartesian2 Cesium.Cartesian2 屏幕坐标
Returns:
地理坐标
Type
Cesium.Cartographic