【开发文档】SuperAPI for Project (2022.01.17更新至5.4.0版本)

可乐 关注 7

❗❗ SuperAPI for Project 用于服务WDP3.0的相关场景

❗❗ SuperAPI for PaaS 用于服务WDP4.0的相关场景

 

目录指南:

一、概览——SuperAPI快速了解&API适配(本文)

二、学习SuperAPI——使用WDP3.0 搭建第一个属于你的数字孪生应用

三、版本信息——版权信息&版本更新

四、关于SuperAPI的常见问题

 

一、概览——SuperAPI快速了解&API适配

1、快速浏览

 

开启你的数字孪生新世界

 

51WORLD SuperAPI 是一套由 JavaScript 语言开发的负责交涉 Web 页面和云渲染服务之间的编程接口, 基于51平台使用;用户可在 WEB 页面上创建任意 HTML5 UI 元素, 利用 SuperAPI 与云场景进行双向交互。51WORLD SuperAPI 兼容当前主流的 JavaScript 前端框架, 为前端开发人员提供快速便捷的开发接口。

 

支持前端框架

1)SuperAPI使用 (VUE2.X篇)

  //id="player": 渲染3D场景窗口的Dom节点; 不要在里面加任何自定义开发的元素, 特别是video; 不要使用VUE自身的 v-show;



destroyed() 关闭云渲染, 释放资源, 单页应用释放资源请注意

 

 2)SuperAPI使用 (React篇)

//引入SuperAPI.js
import cloudRenderer from "superapi-51world"

class Content extends React.Component {
  constructor(props) {
      this.cloudRender = null
  }
  componentDidMount() {
      //初始化实例
      this.cloudRender = new cloudRenderer("player", 0)
      //启动云渲染
      this.cloudRender.SuperAPI("StartRenderCloud", "json.url")//json.url的获取请参考首个应用中的如何启动云渲染
  }
  componentWillUnmount() {
      this.cloudRender.SuperAPI("StopRenderCloud") //关闭云渲染, 释放资源 (此处是关键。单页应用释放资源请注意)
  }
  render() {
      return (
//id="player": 渲染3D场景窗口的Dom节点; 不要在里面加任何自定义开发的元素, 特别是video;
      );
  }
}

componentWillUnmount() 关闭云渲染, 释放资源, 单页应用释放资源请注意

 

3)SuperAPI使用 (Angular篇)

//引入SuperAPI.js
import cloudRenderer from "superapi-51world"

@Component({
  selector: 'app-root',
  template: `
`
})
export class AppComponent implements AfterViewInit, OnDestroy {
  player;  //渲染3D场景窗口的Dom节点
  cloudRender;

  ngAfterViewInit() {
    //初始化实例
    this.cloudRender = new cloudRenderer("player", 0)
    //启动云渲染
    this.cloudRender.SuperAPI("StartRenderCloud", "json.url")//json.url的获取请参考首个应用中的如何启动云渲染
  }

  ngOnDestroy() {
      this.cloudRender.SuperAPI('StopRenderCloud');
  }
}

  ngOnDestroy() 关闭云渲染, 释放资源, 单页应用释放资源请注意

 

2、技术框架

三维场景通过51WORLD云端渲染,然后采用实时视频流推送到网页端,并且能够实现前端到后端的交互同步;

像素流送以插件形式集成在引擎中,插件会对主机服务器的图形流信息进行编码,然后通过即时通信发送给位于接收端的浏览器和设备, 通过在高性能主机系统上运行渲染引擎,用户能在所有终端设备上享受到与主机相同的画质,并且能体验到所有的渲染引擎功能;

像素流插件在主机服务器上与客户端进行通信,可以通过单台服务器运行,也可以通过允许动态扩展并提供足够硬件的GPU云环境运行;

SuperAPI提供可在WEB UI页面进行调用的方法函数,以便用户从WEB UI向51WORLD云渲染平台程序发送指令;

SuperAPI注册函数监听51WORLD云渲染程序发送的事件,用户跟据事件类型,在web端JavaScript环境中响应此类事件。

 

3、版权信息

SuperAPI 商业授权计划

功能分类 社区版(永久免费) 商业版(订阅获取)
场景镜头  
覆盖物事件  
楼宇拆解  
POI点  
自定义POI点  
点聚合&大数据查询  
路径  
区域热力图    
柱状热力图    
点云热力图    
路径热力图    
迁徙图    
战略图    
区域轮廓    
圆形区域轮廓    
高亮区域    
可视域    
场景特效    
覆盖物关联Window    
覆盖物移动    
中国地图    
水晶体模式    
获取覆盖物ID    
获取场景元素EID    
二维坐标计算    
场景坐标转换    
控件    

4、版本历史

Version 5.4.0 —— 22.01.17更新

Version 5.3.0 —— 21.11.10更新

Version 5.2.0 —— 21.09.15更新

Version 5.1.0 —— 21.06.28更新

Version 5.0.0 —— 21.05.14更新

……

参考链接:https://bbs.51aes.com/blog/1438036186432208898.html

 

5、API适配

文档适配

SuperAPI分为SuperAPI for Project和SuperAPI for PaaS(通过左上角的下拉框进行切换)

SuperAPI for PaaS 用于服务WDP4.0中创景的场景(版本从6.0及以上), SuperAPI for Project 用于服务WDP3.0中的相关场景(版本从1.0-5.x);


SuperAPI for PaaS 版本包含SuperAPI for Project 版本几乎所有的功能(除全局水晶体), 并在此基础上增加了一系列场景编辑相关API(如何获取AES实体EID -- StartGetEID、拍平AES实体 -- FlattenAESObject的等);

 

插件适配

为了更好的体验, 建议引用的 SuperAPI js SDK 主、次版本号应与场景插件中的主、次版本号一致

真正可以使用的API功能由场景插件的版本决定, 仅升级SuperAPI js SDK版本, 无法使用相应版本的功能。

 

查询API版本信息

API的版本查询有两个途径:

①通过API接口调用, 场景在加载时也会打印这个信息(SuperAPIinfo回调需要版本4.1.0及以上)

cloudRender.SuperAPI("superAPIinfo", (e) => {
    console.log(e);
})

 

callback: (e) 可选

功能描述:

查询SuperAPI info, 控制台输出 ( 3.2.0 及以上版本适用, callback需4.1.0及以上版本 )

 

②编辑平台左侧列表栏底部, 点击SuperAPI 信息, 查看SuperAPI Information

云渲染的版本

云渲染版本只会影响云渲染服务本身及对应平台软件的使用, 与API版本无直接影响关系

WDP4.0(即51WDP数字孪生PaaS平台)和WDP3.0(51Cloud云渲染平台)都有各自对应的云渲染服务版本, 更多云渲染版本细节请点击查看 👉云渲染版本历史

 


 

 

更多详情请参考:SuperAPI完整开发文档👉: http://superapi.51aes.com

 

如需更多产品使用帮助,请移步“问答区——SuperAPI“ 提问

或扫码加入 51WORLD 官方答疑QQ群提问

您愿意向朋友推荐 ‘社区博客’ 吗?
强烈不推荐 不推荐 无所谓 推荐 强烈推荐
感谢您的反馈,谢谢!
阅读 455 本作品系原创,转载请联系作者授权
赞 1 收藏
全部评论({{commentCount}}条评论)
得票数 最新

暂无数据