# 更新特效

Dandelion.RtAPI("updateEffect", params, (res) => {
  console.log(res);
});

# 功能描述

更新特效

# 请求参数格式(除必填项,不设置的字段不填即可)

let params = {
  backToInitialView: false,
  bindID: "",
  dataDrivenOn: true,
  firstView: false,
  home: true,
  id: "",
  loopMove: true,
  moveAngle: {
    pitch: 0,
    roll: 0,
    yaw: 0,
  },
  moveDurations: 0,
  movePathId: "",
  movePoint: {
    height: 0,
    latitude: 0,
    longitude: 0,
  },
  moveSpeed: 0,
  moveState: 0,
  name: "",
  normalColor: "",
  position: {
    height: 0,
    latitude: 0,
    longitude: 0,
  },
  pulse: true,
  pulseColor: "",
  pulseTime: 0,
  rotation: {
    x: 10,
    y: 10,
    z: 10,
  },
  tags: [],
  text: "",
  textBoundBoxColor: "",
  textColor: "",
  textMargin: 0,
  textSize: 0,
  textVisible: true,
  thetherState: false,
  traceLineColor: "",
  traceLineVisible: true,
  traceLineWidth: 0,
  viewpointIndex: "",
  viewpointType: 0,
  visible: true,
};

# 请求参数

参数名称 参数说明 是否必须 数据类型
  backToInitialView 模型是否回到初始位置 false Boolean
  bindID 绑定的对象 id(如果对象已被绑定会被解绑) false String
  dataDrivenOn 数据驱动是否打开 当驱动时,必须打开 false Boolean
  firstView 是否第一视角观看 false Boolean
  home 是否设置为默认 false Boolean
  id 特效 id true String
  loopMove 是否循环移动 false Boolean
  moveAngle 数据驱动的角度值 false
    pitch 俯仰角 false Number
    roll 滚动角 false Number
    yaw 偏航角 false Number
  moveDurations 数据驱动点的时间间隔 false Number
  movePathId 沿着路径移动得路径 id false String
  movePoint 数据驱动的位置点 false
    height 高度 false Number
    latitude 纬度 false Number
    longitude 经度 false Number
  moveSpeed 移动速度 false Number
  moveState 移动状态(0 播放、1 暂停、2 停止) false Number
  name 名称 false String
  normalColor 正常颜色 false String
  position 位置坐标 false
    height 高度 false Number
    latitude 纬度 false Number
    longitude 经度 false Number
  pulse 是否闪烁 false Boolean
  pulseColor 闪烁颜色 false String
  pulseTime 闪烁时间(单位秒) false Number
  rotation 旋转角度 false XyzAo
    x x 坐标 true Number
    y y 坐标 true Number
    z z 坐标 true Number
  tags tag 列表 false Array
  text 文字内容 false String
  textBoundBoxColor 特效包围盒颜色 false String
  textColor 文字颜色 false String
  textMargin 文字边框间距 false Number
  textSize 文字大小 false Number
  textVisible 是否显示文字 false Boolean
  thetherState 视点是否跟随 false Boolean
  traceLineColor 轨迹颜色 false String
  traceLineVisible 数据驱动的轨迹线是否可见 false Boolean
  traceLineWidth 轨迹宽度 false
  viewpointIndex 自定义视角 guid false String
  viewpointType 0 观察视角 1 驾驶视角 2 自定义视角 false Number
  visible 显隐状态 false Boolean

# 响应参数格式

{
	"backToInitialView": false,
	"bindID": "",
	"bindType": "",
	"dataDrivenOn": true,
	"firstView": false,
	"floorIndex": 0,
	"foreignKey": [],
	"home": true,
	"id": "",
	"iveUrl": "",
	"loopMove": true,
	"moveAngle": {
		"pitch": 0,
		"roll": 0,
		"yaw": 0
	},
	"moveDurations": 0,
	"movePathId": "",
	"movePoint": {
		"height": 0,
		"latitude": 0,
		"longitude": 0
	},
	"moveSpeed": 0,
	"moveState": 0,
	"name": "",
	"normalColor": "",
	"parentBuildingID": "",
	"position": {
		"height": 0,
		"latitude": 0,
		"longitude": 0
	},
	"pulse": true,
	"pulseColor": "",
	"pulseTime": 0,
	"resourceId": "",
	"tags": [],
	"text": "",
	"textBoundBoxColor": "",
	"textColor": "",
	"textMargin": 0,
	"textSize": 0,
	"textVisible": true,
	"thetherState": false,
	"traceLineColor": "",
	"traceLineVisible": true,
	"traceLineWidth": 0,
	"viewPointList": [
		{
			"heading": 0,
			"height": 0,
			"home": true,
			"id": "",
			"latitude": 0,
			"longitude": 0,
			"loopMove": true,
			"movePathId": "",
			"moveSpeed": 0,
			"moveState": 0,
			"name": "",
			"pitch": 0,
			"range": 0,
			"throughtime": 0,
			"viewpointIndex": "",
			"viewpointType": 0
		}
	],
	"viewpointIndex": "",
	"viewpointType": 0,
	"visible": true
}

# 响应参数:

参数名称 参数说明 类型
backToInitialView 模型是否回到初始位置 Boolean
bindID 绑定的对象 id(如果对象已被绑定会被解绑) String
bindType 绑定的对象类型 String
dataDrivenOn 数据驱动是否打开 当驱动时,必须打开 Boolean
firstView 是否第一视角观看 Boolean
floorIndex 所在楼层 Number
foreignKey 外部 ID Array
home 是否设置为默认 Boolean
id 特效 id String
iveUrl ive 资源地址 String
loopMove 是否循环移动 Boolean
moveAngle 数据驱动的角度值
  pitch 俯仰角 Number
  roll 滚动角 Number
  yaw 偏航角 Number
moveDurations 数据驱动点的时间间隔 Number
movePathId 沿着路径移动得路径 id String
movePoint 数据驱动的位置点
  height 高度 Number
  latitude 纬度 Number
  longitude 经度 Number
moveSpeed 移动速度 Number
moveState 移动状态(0 播放、1 暂停、2 停止) Number
name 名称 String
normalColor 正常颜色 String
parentBuildingID 父建筑 id String
position 位置坐标
  height 高度 Number
  latitude 纬度 Number
  longitude 经度 Number
pulse 是否闪烁 Boolean
pulseColor 闪烁颜色 String
pulseTime 闪烁时间(单位秒) Number
resourceId 模板 id String
tags tag 列表 Array
text 文字内容 String
textBoundBoxColor 特效包围盒颜色 String
textColor 文字颜色 String
textMargin 文字边框间距 Number
textSize 文字大小 Number
textVisible 是否显示文字 Boolean
thetherState 视点是否跟随 Boolean
traceLineColor 轨迹颜色 String
traceLineVisible 数据驱动的轨迹线是否可见 Boolean
traceLineWidth 轨迹宽度 Number
viewPointList 视点列表 Array
  heading 偏航角 Number
  height 高度 Number
  home true 主视点、false 当前视点 Boolean
  id 视点 ID String
  latitude 纬度 Number
  longitude 经度 Number
  loopMove 是否循环移动 Boolean
  movePathId 沿着路径移动得路径 id String
  moveSpeed 移动速度 Number
  moveState 移动状态(0 播放、1 暂停、2 停止) Number
  name 视点名称 String
  pitch 俯仰角 Number
  range 视点距离 Number
  throughtime 飞跃时间 Number
  viewpointIndex 视角 guid String
  viewpointType 视角:0 观察视角、2 自定义视角 Number
viewpointIndex 自定义视角 guid String
viewpointType 0 观察视角 1 驾驶视角 2 自定义视角 Number
visible 显隐状态 Boolean