Class Object3DHelperController

Hierarchy

Controller<Object3DHelperPluginState, Object3DHelperPluginEventMap>
- Object3DHelperController

Index

Constructors

Properties

VERSION five hooks name objectHelperMap state staticPrefix

Methods

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

Constructors

constructor

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

Properties

`Readonly` VERSION

VERSION: string = __DNALOGEL_VERSION__

@realsee/dnalogel 版本号

five

five: Five

hooks

hooks: Subscribe<Object3DHelperPluginEventMap> = ...

插件事件钩子

name

name: string = PLUGIN_NAME

objectHelperMap

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

state

state: Object3DHelperState = ...

`Readonly` staticPrefix

staticPrefix: string = '//vrlab-static.ljcdn.com'

Methods

addObject3DHelper

addObject3DHelper(object3D, config?): void | ObjectHelperControllers
Description
添加 helper
Parameters
- object3D: Object3D
  
  要添加helper的物体
- config: {
      boundingBoxHelper?: HelperConfig;
      moveHelper?: HelperConfig<{
          offset?: HelperOffset;
      }>;
      rotateHelper?: HelperConfig<{
          angleTipsEnable?: boolean;
          offset?: HelperOffset;
          xyCircleEnable?: boolean;
          xzCircleEnable?: boolean;
          yzCircleEnable?: boolean;
      }>;
      scaleHelper?: HelperConfig;
  } = {}
  - Optional boundingBoxHelper?: HelperConfig
  - Optional moveHelper?: HelperConfig<{
    offset?: HelperOffset;
    }>
    
    位移helper
  - Optional rotateHelper?: HelperConfig<{
        angleTipsEnable?: boolean;
        offset?: HelperOffset;
        xyCircleEnable?: boolean;
        xzCircleEnable?: boolean;
        yzCircleEnable?: boolean;
    }>
    
    旋转helper
  - Optional scaleHelper?: HelperConfig
    
    缩放helper
Returns void | ObjectHelperControllers
- Defined in plugins/src/Object3DHelperPlugin/Controller.ts:129

`Optional` appendTo

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

disable

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

dispose

dispose(): void
Description
Dispose

Returns void
Overrides BasePlugin.Controller.dispose
- Defined in plugins/src/Object3DHelperPlugin/Controller.ts:93

enable

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

getCurrentState

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

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

getObject3DHelper

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

hide

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

isAbsoluteURL

isAbsoluteURL(url): string
Parameters
- url: string
Returns string
Inherited from BasePlugin.Controller.isAbsoluteURL
- Defined in plugins/src/base/BasePlugin.ts:122

removeObject3DHelper

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

setState

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

show

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

Class Object3DHelperController

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

five: Five

Returns Object3DHelperController

Properties

Readonly VERSION

five

hooks

name

objectHelperMap

state

Readonly staticPrefix

Methods

addObject3DHelper

Description

Parameters

object3D: Object3D

config: { boundingBoxHelper?: HelperConfig; moveHelper?: HelperConfig<{ offset?: HelperOffset; }>; rotateHelper?: HelperConfig<{ angleTipsEnable?: boolean; offset?: HelperOffset; xyCircleEnable?: boolean; xzCircleEnable?: boolean; yzCircleEnable?: boolean; }>; scaleHelper?: HelperConfig; } = {}

Optional boundingBoxHelper?: HelperConfig

Optional moveHelper?: HelperConfig<{ offset?: HelperOffset; }>

Optional rotateHelper?: HelperConfig<{ angleTipsEnable?: boolean; offset?: HelperOffset; xyCircleEnable?: boolean; xzCircleEnable?: boolean; yzCircleEnable?: boolean; }>

Optional scaleHelper?: HelperConfig

Returns void | ObjectHelperControllers

Optional appendTo

Parameters

wrapper: Element

Returns void

disable

Description

Parameters

Optional options: { userAction?: boolean; }

Optional userAction?: boolean

Returns void

dispose

Description

Returns void

enable

Description

Parameters

Optional options: { userAction?: boolean; }

Optional userAction?: boolean

Returns void

getCurrentState

Returns Object3DHelperPluginState

getObject3DHelper

Parameters

object3D: Object3D

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

disposers: (() => any)[]

helper: Object3DHelper

hide

Description

Parameters

Optional options: { userAction?: boolean; }

Optional userAction?: boolean

Returns Promise<void>

isAbsoluteURL

Parameters

url: string

Returns string

removeObject3DHelper

Parameters

object3D: Object3D

Returns void

setState

Parameters

state: Partial<Object3DHelperState>

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

Returns void

show

Description

Parameters

Optional options: { userAction?: boolean; }

`Readonly` VERSION

`Readonly` staticPrefix

config: {
boundingBoxHelper?: HelperConfig;
moveHelper?: HelperConfig<{
offset?: HelperOffset;
}>;
rotateHelper?: HelperConfig<{
angleTipsEnable?: boolean;
offset?: HelperOffset;
xyCircleEnable?: boolean;
xzCircleEnable?: boolean;
yzCircleEnable?: boolean;
}>;
scaleHelper?: HelperConfig;
} = {}

`Optional` boundingBoxHelper?: HelperConfig

`Optional` moveHelper?: HelperConfig<{
offset?: HelperOffset;
}>

`Optional` rotateHelper?: HelperConfig<{
angleTipsEnable?: boolean;
offset?: HelperOffset;
xyCircleEnable?: boolean;
xzCircleEnable?: boolean;
yzCircleEnable?: boolean;
}>

`Optional` scaleHelper?: HelperConfig

`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