zh/sdk4.0
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

添加参数注释

Browse Source
This commit is contained in:
takeshita
2025-08-31 16:35:35 +08:00
parent 7ba25619b7
commit 3ae330df3b
4 changed files with 47 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/Obj/Base/ParticleEffects/Flame/index.js
View File

@ -18,9 +18,10 @@ class Flame extends Base {
* @description 火焰特效
* @param sdk
* @param options {object} 粒子属性
* @param options.id {string} 标注id
* @param options.show=true {boolean} 显示/隐藏
* @param options.name {string} 名称
* @param options.url {string | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement} 指定 Image、URL或Canvas 的属性
* @param options.url {string} 贴图地址
* @param options.startColor="#ff0000" {string} 起始颜色
* @param options.endColor="#fff000" {string} 结束颜色
* @param options.startScale=0.5 {number} 初始比例
@ -34,8 +35,15 @@ class Flame extends Base {
* @param options.lng 经度
* @param options.lat 纬度
* @param options.alt 高度
* @param _Dialog {object} 弹框事件
* @param _Dialog.confirmCallBack {function} 弹框确认时的回调
* @param options.customView {object} 默认视角
* @param options.customView.orientation {object} 默认视角方位
* @param options.customView.orientation.heading {number} 航向角
* @param options.customView.orientation.pitch {number} 俯仰角
* @param options.customView.orientation.roll {number} 翻滚角
* @param options.customView.relativePosition {object} 视角相对位置
* @param options.customView.relativePosition.lng {number} 经度
* @param options.customView.relativePosition.lat {number} 纬度
* @param options.customView.relativePosition.alt {number} 高度
* */
constructor(sdk, options, _Dialog = {}) {
super(sdk, options);

17
src/Obj/Base/ParticleEffects/Fountain/index.js
View File

@ -17,9 +17,10 @@ class Fountain extends Base {
* @description 喷泉特效
* @param sdk
* @param options {object} 粒子属性
* @param options.id {string} 标注id
* @param options.show=true {boolean} 显示/隐藏
* @param options.name {string} 名称
* @param options.url {string | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement} 指定 Image、URL或Canvas 的属性
* @param options.url {string} 贴图地址
* @param options.startColor="#c1f7f24d" {string} 起始颜色
* @param options.endColor="#ffffff00" {string} 结束颜色
* @param options.startScale=1 {number} 初始比例
@ -30,12 +31,18 @@ class Fountain extends Base {
* @param options.maximumParticleLife=7 {number} 最大存在时间(秒)
* @param options.emissionRate=20 {number} 发射速率(个/每秒)
* @param options.particleSize=0.5{number} 粒子尺大小
* @param options.gravity=-3.5{number} 重力值
* @param options.lng 经度
* @param options.lat 纬度
* @param options.alt 高度
* @param _Dialog {object} 弹框事件
* @param _Dialog.confirmCallBack {function} 弹框确认时的回调
* @param options.customView {object} 默认视角
* @param options.customView.orientation {object} 默认视角方位
* @param options.customView.orientation.heading {number} 航向角
* @param options.customView.orientation.pitch {number} 俯仰角
* @param options.customView.orientation.roll {number} 翻滚角
* @param options.customView.relativePosition {object} 视角相对位置
* @param options.customView.relativePosition.lng {number} 经度
* @param options.customView.relativePosition.lat {number} 纬度
* @param options.customView.relativePosition.alt {number} 高度
* */
constructor(sdk, options, _Dialog = {}) {
super(sdk, options);
@ -50,7 +57,7 @@ class Fountain extends Base {
this.options.maximumSpeed = options.maximumSpeed || 9.5
this.options.emissionRate = options.emissionRate || 20
this.options.particleSize = options.particleSize || 0.5
this.options.gravity = (options.gravity || options.gravity === 0) ? options.gravity : -3.5
// this.options.gravity = (options.gravity || options.gravity === 0) ? options.gravity : -3.5
this.options.show = options.show === false ? false : true
this._elms = {};
this.positionCallBack = null

14
src/Obj/Base/ParticleEffects/Smoke/index.js
View File

@ -17,9 +17,10 @@ class Smoke extends Base {
* @description 烟雾特效
* @param sdk
* @param options {object} 粒子属性
* @param options.id {string} 标注id
* @param options.show=true {boolean} 显示/隐藏
* @param options.name {string} 名称
* @param options.url {string | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement} 指定 Image、URL或Canvas 的属性
* @param options.url {string} 贴图地址
* @param options.startColor="#00000000" {string} 起始颜色
* @param options.endColor="#0000001a" {string} 结束颜色
* @param options.startScale=0.1 {number} 初始比例
@ -33,8 +34,15 @@ class Smoke extends Base {
* @param options.lng 经度
* @param options.lat 纬度
* @param options.alt 高度
* @param _Dialog {object} 弹框事件
* @param _Dialog.confirmCallBack {function} 弹框确认时的回调
* @param options.customView {object} 默认视角
* @param options.customView.orientation {object} 默认视角方位
* @param options.customView.orientation.heading {number} 航向角
* @param options.customView.orientation.pitch {number} 俯仰角
* @param options.customView.orientation.roll {number} 翻滚角
* @param options.customView.relativePosition {object} 视角相对位置
* @param options.customView.relativePosition.lng {number} 经度
* @param options.customView.relativePosition.lat {number} 纬度
* @param options.customView.relativePosition.alt {number} 高度
* */
constructor(sdk, options, _Dialog = {}) {
super(sdk, options);

18
src/Obj/Base/ParticleEffects/Spout/index.js
View File

@ -16,9 +16,10 @@ class Spout extends Base {
* @description 水柱
* @param sdk
* @param options {object} 粒子属性
* @param options.id {string} 标注id
* @param options.show=true {boolean} 显示/隐藏
* @param options.name {string} 名称
* @param options.url {string | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement} 指定 Image、URL或Canvas 的属性
* @param options.url {string} 贴图地址
* @param options.startColor="#c1f7f2" {string} 起始颜色
* @param options.endColor="#ffffff00" {string} 结束颜色
* @param options.startScale=0.2 {number} 初始比例
@ -28,8 +29,8 @@ class Spout extends Base {
* @param options.maximumParticleLife=12 {number} 最大存在时间(秒)
* @param options.emissionRate=100 {number} 发射速率(个/每秒)
* @param options.particleSize=1 {number} 粒子尺大小
* @param options.heading 朝向
* @param options.pitch 俯仰角度
* @param options.heading 航向角
* @param options.pitch 俯仰角
* @param options.start {object} 开始位置
* @param options.start.lng 经度
* @param options.start.lat 纬度
@ -38,8 +39,15 @@ class Spout extends Base {
* @param options.end.lng 经度
* @param options.end.lat 纬度
* @param options.end.alt 高度
* @param _Dialog {object} 弹框事件
* @param _Dialog.confirmCallBack {function} 弹框确认时的回调
* @param options.customView {object} 默认视角
* @param options.customView.orientation {object} 默认视角方位
* @param options.customView.orientation.heading {number} 航向角
* @param options.customView.orientation.pitch {number} 俯仰角
* @param options.customView.orientation.roll {number} 翻滚角
* @param options.customView.relativePosition {object} 视角相对位置
* @param options.customView.relativePosition.lng {number} 经度
* @param options.customView.relativePosition.lat {number} 纬度
* @param options.customView.relativePosition.alt {number} 高度
* */
constructor(sdk, options, _Dialog = {}) {
super(sdk, options);