yoke-api v1.0.4

快速使用

使用方式一：NPM方式使用

下载

npm i yoke-api

引入

import Dimo from 'yoke-api'

使用方式二：压缩文件引入

获取压缩的SDK文件

引入

import Dimo from "./my-lib.mjs";

使用

使用

<iframe id="dimo" src="http://192.168.14.10/fengxianyiqi/render-engine/ue/inner"></iframe>
const Instance=new Dimo(DOMID,[autoSetRes],[checkMessage]） 

例子

const Instance=new Dimo('dimo'）

参数

监听UE返回的消息

Instance.onlisten(e=>{})

虚拟物体类名列表

虚拟物体相关的方法

以下不是必须的参数如果不写都会自动加上默认值

创建一个虚拟物体

Instance.Create(options,CallBack)

说明：options为配置项，具体见下表。

参数

删除一个虚拟物体

Instance.Destroy(id,CallBack)

参数

将虚拟物体附属到另一个虚拟物体下

说明：(附属关系下子节点会随父节点移动、显示、隐藏等)

Instance.AttachTo(parent,child,CallBack)

参数

移除物体之间的附属关系

Instance.DetachFrom(parent,child,CallBack)

参数

获取附属物体的 ID

Instance.GetAttachedObjectID(parent,CallBack)

参数

获取一个虚拟物体的所有信息

Instance.GetProp(id,CallBack)

参数

移动虚拟物体(位置、旋转、缩放)

Instance.SetTransform(options,CallBack)

说明：options为配置项，具体见下表。

参数

设置虚拟物体的显示

Instance.Show(id,CallBack)

参数

批量设置一类虚拟物体的显示

Instance.showOfClass(className，tags,CallBack)

参数

设置虚拟物体的隐藏

Instance.Hide(id,CallBack)

参数

批量设置一类虚拟物体的隐藏

Instance.hideOfClass(className，tags,CallBack)

参数

设置一个图层上所有虚拟物体的显示/隐藏

Instance.SetVisibilityOfLayer(status，layer,CallBack)

参数

设置一个虚拟物体的类属性

Instance.SetClassProp(id，params,CallBack)

参数

批量设置一类虚拟物体的类属性

Instance.SetClassPropOfClass(className，tags,class_prop,CallBack)

参数

设置虚拟物体开始从数据中台进行数据更新(例如：热力图、无人机轨迹)

Instance.StartAutoUpdate(id,CallBack)

参数

设置虚拟物体停止从数据中台进行数据更新(例如：热力图、无人机轨迹)

Instance.StopAutoUpdate(id,CallBack)

参数

视角聚焦到指定虚拟物体

Instance.FocusOn(options,CallBack)

说明：options为配置项，具体见下表。

参数

获取所有虚拟物体的 ID 列表

Instance.GetAllObjectID(CallBack)

参数

设置UE相关的方法

设置渲染端的分辨率

Instance.SetRes(options，CallBack)

说明：options为配置项，具体见下表。

参数

建筑相关的方法

把视角移动到建筑物

Instance.View(options，CallBack)

说明：options为配置项，具体见下表。

参数

建筑进入分层展开状态

Instance.Layering(id，CallBack)

参数

建筑某一楼层分层抽出

Instance.Pull(options，CallBack)

说明：options为配置项，具体见下表。

参数

建筑某一楼层分层推回初始状态

Instance.Push(options，CallBack)

说明：options为配置项，具体见下表。

参数

建筑楼层都推回初始状态

Instance.PushAll(id，CallBack)

参数

建筑物退出分层状态,回到常规状态

Instance.BackToNormal(id，CallBack)

参数

设置分层建筑物是否能被点击触发

Instance.SetEnableClick(status，CallBack)

参数

相机设置的相关方法

设置自动曝光

Instance.AutoExposure(status，CallBack)

参数

设置是否开启相机室内模型碰撞检测

Instance.AutoExposure(options，CallBack)

说明：options为配置项，具体见下表。

参数

获取边界参数

Instance.GetBoundary(CallBack)

参数

获取当前视角的参数

Instance.GetCamera(CallBack)

参数

获取鼠标所指向表面的坐标

Instance.GetLocation(CallBack)

参数

控制视角移动到某个位置

Instance.MovePawn(options，CallBack)

说明：options为配置项，具体见下表。

参数

设置是否启用电影相机模式

Instance.PhotoMode(status,CallBack)

参数

设置相机的光圈

Instance.SetAperture(value,CallBack)

参数

设置可移动的边界参数

Instance.SetBoundary(options,CallBack)

说明：options为配置项，具体见下表。

参数

设置曝光补偿值

Instance.SetExposureCompensation(value,CallBack)

参数

设置Pawn模型显示/隐藏

Instance.ShowPawn(status,CallBack)

参数

高亮物体相关的方法

改变高亮物体的颜色

Instance.Imperio(options,CallBack)

说明：options为配置项，具体见下表。

参数

获取所有可高亮物体的ID

Instance.Legilimens(CallBack)

参数

让指定物体高亮显示

Instance.Legilimens(id,CallBack)

参数

让所有物体高亮显示

Instance.LumosMaxima(CallBack)

参数

熄灭高亮物体

Instance.Nox(id,CallBack)

参数

投影点相关的方法

设置投影开关

Instance.Control(options,CallBack)

说明：options为配置项，具体见下表。

参数

开启投影视频

Instance.OpenVideos(options,CallBack)

说明：options为配置项，具体见下表。

参数

关闭投影视频

Instance.CloseVideos(uuids,CallBack)

参数

获取所有投影点的 ID 列表

Instance.GetAllProjectorID(CallBack)

参数

视角点相关的方法

创建一个新的视角点

Instance.CreateViewPonit(options,CallBack)

说明：options为配置项，具体见下表。

参数

销毁一个现有视角点

Instance.DestroyViewPoint(viewpointid，CallBack)

参数

飞行到视角点位置并打开对应的投影机

Instance.FlyTo(viewpointid，CallBack)

参数

将当前视口围绕Viewpoint中心进行旋转

Instance.Rotate(options，CallBack)

说明：options为配置项，具体见下表。

参数

将当前视口进行上下左右前后平移(相机坐标系）

Instance.Translate(options，CallBack)

说明：options为配置项，具体见下表。

参数

创建一个新的视角点序列（简略版）

Instance.CreateSequenceByViewPoint(options，CallBack)

说明：options为配置项，具体见下表。

参数

创建一个新的视角点序列（详细版）

Instance.CreateSequenceBykeyframes(options，CallBack)

说明：options为配置项，具体见下表。

参数

"keyframes": [
      {
        "viewpoint_id": "11111",   
        "fly_in_method": 1,        
        "fly_in_time": {
          "phase_1": 2,
          "phase_2": 2,
          "phase_3": 2
        },
        "wait_time": 6
      }
    ]

销毁一个现有视角点序列

Instance.DestroySequence(id，CallBack)

参数

根据预设好的视角点序列，依次切换视角

Instance.Sequence(options，CallBack)

说明：options为配置项，具体见下表。

参数

根据预设好的可编辑视角点序列，依次切换视角

说明：TravelerSequence 只能通过场景构建工具创建，无法通过接口创建。我们也建议您的视角点、巡航序列、虚拟物体等均通过场景构建工具制作并保存，接口仅控制启用或关闭

Instance.TravelerSequence(options，CallBack)

说明：options为配置项，具体见下表。

参数

播放一个的相机行进轨迹

说明：Route 只能通过场景构建工具创建，无法通过接口创建。我们也建议您的视角点、巡航序列、虚拟物体等均通过场景构建工具制作并保存，接口仅控制启用或关闭

Instance.Route(options，CallBack)

说明：options为配置项，具体见下表。

参数

获取所有视角点的 ID 列表

Instance.GetAllViewpointID(CallBack)

参数

获取所有视角点序列的 ID 列表

Instance.GetAllSequenceID(CallBack)

参数

设置视觉风格相关的方法

启动画面滤镜特效

Instance.ActivateFilter(options，CallBack)

说明：options为配置项，具体见下表。

参数

设置材质参数中的标量参数

说明：例如控制材质颜色饱和度，变成白模等功能

Instance.SetScalarParameter(options，CallBack)

说明：options为配置项，具体见下表。

参数

设置材质参数中的矢量参数。例如控制材质颜色，方向等功能

Instance.SetVectorParameter(options，CallBack)

说明：options为配置项，具体见下表。

参数

设置天气相关的方法

设置场景中的虚拟天气状态为预设好的天气

Instance.ApplyPreset(preset，CallBack)

参数

设置场景中的虚拟天气状态

说明：例如控制材质颜色饱和度，变成白模等功能

Instance.SetProp(options，CallBack)

说明：options为配置项，具体见下表。

参数

开始天气实时更新

Instance.StartUpdate(CallBack)

参数

结束天气实时更新

Instance.StopUpdate(CallBack)

参数

设置天空模式

说明：可以选择写实天空模式，模拟真实物理大气效果；也可以选择非写实天空模式，使用 HDRI 贴图来模拟各种风格的光照。

Instance.SetSkyMode(mode，CallBack)

参数

设置天空光的贴图

说明：设置天空光的贴图，来实现一些风格化的光照效果。需要使用 SetSkyMode 接口把天空模式设置为 NonRealistic 后，才能设置天空光贴图。可以切换成暗调的风格化。

Instance.SetSkyLightTexture(options，CallBack)

说明：options为配置项，具体见下表。

参数

设置场景中的时间

Instance.SetTime(time，CallBack)

参数

关于CallBack回调信息描述

其他用法

链式调用

示例：隐藏id分别为a和b的虚拟物体，然后显示id为c的虚拟物体

Instance.Hide('a').Hide('b').Show('c')

查看是否有控制权

Instance.checkControl((status,msg)=>{
console.log(status,msg)
})

回调返回

虚拟物体类名对应的类属性列表

说明：列表可在以下链接中查看

https://alidocs.dingtalk.com/i/p/3ZxX8RrPx7216G7d/docs/2Amq4vjg89glYB59fbRygkeyV3kdP0wQ?dontjump=true&utm_medium=dingdoc_doc_plugin_url&utm_source=dingdoc_doc