Class: SpinTileViewer

SpinTileViewer

环绕图组播放器,单视角支持高清图分级分块渲染,支持360和720度环绕。

new Hydreigon.SpinTileViewer (container, ak, sk, options)

Name Type Description
container HTMLElement 播放器容器element.
ak string | undefined ak字符码
sk string | undefined sk字符码
options Object SDK配置
Name Type Default Description
mode number 0 optional 0-展示,1-编辑
debug boolean false optional 是否开启调试模式
supplyId number 100 optional 用于初始化Reporter

Methods

autoRotate (rotate, stepTime, direction, immediately)

自动旋转开关
Name Type Default Description
rotate boolean optional 展示时进行动画,0:无动画;1:旋转透明度动画;2:旋转透明度缩放动画;
stepTime number 120 optional 自动旋转的速度,默认120
direction number optional 旋转的方向;1/-1代表两个相反的旋转方向
immediately boolean false optional 是否立即开始,默认延迟3000ms

enablePan (enable, number)

平移功能的开关
Name Type Default Description
enable boolean
number pointers 1 optional 双指/单指

enableSpin (enable)

开启旋转
Name Type Description
enable boolean

getHorizontalReversal ()boolean

获取水平方向旋转的反转状态
Returns:
Type Description
boolean

getMaxScale ()number

获取缩放的最大倍数
Returns:
Type Description
number

getMinScale ()number

获取缩放的最小倍数
Returns:
Type Description
number

getScale (current)number

获取缩放的倍数
Name Type Description
current boolean true:当前状态下的缩放值,false:还是目标状态的缩放值
Returns:
Type Description
number

getVerticalReversal ()boolean

获取竖直方向旋转的反转状态
Returns:
Type Description
boolean

init (config)Promise

初始化环物渲染的Viewer
Name Type Description
config Configuration Configuration对象,里面含有渲染所所必需的配置
Returns:
Type Description
Promise , resolve鉴权成功回调函数,reject失败回调函数;

isPanEnabled ()boolean

当前平移功能的状态
Returns:
Type Description
boolean

isSpinEnabled ()boolean

是否允许旋转
Returns:
Type Description
boolean

panBy (deltaX, deltaY)

增量平移,水平方向上平移deltaX,竖直方向上平移deltaY
Name Type Description
deltaX number 图片坐标系下x轴偏移量
deltaY number 图片坐标系下Y轴偏移量

panTo (center, immediately, animationTime, constrain, timing)promise

平移到指定的位置
Name Type Description
center Array.<number> 平移的目标位置
immediately boolean 是否立刻执行,true:闪过去,false:动画过去
animationTime number 如果immediately=false,指定动画的时间
constrain boolean 是否受边缘的约束,默认true
timing string 动画曲线:linear,easing等
Returns:
Type Description
promise 执行完后返回promise。

panToCenter ()promise

将突破缩放到初始情况。
Returns:
Type Description
promise 执行完后返回promise。

pointToCenter (coord, immediately, animationTime)promise

将指定的坐标点移动到容器中央
Name Type Description
coord Array.<number> 指定的坐标点
immediately boolean
animationTime number 动画时长,immediately为false时生效
Returns:
Type Description
promise 执行完后返回promise。

resize (reason)

手动触发渲染区域的resize,默认会监听系统的resize事件
Name Type Description
reason

setHorizontalReversal (reversal)

设置水平旋转方向的反转状态
Name Type Description
reversal boolean 是否反转

setMaxScale (maxScale)

设置缩放的最大倍数
Name Type Description
maxScale number 最大倍数,该值应该大于最小的scale值

setVerticalReversal (reversal)

设置垂直旋转方向的反转状态
Name Type Description
reversal boolean 是否反转

show (enterAnimation, rotateCfg)

展示出环物渲染的Viewer,默认不展示
Name Type Default Description
enterAnimation number 0 optional 展示时进行动画,0:无动画;1:旋转透明度动画;2:旋转透明度缩放动画;
rotateCfg object 展示后开始进行自动旋转,默认不进行自动旋转

snapshot (option)Promise.<string> async

截图
Name Type Description
option Object
Name Type Default Description
quality number 0.92 optional 截图质量
type string 'image/jpeg' optional 图片类型
withBg boolean false optional 截图带背景
Returns:
Type Description
Promise.<string> 图片base64

spinRound (direction, stepTime)

旋转一周
Name Type Default Description
direction number 当前方向 optional 旋转方向1/-1
stepTime number optional 旋转速度

spinTo (target, immediately, stepTime, timing)promise

旋转到指定的位置
Name Type Description
target Array.<number> 旋转的目标位置
immediately boolean 是否立刻执行,true:闪过去,false:动画过去
stepTime boolean 如果immediately=false,指定动画的时间
timing string 动画曲线:linear,easing等
Returns:
Type Description
promise 执行完后返回promise。

startAnimation (animType, callback)

执行动画
Name Type Default Description
animType number 1 optional 0: 无动画;1:平移旋转动画;2:平移旋转缩放动画;
callback function 动画结束后的回调

stopAnimation ()promise

停止动画
Returns:
Type Description
promise

uninit ()

销毁方法;uninit与init方法对应;

updateConfiguration (config)

换一个新的configuration
Name Type Description
config Configuration 新的configuration对象

zoom (scale)promise

缩放到指定的倍数
Name Type Description
scale number 缩放倍数
Returns:
Type Description
promise

Events

hs-update

热点更新
Type:
  • object
Properties:
Name Type Argument Description
pos Array.<number> 位置信息
isUp boolean <optional>

hyd-config-error

配置内容错误
Type:
  • object
Properties:
Name Type Description
msg string 错误提示内容

hyd-image-error

资源加载出错
Type:
  • object

hyd-image-loaded

资源加载完毕

hyd-image-loading

资源加载中
Type:
  • object
Properties:
Name Type Description
progress number 进度 0-1

hyd-rotate-start

开始自动旋转

hyd-startup-end

进场结束,仅第一次渲染触发

hyd-startup-error

进场失败
Type:
  • object
Properties:
Name Type Description
error Error

hyd-view-ready

场景ready, 替换素材时也会触发

hyd-view-spin

视角发生旋转

hyd-zoom-change

缩放
Type:
  • object
Properties:
Name Type Argument Description
reason string <optional>
缩放原因
zoom number 缩放值

hyd-zoom-from-home

缩放,离开最小的zoom

hyd-zoom-from-max

缩放,离开最大的zoom

hyd-zoom-to-home

缩放至最小zoom

hyd-zoom-to-max

缩放至最大zoom