Api

Members

Animation :Animation

Description:

• 动画实例对象

Type:

• Animation

Effect :Effect

Description:

• 特效实例对象

Type:

• Effect

Methods

(async) add3DTiles(options)

Description:

• 添加新的Cesium 3DTiles模型到场景中

Parameters:

addAmbientLight(options) → {string}

Description:

• 向场景中添加一个环境光

Parameters:

Returns:

string -

返回所添加的环境光实例对象的ID

addDirectionalLight(options) → {string}

Description:

• 向场景中添加一个平行光

Parameters:

Returns:

string -

返回所添加的平行光实例对象的ID

addEventListener(e, callback)

Description:

• 事件监听接口

Parameters:

addFeatureCollection(options)

Description:

• 添加新的矢量数据到场景中（目前仅支持GeoJSON和TopoJSON两种格式）

Parameters:

addGeoJson(url, strokeColor, fillColor, callback) → {string}

Description:

• 添加新的geojson数据到场景中

Parameters:

Returns:

string -

返回数据的ID

(async) addGltf(options) → {string}

Description:

• 添加新的glTF、glb模型到场景中

Parameters:

Returns:

string -

glTF模型添加成功后，返回改模型的ID

addGridLineHelper()

Description:

• 添加一个XZ平面的辅助格网线

addGroup(models) → {Group}

Description:

• 向当前活动的场景中，添加一模型组对象实例

Parameters:

Returns:

Group -

模型组添加成功后，返回该模型组的ID；添加失败时，返回空字符串

addHemisphereLight(options) → {string}

Description:

• 向场景中添加一个半球光源

Parameters:

Returns:

string -

返回所添加的半球光实例对象的ID

addImageCollection(options)

Description:

• 添加新的影像瓦片数据到场景中

Parameters:

addOrthographicCamera(options) → {string}

Description:

• 向场景中添加一个正交投影相机

Parameters:

Returns:

string -

返回所添加的透视投影相机的ID

addPerspectiveCamera(options) → {string}

Description:

• 向场景中添加一个透视投影相机

Parameters:

Returns:

string -

返回所添加的透视投影相机的ID

addShadowPlane(options) → {string}

Description:

• 添加一个平面，用于辅助获取模型阴影

Parameters:

Returns:

string -

返回阴影平面的ID

addSource(options)

Description:

• 添加新的数据、模型到场景中(目前暂不支持地形数据的添加)

Parameters:

addTween()

Description:

• 向场景中添加补间动画

appendChild(options)

Description:

• 将一个模型、数据添作为子模型或数据，追加到一个已存在的群组对象上。 如果不是添加目标不是一个有效的群组组，则会尝试升级为组对象 (当前版本暂不支持)。

Parameters:

configureScene(options)

Description:

• 设置场景的属性

Parameters:

createScene(options) → {string}

Description:

• 创建一个场景实例对象

Parameters:

Returns:

string -

场景创建成功后，返回所创建场景的ID

destroyTween()

Description:

• 销毁场景中的补间动画

flyTo(options)

Description:

• 以动画的方式，将相机飞行至特定的位置

Parameters:

flyToAnimation(options)

Description:

• 相机飞入动画

Parameters:

getCameraParams() → {Object}

Description:

• 获取相机参数

Returns:

Object -

相机参数

getChildFromGroup(options) → {Object3D}

Description:

• 从指定的群组中获取所有的子模型，或者指定ID的模型

Parameters:

Returns:

Object3D -

返回一个或多个模型对象实例

getGroupChildren(groupId) → {Object3D}

Description:

• 从群组中获取指定ID的子模型

Parameters:

Returns:

Object3D -

返回获取到的子模型

getPosition(要设置的模型的位置，一个) → {Array.<number>}

Description:

• 获取模型的位置

Parameters:

Returns:

Array.<number> -

要设置的模型的位置，一个 (lng, lat, height) 格式的数组

getScene(sceneId) → {Scene}

Description:

• 获取当前活动的，即持有焦点（focus on），或者指定ID的场景实例对象

Parameters:

Returns:

Scene -

返回匹配的场景实例

getSource(options) → {Object3D}

Description:

• 从场景中获取模型、数据、文字、标签等数据源

Parameters:

Returns:

Object3D -

返回一个数据源对象

hideGlobe()

Description:

• 隐藏地球

hideScene(sceneIdopt)

Description:

• 隐藏引擎中的当前活动场景

Parameters:

hideSource(id)

Description:

• 隐藏活动场景中的数据、模型

Parameters:

hideSurroundings()

Description:

• 关闭周围所有环境（隐藏倾斜摄影、隐藏特效、隐藏流光）

highlight(options)

Description:

• 高亮指定ID的模型或指定ID的模型构件

Parameters:

openSurroundings()

Description:

• 打开周围所有环境（显示倾斜摄影、显示特效、显示流光）

playAllAnimations(options)

Description:

• 以指定的循环渲染模式，播放场景中的动画。须注意的是， 该API会改变场景实例的渲染模式。场景实例的渲染模式， 通常在创建场景实例对象时，通过“LoopMode”参数指定

Parameters:

removeAllSources(optionsopt)

Description:

• 从活动的场景中，移除所有的数据、模型

Parameters:

removeGeoJson(content)

Description:

• 移除场景中的geojson数据

Parameters:

removeScene(sceneId)

Description:

• 移除并销毁指定ID的场景

Parameters:

removeSource(id)

Description:

• 从活动的场景中，移除指定ID的数据、模型

Parameters:

removeTranslationController()

Description:

• 移除平移模型的操作句柄，即退出平移操作状态，并释放相应的资源

resizeScene(width, height)

Description:

• 重新调整场景的大小

Parameters:

setBackground(options)

Description:

• 设置场景的背景色或图片，其中背景色，目前只能设置垂直渐变色

Parameters:

setCameraController(options)

Description:

• 设置相机的控制（或者说是交互）方式。值得注意的是，Controllers是一个数组，这意味着，同一个交互方式， 可以绑定多个输入事件（包括鼠标、键盘、触屏操作）

Example

// 设置相机交互控制：左键平移、右键旋转，滚轮缩放
api.setCameraController({
    // 旋转控制（对于地表物体来说，就是倾斜相机的角度）
    tilt: {
        // disabled: false,       // 禁止旋转地表模型（为True时，下面的“controllers”参数设置无效）
        controllers: [
            Qk3d.CameraEventType.RIGHT_DRAG,
        ]
    },

    // 平移控制(并不是直接旋转地表的模型，而是通过旋转地球，以达到平移地表模型的效果。)
    rotate: {
        // disabled: false,       // 禁止旋平移表模型（为True时，下面的“controllers”参数设置无效）
        controllers: [
            Qk3d.CameraEventType.LEFT_DRAG
        ]
    },

    // 缩放控制
    zoom: {
        // disabled: false,      // 禁止缩放地表模型（为True时，下面的“controllers”参数设置无效）
        controllers: [
            Qk3d.CameraEventType.WHEEL,   // 鼠标中键滚轮
            Qk3d.CameraEventType.PINCH,   // 双指触控屏幕
        ]
    }
});

Parameters:

setCameraDistance(options)

Description:

• 设置相机距离观测模板的距离

Parameters:

setColor(options)

Description:

• 设置模型的颜色

Parameters:

setMaterial(options)

Description:

• 设置指定模型的材质

Parameters:

setPosition(position)

Description:

• 设置模型的位置

Parameters:

setScene(sceneId)

Description:

• 场景切换，即设置当前活动的场景为指定ID的场景 这将使得将指定ID的场景获取焦点

Parameters:

setTerrain(options)

Description:

• 设置地形数据

Parameters:

showGlobe()

Description:

• 显示地球

showMonomerBuilding(options)

Description:

• 显示需要展示的单体化建筑

Parameters:

showScene(sceneId)

Description:

• 显示引擎中的当前活动场景

Parameters:

showSource(id)

Description:

• 显示活动场景中的数据、模型

Parameters:

stopAllAnimations()

Description:

• 停止场景中所有的动画播放

syncViews(sceneId1, sceneId2)

Description:

• 同步两个场景的视图，即视角同步

Parameters:

translate(options, callback)

Description:

• 平移模型

Parameters:

translateMulti(options, callback)

Description:

• 批量平移模型，可以一次性进行多个模型的平移操作

Parameters:

unhighlight(options)

Description:

• 取消高亮指定ID的模型或指定ID的模型构件

Parameters:

unsyncViews(sceneId1, sceneId2)

Description:

• 取消两个场景的视图同步操作

Parameters:

zoomTo(options)

Description:

• 将当前场景的视角，缩放至指定模型的视野范围

Parameters: