Class: UStageController

Constructor

new UStageController(live2d, selectoropt, dataopt)

stage 控制器类

创建 live2d stage 控制器

Parameters:

Name	Type	Attributes	Default	Description
`live2d`	ULive2dController			live2d 上下文
`selector`	string \| null	<optional>	null	父元素选择器
`data`	DStage \| null	<optional>	null	舞台元素数据

Source: controller/stage.js, line 21

Listens to Events:

EEvent#event:modelLoad 模型加载完成的事件

Extends

UBaseController

Members

(protected) _data :DStage

stage 数据

live2d 舞台数据集合, 用于存储 canvas, tips 等文档元素

Type:

DStage

Source: controller/stage.js, line 28

(protected) _live2d :ULive2dController

live2d 上下文

live2d 数据选项控制器

Type:

ULive2dController

Overrides: UBaseController#_live2d
Source: controller/base.js, line 19

(protected) _menuItems :Array.<UStageController~TMenuItem>

菜单集

在菜单元素中显示的菜单集

Type:

Array.<UStageController~TMenuItem>

Default Value: []
Source: controller/stage.js, line 37

(readonly) app :TApplication

Application 实例

getter: Application 实例

Type:

TApplication

Overrides: UBaseController#app
Source: controller/base.js, line 63

(readonly) canvas :HTMLCanvasElement

画布元素

getter: 画布元素

Type:

HTMLCanvasElement

Source: controller/stage.js, line 88

(readonly) event :EventEmitter

event 实例

getter: EventEmitter3 实例

Type:

EventEmitter

Overrides: UBaseController#event
Source: controller/base.js, line 73

(readonly) live2d :ULive2dController

live2d 上下文

getter: live2d 上下文

Type:

ULive2dController

Overrides: UBaseController#live2d
Source: controller/base.js, line 43

(readonly) live2dData :DLive2dOptions

live2d 数据

getter: live2d 原始数据

Type:

DLive2dOptions

Overrides: UBaseController#live2dData
Source: controller/base.js, line 53

(readonly) menuItems :Array.<UStageController~TMenuItem>

菜单数组

getter: 菜单元素数组

Type:

Array.<UStageController~TMenuItem>

Source: controller/stage.js, line 68

(readonly) menus :HTMLElement

菜单元素

getter: 菜单元素

Type:

HTMLElement

Source: controller/stage.js, line 108

(readonly) other :HTMLElement

其它元素

getter: 其它元素

Type:

HTMLElement

Source: controller/stage.js, line 118

(readonly) parent :HTMLElement

父元素

getter: wrapper 的父元素

Type:

HTMLElement

Source: controller/stage.js, line 128

(readonly) ref :Record.<string, any>

对象引用

getter: 以键值对进行记录的对象引用

Type:

Record.<string, any>

Overrides: UBaseController#ref
Source: controller/base.js, line 83

(readonly) tips :HTMLElement

提示元素

getter: 消息提示元素

Type:

HTMLElement

Source: controller/stage.js, line 98

(readonly) wrapper

包装器元素

getter: 包装器元素

Source: controller/stage.js, line 78

Methods

(async, protected) _fade(element, proceed, exit) → {Promise.<void>}

元素淡入淡出

对指定元素应用淡入或者淡出动画

Parameters:

Name	Type	Description
`element`	HTMLElement \| null	需要执行动画的元素, 默认是包装器元素
`proceed`	'fadeIn' \| 'fadeOut'	需要进行的动画名称
`exit`	'fadeIn' \| 'fadeOut'	需要退出的动画名称

Source: controller/stage.js, line 226

Fires:

EEvent#event:fadeStart 淡入淡出开始时间
EEvent#event:fadeEnd 淡入淡出结束事件
EEvent#event:fadeCancel 淡入淡出取消事件

Returns:

Type:: Promise.<void>

(protected) _onModelLoad(style) → {void}

模型加载完成后的回调事件

模型加载完成后触发的事件, 负责设置包装器的宽高, 以及调整模型大小

Parameters:

Name	Type	Description
`style`	TRect	模型宽高

Source: controller/stage.js, line 388

Returns:

Type:: void

addMenu(element, priorityopt) → {UStageController}

添加菜单元素

将菜单元素及优先级作为一个对象添加到 menuItems

Parameters:

Name	Type	Attributes	Default	Description
`element`	HTMLElement			文档元素
`priority`	number	<optional>	2	优先级

Source: controller/stage.js, line 289

Returns:

自身引用

Type:: UStageController

destroy()

销毁 stage 控制器

销毁控制器, 移除菜单元素, 以及移除绑定的事件

Overrides: UBaseController#destroy
Source: controller/stage.js, line 177

(async) fadeIn(elementopt) → {Promise.<void>}

元素淡入

对指定元素应用者淡入动画

Parameters:

Name	Type	Attributes	Default	Description
`element`	HTMLElement \| null	<optional>	null	需要执行淡入的元素, 默认是包装器元素

Source: controller/stage.js, line 198

Returns:

Type:: Promise.<void>

(async) fadeOut(elementopt) → {Promise.<void>}

元素淡出

对指定元素应用者淡出动画

Parameters:

Name	Type	Attributes	Default	Description
`element`	HTMLElement \| null	<optional>	null	需要执行淡出的元素, 默认是包装器元素

Source: controller/stage.js, line 209

Returns:

Type:: Promise.<void>

getParentFromSelector(selectoropt) → {HTMLElement}

获取父元素

从选择器中获取父元素

css 选择器规则优先, 其次是 xpath 规则, 当两个都找不到时, 则使用 body 为父元素

Parameters:

Name	Type	Attributes	Default	Description
`selector`	string \| null	<optional>	null	选择器

Source: controller/stage.js, line 341

Returns:

获取到的节点元素

Type:: HTMLElement

getTransitionDuration(element) → {number}

获取过度时间

获取指定元素的 transition-duration 值

Parameters:

Name	Type	Description
`element`	HTMLElement	元素

Source: controller/stage.js, line 361

Returns:

持续时间

Type:: number

init()

初始化 stage 控制器

初始化 stage 控制器, 并为元素设置层级结构以及类名与样式

Overrides: UBaseController#init
Source: controller/stage.js, line 137

isRight() → {boolean}

判断 wrapper 的左右位置

判断 wrapper 元素是在窗口的左边还是右边

Source: controller/stage.js, line 373

Returns:

true 和 false

Type:: boolean

removeMenu(element) → {UStageController}

移除菜单元素

在 menuItems 中移除指定的菜单元素

Parameters:

Name	Type	Description
`element`	HTMLElement	文档元素

Source: controller/stage.js, line 307

Returns:

自身引用

Type:: UStageController

showAndHiddenMenus(event)

显示和隐藏菜单

当鼠标进入舞台时显示菜单, 离开时隐藏

当触摸到舞台时显示菜单, 否则隐藏菜单

Parameters:

Name	Type	Description
`event`	MouseEvent \| TouchEvent	鼠标事件 \| 触摸事件

Source: controller/stage.js, line 324

Type Definitions

TMenuItem

菜单元素项目

由元素及其优先级构成的菜单元素项目

Type:

Object

Properties

Name	Type	Description
`element`	HTMLElement	菜单元素
`priority`	number	元素优先级

Source: controller/stage.js, line 5