krpano插件接口说明文档

krpano插件接口

更新 2022.3.7 krpano 1.20.11

krpano为开发者提供了简单轻便的接口用于开发第三方插件。
krpano的插件可以是纯代码插件用于扩展功能或控制krpano,也可以是在屏幕上展示或处理某些事情的“图形化插件”。有两种类型的插件:

  • 用于krpano HTML5 viewer 的HTML5 Javascript 插件 (.js)
  • 用于 krpano Flash viewer的Flash Actionscript3 插件 (.swf)

插件到krpano以及krpano到插件的基础接口对于HTML5和Flash插件是几乎相同的,只有系统和语言上的区别。

插件的基础结构里含有以下公共函数,它们将在krpano中被调用:

  • registerplugin函数 – 当插件载入时,该插件从krpano中被调用。该函数提供了krpano Interface Object以及krpano Plugin Object
  • unloadplugin函数 – 当插件从krpano中移除时,该函数被调用。这样插件添加的所有元素和事件将被移除。
  • 此外提供了onresize函数允许插件根据屏幕大小改变插件的尺寸。

插件本身可以将自定义函数或属性直接添加/设置到krpano对象或插件对象中,实现向krpano添加自定义函数或属性。对于设置从xml中传递来的属性,提供了registerattribute函数,它可以使得属性既可以有自己的默认值,也可以接受从xml传递来的数值。registerattribute函数可以用来添加setter/getter属性-这些属性在访问变量时自动调用get或set函数-可用于在属性更改时获得通知。

 

HTML5 Javascript插件

krpano的Javascript插件与普通的Javascript代码是相同的。
无需特别的工具用于编译和构建,但推荐压缩代码减少文件体积。

下面是一个Javascript的插件例子:

演示

下载地址

https://krpano.com/docu/plugininterface/pluginexample.zip

 

压缩HTML5 Javascript插件代码

这个步骤是可选的,但推荐压缩代码来减少js文件的体积。下面是推荐的工具。

此外,压缩过的js文件可以使用krpano加密工具进一步压缩和加密以及保护。

 

Actionscript3 Flash插件

用于krpano Flash viewer的krpano flash插件可以使用Flex SDK (推荐)或 Flash Professional CS 来编译。

下面是flash插件的例子:

演示

下载地址

VIP课程仅供会员阅读,加入会员请查看网站顶部 加入会员 说明