DTS二次开发文档

Class: Misc

Misc

Misc类，提供一些杂项功能
一般通过api.misc调用其方法

<protected> new Misc()

See:

Methods

addAnimatedImageButtons(data, fn)

添加动画按钮

Parameters:
Name Type Description
data object | array

数据结构，支持对象或数组，对于每一个对象支持以下属性：

  • id (number) 按钮的ID

  • x (number) 图片按钮的位置:x坐标

  • y (number) 图片按钮的位置:y坐标

  • width (number) 图片按钮的宽度，单位像素

  • height (number) 图片按钮的高度，单位像素

  • imageSequecePath (string) 序列贴图的路径，资源引入说明

  • imageSequeceLength (string) 序列贴图的图片数量，也就是帧数

  • loop (boolean) 是否循环播放序列贴图

  • interactable (boolean) 是否可以用鼠标点击操作
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

addImageButtons(data, fn)

添加图片按钮

Parameters:
Name Type Description
data object | array

数据结构，支持对象或数组，对于每一个对象支持以下属性：

  • id (string) 按钮的ID

  • x (number) Button的屏幕坐标X

  • y (number) Button的屏幕坐标Y

  • width (number) Button的宽度

  • height (number) Button的高度

  • normalImage (string) Button正常显示的图片

  • hoverImage (string) 鼠标移上去后显示的图片

  • tooltip (string) Button的文字提示
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

callBPFunction(data, fn)

调用整个渲染场景内指定的蓝图函数 注意：调用前请先确认被调用的蓝图函数已存在，并和设计蓝图函数的开发人员沟通确认相关参数取值后再调用

Parameters:
Name Type Description
data object

支持以下属性：

  • actorTag (string) 发布蓝图函数时在模型包含的Actor上添加的tag，调用前需和设计蓝图函数的开发人员确认

  • objectName (string) 模型包含的Actor对象的ID，可以根据__g.tileLayer.getObjectIDs(tileLayerIds)方法获取

  • functionName (string) 待调用的蓝图函数名称，调用前需和设计蓝图函数的开发人员确认此函数已存在

  • paramType (BPFuncParamType) 传入单个参数，待传入参数类型 参考BPFuncParamType，如果需传递对象类型参数可以把Json对象定义为StringArray类型，在蓝图函数内部自己实现反序列化解析。

  • paramValue (any) 传入单个参数，根据参数类型设置对应参数值

  • parameters (array) 传入多个参数，数组类型，注意：传入多参数的顺序与类型务必与蓝图函数的参数顺序及其参数类型一致以保证执行结果符合预期。多个参数结构示例：[{"paramType":BPFuncParamType.String,"paramValue":"示例值"},{"paramType":BPFuncParamType.Bool,"paramValue":false},{"paramType":BPFuncParamType.Float,"paramValue":100.8}]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

deleteImageButtons(ids, fn)

删除动画按钮

Parameters:
Name Type Description
ids array

按钮的ID或数组（可以一次删除一个或者多个）
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

download(url, serverSavePath, fileName, fn)

下载文件到Cloud服务器的指定磁盘路径

Parameters:
Name Type Description
url string

下载文件的url地址
serverSavePath string

下载文件存储在Cloud服务器的磁盘路径
fileName string

下载文件名称
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

enterMultiViewportMode(viewportMode, lineColor, lineSize, fn)

进入多视口模式
视口布局类型

Parameters:
Name Type Description
viewportMode number

视口布局类型，取值范围：[1~7]，参考上图从上到下从左到右计数，即录制导览动画时的视口布局
lineColor Color

可选参数，激活后视口边框线的颜色，默认值：#DEA309，支持四种格式，取值示例
lineSize number

可选参数，激活后视口边框线的宽度，单位：像素，默认值：2px
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

enterReportMode(fn)

进入汇报演示模式

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

exitMultiViewportMode(fn)

退出多视口模式

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

exitReportMode(fn)

退出汇报演示模式

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

getActiveViewport(fn)

查询当前激活的视口信息

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

getBPFunction(assetPath, fn)

根据模型Actor路径或者对象id查询模型包含的蓝图函数信息，支持查询单个模型和多个模型包含的蓝图函数信息

如何获取assetPath参数见如下动图：

Parameters:
Name Type Description
assetPath string | array

模型Actor的路径或路径数组，可以从资源库的模型列表复制获取
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
返回结果示例：

[{
            "idOrPath":	"/JC_CustomAssets/EffectLibrary/Exhibition/3DUI/3D_UI_C_3",
            "objectType":	"Actor",
            "params":	[{
                    "functionName":	"特效",
                    "functionParams":	[{
                            "name":	"点特效样式",
                            "type":	16,
                            "defaultValue":	""
                        }, {
                            "name":	"线特效样式",
                            "type":	16,
                            "defaultValue":	""
                        }]
                }, {
                    "functionName":	"图标",
                    "functionParams":	[{
                            "name":	"图标样式",
                            "type":	16,
                            "defaultValue":	""
                        }, {
                            "name":	"图标背景",
                            "type":	16,
                            "defaultValue":	""
                        }]
                }, {
                    "functionName":	"动画",
                    "functionParams":	[{
                            "name":	"启用动画",
                            "type":	0,
                            "defaultValue":	0
                        }, {
                            "name":	"反向动画",
                            "type":	0,
                            "defaultValue":	0
                        }]
                }, {
                    "functionName":	"文字",
                    "functionParams":	[{
                            "name":	"文字内容",
                            "type":	5,
                            "defaultValue":	""
                        }, {
                            "name":	"文字大小",
                            "type":	2,
                            "defaultValue":	0
                        }, {
                            "name":	"背景颜色",
                            "type":	6,
                            "defaultValue":	[1.000000, 1.000000, 1.000000, 1.000000]
                        }, {
                            "name":	"背景倒角",
                            "type":	3,
                            "defaultValue":	0.000000
                        }]
                }]
        }]

getConvexPolygon(pointArray, fn)

从一组离散点中获取凸多边形的顶点索引

Parameters:
Name Type Description
pointArray boolean

离散点坐标数组，数组元素格式：[X,Y] 注意：没有高度Z
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

getMaterial(materialPath, fn)

根据材质路径查询材质包含的图片纹理和材质参数信息，同时支持查询单个材质和多个材质包含的信息

如何获取materialPath参数见如下动图：

Parameters:
Name Type Description
materialPath string | array

单个材质路径或路径数组，可以从资源库的材质列表复制获取
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
返回结果示例：

[{
            "idOrPath":	"/JC_CustomAssets/MaterialLibrary/Exhibition/地面_自然/地面_自然_1",
            "objectType":	"Material",
            "params":	[{
                    "name":	"颜色",
                    "type":	6,
                    "defaultValue":	[1.000000, 1.000000, 1.000000, 1.000000]
                }, {
                    "name":	"脏迹颜色",
                    "type":	6,
                    "defaultValue":	[0.400000, 0.400000, 0.400000, 1.000000]
                }, {
                    "name":	"亮度",
                    "type":	3,
                    "defaultValue":	1.300000
                }, {
                    "name":	"金属度",
                    "type":	3,
                    "defaultValue":	0.000000
                }, {
                    "name":	"法线强度",
                    "type":	3,
                    "defaultValue":	1.000000
                }, {
                    "name":	"粗糙度",
                    "type":	3,
                    "defaultValue":	1.616593
                }]
        }]

hideAllFoliages(fn)

隐藏Explorer里创建的植物

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

isApiVersionMatched()

判断JS-API的版本和云渲染服务器的接口版本是否一致

Returns:

如果一致返回true，否则返回false

playMovie(url, loop, fn)

全屏播放影片（播放过程中会暂停三维渲染以提高性能）

Parameters:
Name Type Description
url string

影片文件路径，支持本地绝对路径和流媒体网络路径，注意：不支持工程本地的相对路径
loop boolean

是否循环播放（from V2021.03.09）
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

playVideo(id, x, y, width, height, url, fn)

播放视频（显示播放窗口）

Parameters:
Name Type Description
id string

字符串类型的ID
x number

视频窗口的位置X
y number

视频窗口的位置Y
width number

视频窗口的宽度
height number

视频窗口的高度
url string

视频文件路径，支持本地绝对路径和流媒体网络路径，注意：不支持工程本地的相对路径
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

playVideoAlone(url, options, fn)

在独立的进程播放视频，注意：此接口仅在基于Explorer进行二次开发时生效

Parameters:
Name Type Description
url string

视频地址，支持网络地址或者本地文件。
options object

视频播放窗口配置参数，支持以下参数：

  • mute (boolean) 是否静音。
  • x (number) 视频播放窗口左上角距离显示器屏幕左侧的坐标
  • y (number) 视频播放窗口左上角距离显示器屏幕顶部的坐标
  • cx (number) 视频播放窗口宽度，默认值400
  • cy (number) 视频播放窗口高度，默认值300
  • title (string) 视频播放窗口标题栏文本，如果不设置，标题栏默认显示视频地址
  • opacity (number) 视频播放窗口的透明度，取值范围：(0, 1]
  • style (enum) 视频播放窗口样式。 取值0：无标题栏，1：有标题栏，2：有标题栏，可拖动边框改变大小。 默认值为2。
  • hideBuffering (boolean) 是否隐藏标题栏显示的视频流缓冲进度，默认不隐藏
  • maximizeBox (boolean) 是否在标题栏显示最大化按钮，默认不显示
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

projectAssetCount(type, fn)

统计ACP工程包含各类资产信息

Parameters:
Name Type Description
type number

ACP工程包含的资产类型，枚举类型详情请参考 AssetType
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

projectAssetCountAll(fn)

统计ACP工程包含的全部资产信息

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

reloadPak(fn)

从Cloud的文件资源配置中重新挂载新添加的pak文件，避免重启服务引起的实例关闭

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setActiveViewport(index, fn)

激活一个或多个视口，注意：仅在多视口模式下生效

Parameters:
Name Type Description
index number | array

被激活视口的索引或索引数组（同时激活多个视口），索引取值范围：[0~3]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setApiVersionReceived(fnCallback)

设置服务器返回版本号的回调函数

Parameters:
Name Type Description
fnCallback function

回调函数，当收到服务器返回的版本信息后调用

setMultiviewportInteractSync(isSync, fn)

多视口模式下设置相机是否同步

Parameters:
Name Type Description
isSync boolean

相机是否同步，默认不联动：false
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

showAllFoliages(fn)

显示Explorer里创建的植物

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

startProcess(appName, commandLine, visible, fn)

启动系统进程

Parameters:
Name Type Description
appName string

应用程序路径
commandLine string

命令行参数
visible boolean

可选参数，用于设置进程窗口是否可见。 默认值为true
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
接口返回进程相关信息
{
            "processId":	1600, //进程id
            "errorCode":	0 // 错误码
        }

stopMovie(fn)

停止全屏播放影片

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

stopPlayVideo(id, fn)

停止播放视频（播放窗口会消失）

Parameters:
Name Type Description
id string

字符串类型的ID
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

stopPlayVideoAlone(id, fn)

停止在独立的进程播放视频，注意：此接口仅在基于Explorer进行二次开发时生效

Parameters:
Name Type Description
id number

成功调用playVideoAlone后返回的processId
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

switchShortcutKey(onOff, fn)

控制Explorer快捷键的开关，注意：仅针对explorer下webui开发方式生效

Parameters:
Name Type Description
onOff boolean

打开关闭快捷键：true打开，false关闭
fn function

可选的回调函数，请参考二次开发：异步接口调用方式