Class WalkController

Hierarchy

default<CruisePluginTypes.PluginData, CruisePluginTypes.Config>
- WalkController

Index

Constructors

Properties

VERSION five hooks state staticPrefix

Accessors

Methods

absoluteUrl appendTo? disable dispose enable getCurrentState hide load pause play playFrom playFromStart setState show

Constructors

constructor

new WalkController(five, config?): WalkController
Parameters
- five: Five
- Optional config: CruisePluginTypes.Config
Returns WalkController
Overrides CruiseController<PluginData, Config>.constructor
- Defined in src/CruisePlugin/Work.ts:56

Properties

`Readonly` VERSION

VERSION: string = __DNALOGEL_VERSION__

@realsee/dnalogel 版本号

five

five: Five

hooks

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

@description: 插件事件钩子

state

state: CruisePluginTypes.PluginState = ...

`Readonly` staticPrefix

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

Accessors

workCode

get workCode(): string
Returns string
Inherited from CruiseController.workCode
- Defined in src/CruisePlugin/BaseController.ts:30
set workCode(workCode): void
Parameters
- workCode: string
Returns void
Inherited from CruiseController.workCode
- Defined in src/CruisePlugin/BaseController.ts:26

Methods

absoluteUrl

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

`Optional` appendTo

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

disable

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

Description
Disable
Inherited from CruiseController.disable
- Defined in src/CruisePlugin/BaseController.ts:111

dispose

dispose(): void
Returns void

Description
Dispose
Inherited from CruiseController.dispose
- Defined in src/CruisePlugin/BaseController.ts:118

enable

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

Description
Enable
Inherited from CruiseController.enable
- Defined in src/CruisePlugin/BaseController.ts:104

getCurrentState

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

Returns CruisePluginTypes.PluginState
Inherited from CruiseController.getCurrentState
- Defined in src/base/BasePlugin.ts:96

hide

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

Description
Hide guide line
Inherited from CruiseController.hide
- Defined in src/CruisePlugin/BaseController.ts:97

load

load(serverData, state?, userAction?): Promise<void>
Parameters
- serverData: MoveWithPanoIndexAction | MoveWithKeyframesAction | CruisePluginTypes.PluginServerData
- Optional state: CruisePluginTypes.PluginState
- Optional userAction: boolean
Returns Promise<void>

Description
Load Data and State
Overrides CruiseController.load
- Defined in src/CruisePlugin/Work.ts:65

pause

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

Description
Pause
Inherited from CruiseController.pause
- Defined in src/CruisePlugin/BaseController.ts:83

play

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

Description
Play | Continue play. if have been paused, continue play from the pause position; if playing, do nothing
Inherited from CruiseController.play
- Defined in src/CruisePlugin/BaseController.ts:76

playFrom

playFrom(options): void
Parameters
- options: {
      id?: string;
      index?: number;
      userAction?: boolean;
  }
  - Optional id?: string
    
    play from keyframes id
  - Optional index?: number
    
    play from keyframes index
  - Optional userAction?: boolean
Returns void

Description
If playing, first pause, then play from keyframes index/id
- Defined in src/CruisePlugin/Work.ts:129

playFromStart

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

Description
Play from first keyframe
Overrides CruiseController.playFromStart
- Defined in src/CruisePlugin/Work.ts:138

setState

setState(state, options?): void
Parameters
- state: PartialObjectDeep<CruisePluginTypes.PluginState, {}>
- Optional options: BaseOptions & Record<string, any>
Returns void

Description
Set state
Inherited from CruiseController.setState
- Defined in src/CruisePlugin/BaseController.ts:125

show

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

Description
Show guide line
Inherited from CruiseController.show
- Defined in src/CruisePlugin/BaseController.ts:90