Class Object3DHelperController

Hierarchy

Controller<Object3DHelperPluginState, Object3DHelperPluginEventMap>
- Object3DHelperController

Index

Constructors

Properties

VERSION five hooks name objectHelperMap state staticPrefix

Methods

absoluteUrl addObject3DHelper appendTo? disable dispose enable getCurrentState getObject3DHelper hide removeObject3DHelper setState show

Constructors

constructor

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

Properties

`Readonly` VERSION

VERSION: string = __DNALOGEL_VERSION__

@realsee/dnalogel 版本号

five

five: Five

hooks

hooks: Subscribe<Object3DHelperPluginEventMap> = ...

@description: 插件事件钩子

name

name: string = PLUGIN_NAME

objectHelperMap

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

Type declaration

disposers: (() => any)[]
helper: Object3DHelper

state

state: Object3DHelperState = ...

`Readonly` staticPrefix

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

Methods

absoluteUrl

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

addObject3DHelper

addObject3DHelper(object3D, paramsConfig?): ObjectHelperControllers
Parameters
- object3D: Object3D
  
  要添加helper的物体
- paramsConfig: AddObject3DHelperConfig = {}
Returns ObjectHelperControllers

Description
添加 helper
- Defined in src/Object3DHelperPlugin/Controller.ts:160

`Optional` appendTo

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

disable

disable(options?): void
Parameters
- Optional options: {
  userAction?: boolean;
  }
  - Optional userAction?: boolean
Returns void

Description
Disable
Overrides BasePlugin.Controller.disable
- Defined in src/Object3DHelperPlugin/Controller.ts:117

dispose

dispose(): void
Returns void

Description
Dispose
Overrides BasePlugin.Controller.dispose
- Defined in src/Object3DHelperPlugin/Controller.ts:124

enable

enable(options?): void
Parameters
- Optional options: {
  userAction?: boolean;
  }
  - Optional userAction?: boolean
Returns void

Description
Enable
Overrides BasePlugin.Controller.enable
- Defined in src/Object3DHelperPlugin/Controller.ts:110

getCurrentState

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

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

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:149

hide

hide(options?): Promise<void>
Parameters
- Optional options: {
  userAction?: boolean;
  }
  - Optional userAction?: boolean
Returns Promise<void>

Description
Hide guide line
Overrides BasePlugin.Controller.hide
- Defined in src/Object3DHelperPlugin/Controller.ts:103

removeObject3DHelper

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

setState

setState(state, options?): void
Parameters
- state: Partial<Object3DHelperState>
- Optional options: {
  userAction?: boolean;
  } & Record<string, any>
Returns void
Overrides BasePlugin.Controller.setState
- Defined in src/Object3DHelperPlugin/Controller.ts:128

show

show(options?): Promise<void>
Parameters
- Optional options: {
  userAction?: boolean;
  }
  - Optional userAction?: boolean
Returns Promise<void>

Description
Show guide line
Overrides BasePlugin.Controller.show
- Defined in src/Object3DHelperPlugin/Controller.ts:96

Class Object3DHelperController

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

five: Five

Returns Object3DHelperController

Properties

Readonly VERSION

five

hooks

name

objectHelperMap

Type declaration

disposers: (() => any)[]

helper: Object3DHelper

state

Readonly staticPrefix

Methods

absoluteUrl

Parameters

url: string

Returns string

addObject3DHelper

Parameters

object3D: Object3D

paramsConfig: AddObject3DHelperConfig = {}

Returns ObjectHelperControllers

Description

Optional appendTo

Parameters

wrapper: Element

Returns void

disable

Parameters

Optional options: { userAction?: boolean; }

Optional userAction?: boolean

Returns void

Description

dispose

Returns void

Description

enable

Parameters

Optional options: { userAction?: boolean; }

Optional userAction?: boolean

Returns void

Description

getCurrentState

Returns Object3DHelperPluginState

getObject3DHelper

Parameters

object3D: Object3D

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

disposers: (() => any)[]

helper: Object3DHelper

hide

Parameters

Optional options: { userAction?: boolean; }

Optional userAction?: boolean

Returns Promise<void>

Description

removeObject3DHelper

Parameters

object3D: Object3D

Returns void

setState

Parameters

state: Partial<Object3DHelperState>

Optional options: { userAction?: boolean; } & Record<string, any>

Returns void

show

Parameters

Optional options: { userAction?: boolean; }

Optional userAction?: boolean

Returns Promise<void>

`Readonly` VERSION

`Readonly` staticPrefix

`Optional` appendTo

`Optional` options: {
userAction?: boolean;
}

`Optional` userAction?: boolean

`Optional` options: {
userAction?: boolean;
}

`Optional` userAction?: boolean

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

`Optional` options: {
userAction?: boolean;
}

`Optional` userAction?: boolean

`Optional` options: {
userAction?: boolean;
} & Record<string, any>

`Optional` options: {
userAction?: boolean;
}

`Optional` userAction?: boolean