Class WalkController

Hierarchy

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

Index

Constructors

Properties

five fiveUtil hooks NAME? state staticPrefix VERSION workUtil

Accessors

Methods

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

Constructors

constructor

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

Properties

five

five: Five

fiveUtil

fiveUtil: FiveUtil

hooks

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

@description: 插件事件钩子

`Optional`NAME

NAME?: string

state

state: CruisePluginTypes.PluginState = ...

`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 CruiseController.workCode
- Defined in src/base/BasePlugin.ts:84
set workCode(workCode): void
Parameters
- workCode: string
Returns void
Inherited from CruiseController.workCode
- Defined in src/base/BasePlugin.ts:79

Methods

absoluteUrl

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

`Optional`appendTo

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

disable

disable(options?): void
Parameters
- Optionaloptions: {
  userAction?: boolean;
  }
  - OptionaluserAction?: boolean
Returns void
Description
Disable
Inherited from CruiseController.disable
- Defined in src/CruisePlugin/BaseController.ts:99

dispose

dispose(): void
Returns void
Description
Dispose
Inherited from CruiseController.dispose
- Defined in src/CruisePlugin/BaseController.ts:106

enable

enable(options?): void
Parameters
- Optionaloptions: {
  userAction?: boolean;
  }
  - OptionaluserAction?: boolean
Returns void
Description
Enable
Inherited from CruiseController.enable
- Defined in src/CruisePlugin/BaseController.ts:92

getCurrentState

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

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

hide

hide(options?): Promise<void>
Parameters
- Optionaloptions: {
  userAction?: boolean;
  }
  - OptionaluserAction?: boolean
Returns Promise<void>
Description
Hide guide line
Inherited from CruiseController.hide
- Defined in src/CruisePlugin/BaseController.ts:85

load

load(serverData, state?, userAction?): Promise<void>
Parameters
- serverData: MoveWithPanoIndexAction | MoveWithKeyframesAction | CruisePluginTypes.PluginServerData
- Optionalstate: CruisePluginTypes.PluginState
- OptionaluserAction: boolean
Returns Promise<void>
Description
Load Data and State
Overrides CruiseController.load
- Defined in src/CruisePlugin/Work.ts:65

pause

pause(options?): void
Parameters
- Optionaloptions: {
  userAction?: boolean;
  }
  - OptionaluserAction?: boolean
Returns void
Description
Pause
Inherited from CruiseController.pause
- Defined in src/CruisePlugin/BaseController.ts:71

play

play(options?): void
Parameters
- Optionaloptions: {
  userAction?: boolean;
  }
  - OptionaluserAction?: 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:64

playFrom

playFrom(options): void
Parameters
- options: {
      id?: string;
      index?: number;
      userAction?: boolean;
  }
  - Optionalid?: string
    play from keyframes id
  - Optionalindex?: number
    play from keyframes index
  - OptionaluserAction?: 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
- Optionaloptions: {
  userAction?: boolean;
  }
  - OptionaluserAction?: 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, {}>
- Optionaloptions: BaseOptions & Record<string, any>
Returns void
Description
Set state
Inherited from CruiseController.setState
- Defined in src/CruisePlugin/BaseController.ts:113

show

show(options?): Promise<void>
Parameters
- Optionaloptions: {
  userAction?: boolean;
  }
  - OptionaluserAction?: boolean
Returns Promise<void>
Description
Show guide line
Inherited from CruiseController.show
- Defined in src/CruisePlugin/BaseController.ts:78

updateFive

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