Class AreaMakerController

Hierarchy

Controller<AreaMakerPluginType.State, AreaMakerPluginType.EventMap, ServerData, AreaMakerPluginType.PluginData>
- AreaMakerController

Index

Constructors

constructor

new AreaMakerController(five, params?): AreaMakerController
AreaMakerPlugin
Parameters
- five: Five
- Optional params: AreaMakerPluginType.Params
Returns AreaMakerController
Overrides BasePlugin.Controller<PluginType.State, PluginType.EventMap, PluginType.ServerData, PluginType.PluginData>.constructor
- Defined in src/AreaMakerPlugin/Controller.ts:50

Properties

`Readonly` VERSION

VERSION: string = __DNALOGEL_VERSION__

@realsee/dnalogel 版本号

checkMsg

checkMsg: {
childrenMountedState: string;
} = ...

查询问题使用的调试对象

Type declaration

childrenMountedState: string

`Optional` data

data?: ServerDataV2

当前使用的数据

five

five: Five

hooks

hooks: Subscribe<AreaMakerPluginType.EventMap> = ...

@description: 插件事件钩子

itemMap

itemMap: Map<string | number, AreaMakerItem>

标注模型 { id: item } 的映射表

`Optional` itemRenderer

itemRenderer?: ItemRenderer

自定义 DOM

modelGroup

modelGroup: Group

标注模型容器

state

state: AreaMakerPluginType.State

插件当前状态

`Readonly` staticPrefix

staticPrefix: string = '//vr-image-4.realsee-cdn.cn'

tagDomContainer

tagDomContainer: HTMLDivElement

tag 容器

Accessors

config

get config(): {
modelDepthTest: boolean;
}
插件配置项

Returns {
modelDepthTest: boolean;
}
- modelDepthTest: boolean
  
  标注模型是否开启深度检测，此配置仅对模型生效，不会影响标签的展示效果。
  Default
```
true
```
  Description
  关闭后，标注模型不会被其他模型遮挡
- Defined in src/AreaMakerPlugin/Controller.ts:23

disposed

get disposed(): boolean
是否已经被销毁

Returns boolean
- Defined in src/AreaMakerPlugin/Controller.ts:27

Methods

absoluteUrl

absoluteUrl(url): string
@description: 获取静态资源的url
Parameters
- url: string
Returns string
Inherited from BasePlugin.Controller.absoluteUrl
- Defined in src/base/BasePlugin.ts:126

appendTo

appendTo(wrapper): void
将插件的 DOM 容器添加到指定的 DOM 元素上
Parameters
- wrapper: Element
Returns void
Overrides BasePlugin.Controller.appendTo
- Defined in src/AreaMakerPlugin/Controller.ts:109

disable

disable(options?): void
禁用插件
Parameters
- options: BaseOptions = {}
Returns void
Overrides BasePlugin.Controller.disable
- Defined in src/AreaMakerPlugin/Controller.ts:128

dispose

dispose(): void
销毁插件，移除所有副作用，销毁后将不响应任何 API

Returns void
Overrides BasePlugin.Controller.dispose
- Defined in src/AreaMakerPlugin/Controller.ts:232

enable

enable(options?): void
启用插件
Parameters
- options: BaseOptions = {}
Returns void
Overrides BasePlugin.Controller.enable
- Defined in src/AreaMakerPlugin/Controller.ts:117

getCurrentState

getCurrentState(): AreaMakerPluginType.State
获取当前的插件状态，如果当初插件内存在需要通过动画变更的 state 值，则通过此方法可以得到中间状态

Returns AreaMakerPluginType.State
Inherited from BasePlugin.Controller.getCurrentState
- Defined in src/base/BasePlugin.ts:96

getMaskItemByID

getMaskItemByID(id): AreaMakerItem
根据 ID 获取标注
Parameters
- id: string | number
Returns AreaMakerItem
- Defined in src/AreaMakerPlugin/Controller.ts:227

hide

hide(options?): Promise<void>
插件内容整体隐藏
Parameters
- Optional options: Partial<AreaMakerPluginType.ShowHideOptions>
Returns Promise<void>
Overrides BasePlugin.Controller.hide
- Defined in src/AreaMakerPlugin/Controller.ts:151

load

load(data): Promise<void>
加载数据，重复调用会使用新数据覆盖旧数据
Parameters
- data: ServerData
Returns Promise<void>
Overrides BasePlugin.Controller.load
- Defined in src/AreaMakerPlugin/Controller.ts:84

setState

setState(state, options?): void
更改插件 State
Parameters
- state: Partial<AreaMakerPluginType.State>
- options: BaseOptions = {}
Returns void
Overrides BasePlugin.Controller.setState
- Defined in src/AreaMakerPlugin/Controller.ts:198

show

show(options?): Promise<void>
展示标注
Parameters
- Optional options: Partial<AreaMakerPluginType.ShowHideOptions>
Returns Promise<void>
Overrides BasePlugin.Controller.show
- Defined in src/AreaMakerPlugin/Controller.ts:139

updateConfig

updateConfig(config, options?): void
更改插件 Config
Parameters
- config: Partial<AreaMakerPluginType.Config>
- options: BaseOptions = {}
Returns void
- Defined in src/AreaMakerPlugin/Controller.ts:219

Class AreaMakerController

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

five: Five

Optional params: AreaMakerPluginType.Params

Returns AreaMakerController

Properties

Readonly VERSION

checkMsg

Type declaration

childrenMountedState: string

Optional data

five

hooks

itemMap

Optional itemRenderer

modelGroup

state

Readonly staticPrefix

tagDomContainer

Accessors

config

Returns { modelDepthTest: boolean; }

modelDepthTest: boolean

Default

Description

disposed

Returns boolean

Methods

absoluteUrl

Parameters

url: string

Returns string

appendTo

Parameters

wrapper: Element

Returns void

disable

Parameters

options: BaseOptions = {}

Returns void

dispose

Returns void

enable

Parameters

options: BaseOptions = {}

Returns void

getCurrentState

Returns AreaMakerPluginType.State

getMaskItemByID

Parameters

id: string | number

Returns AreaMakerItem

hide

Parameters

Optional options: Partial<AreaMakerPluginType.ShowHideOptions>

Returns Promise<void>

load

Parameters

data: ServerData

Returns Promise<void>

setState

Parameters

state: Partial<AreaMakerPluginType.State>

options: BaseOptions = {}

Returns void

show

Parameters

Optional options: Partial<AreaMakerPluginType.ShowHideOptions>

Returns Promise<void>

updateConfig

Parameters

config: Partial<AreaMakerPluginType.Config>

`Optional` params: AreaMakerPluginType.Params

`Readonly` VERSION

`Optional` data

`Optional` itemRenderer

`Readonly` staticPrefix

Returns {
modelDepthTest: boolean;
}

`Optional` options: Partial<AreaMakerPluginType.ShowHideOptions>

`Optional` options: Partial<AreaMakerPluginType.ShowHideOptions>