KAPI

界面

本页目录

全局：常量 ​

对于常用的全局变量，在引入组件后就会获得KAPI_CONST全局变量。

EVENT ​

事件监听类型如下表

变量使用说明
FPSKAPI_CONST.FPS帧率
DRAW.CREATE_POINTKAPI_CONST.EVENT.DRAW.CREATE_POINT绘制点
DRAW.DESTROY_POINTKAPI_CONST.EVENT.DRAW.DESTROY_POINT销毁点
DRAW.LIGHT_FLOWKAPI_CONST.EVENT.DRAW.LIGHT_FLOW绘制光流线
DRAW.GET_POINTKAPI_CONST.EVENT.DRAW.GET_POINT获取点
MARKER.CLICKKAPI_CONST.EVENT.MARKER.CLICK标注点的点击
ROUTE.STARTKAPI_CONST.EVENT.ROUTE.START开始漫游
ROUTE.MOVINGKAPI_CONST.EVENT.ROUTE.MOVING漫游中
ROUTE.ENDKAPI_CONST.EVENT.ROUTE.END结束漫游

FPS ​

FPS 是用来设置帧数监听时的全局常量，可以通过 KAPI_CONST.EVENT.FPS 获取。

  • 类型: [eventName: string]: any

  • 详情:

    在遇到系统卡顿，需要调试系统的时候，可以查看服务的帧数，在自定义监听里面使用该参数可以获取场景的帧数。

  • 示例:

js
import KAPI from '@ibrucekong/kapi'
// 查看当前的常量值
console.log(KAPI_CONST.EVENT.FPS)

// 设置事件监听
const event = await kapi.Event()
event.addEventListener(KAPI_CONST.EVENT.FPS, (fps) => {
  console.log('当前的帧数：', fps)
})

确保在场景已经正常加载再使用FPS监听，其他监听方法也是如此。

DRAW.CREATE_POINT ​

DRAW.CREATE_POINT 是创建点时的全局常量，可以通过 KAPI_CONST.EVENT.DRAW.CREATE_POINT 获取。

js
const event = new kapi.Event()

event.addEventListener(KAPI_CONST.EVENT.DRAW.CREATE_POINT, response => {
  console.log(response)
})

DRAW.DESTROY_POINT ​

DRAW.DESTROY_POINT 是销毁点时的全局常量，可以通过 KAPI_CONST.EVENT.DRAW.DESTROY_POINT 获取。

js
const event = new kapi.Event()

event.addEventListener(KAPI_CONST.EVENT.DRAW.DESTROY_POINT, response => {
  console.log(response)
})

DRAW.LIGHT_FLOW ​

DRAW.LIGHT_FLOW 是设置光流的生成监听的常量，可以通过 KAPI_CONST.EVENT.DRAW.LIGHT_FLOW 获取。

  • 类型: [eventName: string]: any

  • 详情:

    设置光流的生成监听。

  • 示例:

js
import KAPI from '@ibrucekong/kapi'
// 查看当前的常量值
console.log(KAPI_CONST.EVENT.DRAW.LIGHT_FLOW)

// 设置事件监听
const event = await kapi.Event()
event.addEventListener(KAPI_CONST.EVENT.DRAW.LIGHT_FLOW, (response) => {
  console.log('当前的结果：', response)
})

DRAW.GET_POINT ​

DRAW.GET_POINT 是获取点的常量，可以通过 KAPI_CONST.EVENT.DRAW.GET_POINT 获取。

  • 类型: [eventName: string]: any

  • 详情:

    获取点的监听。

  • 示例:

js
import KAPI from '@ibrucekong/kapi'
// 查看当前的常量值
console.log(KAPI_CONST.EVENT.DRAW.GET_POINT)

// 设置事件监听
const event = await kapi.Event()
event.addEventListener(KAPI_CONST.EVENT.DRAW.GET_POINT, (response) => {
  console.log('当前的结果：', response)
})

MARKER.CLICK ​

MARKER.CLICK 是marker点击事件监听的常量，可以通过 KAPI_CONST.EVENT.MARKER.CLICK 获取。

  • 类型: [eventName: string]: any

  • 详情:

    marker点击事件监听的监听。

  • 示例:

js
import KAPI from '@ibrucekong/kapi'
// 查看当前的常量值
console.log(KAPI_CONST.EVENT.MARKER.CLICK)

// 设置事件监听
const event = await kapi.Event()
event.addEventListener(KAPI_CONST.EVENT.MARKER.CLICK, (response) => {
  console.log('当前的结果：', response)
})

ROUTE.START ​

ROUTE.START 是开始漫游的常量，可以通过 KAPI_CONST.EVENT.ROUTE.START 获取。

  • 类型: [eventName: string]: any

  • 详情:

    开始漫游的监听。

  • 示例:

js
import KAPI from '@ibrucekong/kapi'
// 查看当前的常量值
console.log(KAPI_CONST.EVENT.ROUTE.START)

// 设置事件监听
const event = await kapi.Event()
event.addEventListener(KAPI_CONST.EVENT.ROUTE.START, (response) => {
  console.log('当前的结果：', response)
})

ROUTE.MOVING ​

ROUTE.MOVING 是漫游中的常量，可以通过 KAPI_CONST.EVENT.ROUTE.MOVING 获取。

  • 类型: [eventName: string]: any

  • 详情:

    漫游中的监听。

  • 示例:

js
import KAPI from '@ibrucekong/kapi'
// 查看当前的常量值
console.log(KAPI_CONST.EVENT.ROUTE.MOVING)

// 设置事件监听
const event = await kapi.Event()
event.addEventListener(KAPI_CONST.EVENT.ROUTE.MOVING, (response) => {
  console.log('当前的结果：', response)
})

ROUTE.END ​

ROUTE.END 是结束漫游的常量，可以通过 KAPI_CONST.EVENT.ROUTE.END 获取。

  • 类型: [eventName: string]: any

  • 详情:

    结束漫游的监听。

  • 示例:

js
import KAPI from '@ibrucekong/kapi'
// 查看当前的常量值
console.log(KAPI_CONST.EVENT.ROUTE.END)

// 设置事件监听
const event = await kapi.Event()
event.addEventListener(KAPI_CONST.EVENT.ROUTE.END, (response) => {
  console.log('当前的结果：', response)
})

MEASURE ​

测量模块包括对二维面积、三维面积、二维长度、三维长度和高度的测量方法。

测量类型如下表

变量使用说明
AREA_2DKAPI_CONST.MEASURE.AREA_2D测量二维面积
AREA_3DKAPI_CONST.MEASURE.AREA_3D测量三维面积
LENGTH_2DKAPI_CONST.MEASURE.LENGTH_2D测量二维长度
LENGTH_3DKAPI_CONST.MEASURE.LENGTH_3D测量三维长度
HEIGHTKAPI_CONST.MEASURE.HEIGHT测量高度

MEASURE.AREA_2D ​

MEASURE.AREA_2D 是使用二维面积测量时的全局常量，可以通过 KAPI_CONST.MEASURE.AREA_2D 获取。

js
const event = new kapi.Event()

event.addEventListener(KAPI_CONST.MEASURE.AREA_2D, response => {
  console.log(response)
})

MEASURE.AREA_3D ​

MEASURE.AREA_3D 是使用三维面积测量时的全局常量，可以通过 KAPI_CONST.MEASURE.AREA_3D 获取。

js
const event = new kapi.Event()

event.addEventListener(KAPI_CONST.MEASURE.AREA_3D, response => {
  console.log(response)
})

MEASURE.LENGTH_2D ​

MEASURE.LENGTH_2D 是使用二维长度测量时的全局常量，可以通过 KAPI_CONST.MEASURE.LENGTH_2D 获取。

js
const event = new kapi.Event()

event.addEventListener(KAPI_CONST.MEASURE.LENGTH_2D, response => {
  console.log(response)
})

MEASURE.LENGTH_3D ​

MEASURE.LENGTH_3D 是使用三维长度测量时的全局常量，可以通过 KAPI_CONST.MEASURE.LENGTH_3D 获取。

js
const event = new kapi.Event()

event.addEventListener(KAPI_CONST.MEASURE.LENGTH_3D, response => {
  console.log(response)
})

MEASURE.HEIGHT ​

MEASURE.HEIGHT 是使用高度测量时的全局常量，可以通过 KAPI_CONST.MEASURE.HEIGHT 获取。

js
const event = new kapi.Event()

event.addEventListener(KAPI_CONST.MEASURE.HEIGHT, response => {
  console.log(response)
})

POINT_TYPE ​

点类型包括对三种火焰特效、三种树种、三种贴画以及自定义的FBX模型效果。

点类型如下表

变量使用说明
FIRE_01KAPI_CONST.POINT_TYPE.FIRE_01火焰1
FIRE_02KAPI_CONST.POINT_TYPE.FIRE_02火焰2
FIRE_03KAPI_CONST.POINT_TYPE.FIRE_03火焰3
TREE_01KAPI_CONST.POINT_TYPE.TREE_01树种1
TREE_02KAPI_CONST.POINT_TYPE.TREE_02树种2
TREE_03KAPI_CONST.POINT_TYPE.TREE_03树种3
DECAL_01KAPI_CONST.POINT_TYPE.DECAL_01贴花1
DECAL_02KAPI_CONST.POINT_TYPE.DECAL_02贴花2
DECAL_03KAPI_CONST.POINT_TYPE.DECAL_03贴花3
DECAL_03KAPI_CONST.POINT_TYPE.DECAL_03贴花3
FBXKAPI_CONST.POINT_TYPE.FBXFBX模型

POINT_TYPE.FIRE_01 ​

js
let pointInfo = await draw.drawPoint(KAPI_CONST.POINT_TYPE.FIRE_01)

要配合 draw.closeDrawPoint() 方法关闭绘制点功能。

POINT_TYPE.FIRE_02 ​

js
let pointInfo = await draw.drawPoint(KAPI_CONST.POINT_TYPE.FIRE_02)

要配合 draw.closeDrawPoint() 方法关闭绘制点功能。

POINT_TYPE.FIRE_03 ​

js
let pointInfo = await draw.drawPoint(KAPI_CONST.POINT_TYPE.FIRE_03)

要配合 draw.closeDrawPoint() 方法关闭绘制点功能。

POINT_TYPE.TREE_01 ​

js
let pointInfo = await draw.drawPoint(KAPI_CONST.POINT_TYPE.TREE_01)

要配合 draw.closeDrawPoint() 方法关闭绘制点功能。

POINT_TYPE.TREE_02 ​

js
let pointInfo = await draw.drawPoint(KAPI_CONST.POINT_TYPE.TREE_02)

要配合 draw.closeDrawPoint() 方法关闭绘制点功能。

POINT_TYPE.TREE_03 ​

js
let pointInfo = await draw.drawPoint(KAPI_CONST.POINT_TYPE.TREE_03)

要配合 draw.closeDrawPoint() 方法关闭绘制点功能。

POINT_TYPE.DECAL_01 ​

js
let pointInfo = await draw.drawPoint(KAPI_CONST.POINT_TYPE.DECAL_01)

要配合 draw.closeDrawPoint() 方法关闭绘制点功能。

POINT_TYPE.DECAL_02 ​

js
let pointInfo = await draw.drawPoint(KAPI_CONST.POINT_TYPE.DECAL_02)

要配合 draw.closeDrawPoint() 方法关闭绘制点功能。

POINT_TYPE.DECAL_03 ​

js
let pointInfo = await draw.drawPoint(KAPI_CONST.POINT_TYPE.DECAL_03)

要配合 draw.closeDrawPoint() 方法关闭绘制点功能。

POINT_TYPE.FBX ​

js
let pointInfo = await draw.drawPoint(KAPI_CONST.POINT_TYPE.FBX)

要配合 draw.closeDrawPoint() 方法关闭绘制点功能。

WEATHER ​

天气包括对晴天、少云、多云、阴天、雾天、小雨、大雨、暴风雨、浮尘、沙尘暴、小雪、大雪和暴风雪的天气特效。

天气类型如下表

变量使用说明
CLEAR_SKIESKAPI_CONST.WEATHER.CLEAR_SKIES晴天
PARTLY_CLOUDYKAPI_CONST.WEATHER.PARTLY_CLOUDY少云
CLOUDYKAPI_CONST.WEATHER.CLOUDY多云
OVERCASTKAPI_CONST.WEATHER.OVERCAST阴天
FOGGYKAPI_CONST.WEATHER.FOGGY雾天
LIGHT_RAINKAPI_CONST.WEATHER.LIGHT_RAIN小雨
RAINKAPI_CONST.WEATHER.RAIN大雨
THUNDERSTORMKAPI_CONST.WEATHER.THUNDERSTORM暴风雨
SAND_DUSTKAPI_CONST.WEATHER.SAND_DUST浮尘
SANDSTORMKAPI_CONST.WEATHER.SANDSTORM沙尘暴
LIGHT_SNOWKAPI_CONST.WEATHER.LIGHT_SNOW小雪
SNOWKAPI_CONST.WEATHER.SNOW大雪
BLIZZARDKAPI_CONST.WEATHER.BLIZZARD暴风雪

WEATHER.CLEAR_SKIES ​

js
let controllerInfo = await controller.setWeatherType(KAPI_CONST.WEATHER.CLEAR_SKIES)

WEATHER.PARTLY_CLOUDY ​

js
let controllerInfo = await controller.setWeatherType(KAPI_CONST.WEATHER.PARTLY_CLOUDY)

WEATHER.CLOUDY ​

js
let controllerInfo = await controller.setWeatherType(KAPI_CONST.WEATHER.CLOUDY)

WEATHER.OVERCAST ​

js
let controllerInfo = await controller.setWeatherType(KAPI_CONST.WEATHER.OVERCAST)

WEATHER.FOGGY ​

js
let controllerInfo = await controller.setWeatherType(KAPI_CONST.WEATHER.FOGGY)

WEATHER.LIGHT_RAIN ​

js
let controllerInfo = await controller.setWeatherType(KAPI_CONST.WEATHER.LIGHT_RAIN)

WEATHER.RAIN ​

js
let controllerInfo = await controller.setWeatherType(KAPI_CONST.WEATHER.RAIN)

WEATHER.THUNDERSTORM ​

js
let controllerInfo = await controller.setWeatherType(KAPI_CONST.WEATHER.THUNDERSTORM)

WEATHER.SAND_DUST ​

js
let controllerInfo = await controller.setWeatherType(KAPI_CONST.WEATHER.SAND_DUST)

WEATHER.SANDSTORM ​

js
let controllerInfo = await controller.setWeatherType(KAPI_CONST.WEATHER.SANDSTORM)

WEATHER.LIGHT_SNOW ​

js
let controllerInfo = await controller.setWeatherType(KAPI_CONST.WEATHER.LIGHT_SNOW)

WEATHER.SNOW ​

js
let controllerInfo = await controller.setWeatherType(KAPI_CONST.WEATHER.SNOW)

WEATHER.BLIZZARD ​

js
let controllerInfo = await controller.setWeatherType(KAPI_CONST.WEATHER.BLIZZARD)