Class Object3DHelperController

Hierarchy

Controller<Object3DHelperPluginState, Object3DHelperPluginEventMap>
- Object3DHelperController

Index

Constructors

constructor

new Object3DHelperController(five): Object3DHelperController
Parameters
- five: Five
Returns Object3DHelperController
Overrides BasePlugin.Controller<Object3DHelperPluginState, Object3DHelperPluginEventMap>.constructor
- Defined in src/Object3DHelperPlugin/Controller.ts:144

Properties

five

five: Five

fiveUtil

fiveUtil: FiveUtil

hooks

hooks: Subscribe<Object3DHelperPluginEventMap> = ...

@description: 插件事件钩子

name

name: string = PLUGIN_NAME

`Optional`NAME

NAME?: string

objectHelperMap

objectHelperMap: Map<Object3D, {
disposers: (() => any)[];
helper: Object3DHelper;
}> = ...

state

state: Object3DHelperState = ...

当前状态

Description

可以通过 plugin.state 和 plugin.setState 来获取和设置。
通过 state 设置后，plugin 会通过合适的动画运动来达到设置的效果。
来迎合一些通过数据驱动的场景。

`Readonly`staticPrefix

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

`Readonly`VERSION

VERSION: string = __DNALOGEL_VERSION__

@realsee/dnalogel 版本号

workUtil

workUtil: WorkUtil

Accessors

workCode

get workCode(): string
Returns string
Inherited from BasePlugin.Controller.workCode
- Defined in src/base/BasePlugin.ts:84
set workCode(workCode): void
Parameters
- workCode: string
Returns void
Inherited from BasePlugin.Controller.workCode
- Defined in src/base/BasePlugin.ts:79

Methods

absoluteUrl

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

addObject3DHelper

addObject3DHelper(object3D, paramsConfig?): ObjectHelperControllers
Parameters
- object3D: Object3D
  要添加helper的物体
- paramsConfig: AddObject3DHelperConfig = {}
Returns ObjectHelperControllers
Description
添加 helper
- Defined in src/Object3DHelperPlugin/Controller.ts:223

`Optional`appendTo

appendTo(wrapper): void
插件自身DOM添加到父容器
Parameters
- wrapper: Element
Returns void
Inherited from BasePlugin.Controller.appendTo
- Defined in src/base/BasePlugin.ts:130

disable

disable(options?): void
Parameters
- Optionaloptions: {
  userAction?: boolean;
  }
  - OptionaluserAction?: boolean
Returns void
Description
Disable
Overrides BasePlugin.Controller.disable
- Defined in src/Object3DHelperPlugin/Controller.ts:180

dispose

dispose(): void
Returns void
Description
Dispose
Overrides BasePlugin.Controller.dispose
- Defined in src/Object3DHelperPlugin/Controller.ts:187

enable

enable(options?): void
Parameters
- Optionaloptions: {
  userAction?: boolean;
  }
  - OptionaluserAction?: boolean
Returns void
Description
Enable
Overrides BasePlugin.Controller.enable
- Defined in src/Object3DHelperPlugin/Controller.ts:173

getCurrentState

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

Returns Object3DHelperPluginState
Inherited from BasePlugin.Controller.getCurrentState
- Defined in src/base/BasePlugin.ts:122

getObject3DHelper

getObject3DHelper(object3D): {
disposers: (() => any)[];
helper: Object3DHelper;
}
Parameters
- object3D: Object3D
Returns {
disposers: (() => any)[];
helper: Object3DHelper;
}
- disposers: (() => any)[]
- helper: Object3DHelper
- Defined in src/Object3DHelperPlugin/Controller.ts:212

hide

hide(options?): Promise<void>
Parameters
- Optionaloptions: {
  userAction?: boolean;
  }
  - OptionaluserAction?: boolean
Returns Promise<void>
Description
Hide guide line
Overrides BasePlugin.Controller.hide
- Defined in src/Object3DHelperPlugin/Controller.ts:166

removeObject3DHelper

removeObject3DHelper(object3D): void
Parameters
- object3D: Object3D
Returns void
- Defined in src/Object3DHelperPlugin/Controller.ts:370

setState

setState(state, options?): void
设置state
Parameters
- state: Partial<Object3DHelperState>
  插件的目标状态
- Optionaloptions: {
  userAction?: boolean;
  } & Record<string, any>
  配置项
Returns void
Overrides BasePlugin.Controller.setState
- Defined in src/Object3DHelperPlugin/Controller.ts:191

show

show(options?): Promise<void>
Parameters
- Optionaloptions: {
  userAction?: boolean;
  }
  - OptionaluserAction?: boolean
Returns Promise<void>
Description
Show guide line
Overrides BasePlugin.Controller.show
- Defined in src/Object3DHelperPlugin/Controller.ts:159

updateFive

updateFive(five): void
Parameters
- five: Five
Returns void
Inherited from BasePlugin.Controller.updateFive
- Defined in src/base/BasePlugin.ts:113

Class Object3DHelperController

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Object3DHelperController

Properties

five

fiveUtil

hooks

name

OptionalNAME

objectHelperMap

state

Description

ReadonlystaticPrefix

ReadonlyVERSION

workUtil

Accessors

workCode

Returns string

Parameters

Returns void

Methods

absoluteUrl

Parameters

Returns string

addObject3DHelper

Parameters

Returns ObjectHelperControllers

Description

OptionalappendTo

Parameters

Returns void

disable

Parameters

OptionaluserAction?: boolean

Returns void

Description

dispose

Returns void

Description

enable

Parameters

OptionaluserAction?: boolean

Returns void

Description

getCurrentState

Returns Object3DHelperPluginState

getObject3DHelper

Parameters

Returns { disposers: (() => any)[]; helper: Object3DHelper; }

disposers: (() => any)[]

helper: Object3DHelper

hide

Parameters

OptionaluserAction?: boolean

Returns Promise<void>

Description

removeObject3DHelper

Parameters

Returns void

setState

Parameters

Returns void

show

Parameters

OptionaluserAction?: boolean

Returns Promise<void>

Description

updateFive

Parameters

Returns void

Settings

On This Page

`Optional`NAME

`Readonly`staticPrefix

`Readonly`VERSION

`Optional`appendTo

`Optional`userAction?: boolean

`Optional`userAction?: boolean

Returns {
disposers: (() => any)[];
helper: Object3DHelper;
}

`Optional`userAction?: boolean

`Optional`userAction?: boolean