Class CruisePluginController

constructor

• new CruisePluginController(five, config?): CruisePluginController

• Parameters

  • five: Five

  • Optional config: Config

  Returns CruisePluginController

state

Static PluginVersion

disable

• disable(options?): void

• Description

  Disable

  Parameters

  • Optional options: {
        userAction?: boolean;
    }

    • Optional userAction?: boolean

  Returns void

dispose

• dispose(): void

• Description

  Dispose

  Returns void

enable

• enable(options?): void

• Description

  Enable

  Parameters

  • Optional options: {
        userAction?: boolean;
    }

    • Optional userAction?: boolean

  Returns void

hide

• hide(options?): Promise<void>

• Description

  Hide guide line

  Parameters

  • Optional options: {
        userAction?: boolean;
    }

    • Optional userAction?: boolean

  Returns Promise<void>

load

• load(serverData, state?, userAction?): Promise<void>

• Description

  Load Data and State

  Parameters

  • serverData: MoveWithPanoIndexAction | MoveWithKeyframesAction | CruisePluginTypes.PluginServerData

  • Optional state: CruisePluginTypes.PluginState

  • Optional userAction: boolean

  Returns Promise<void>

pause

• pause(options?): void

• Description

  Pause

  Parameters

  • Optional options: {
        userAction?: boolean;
    }

    • Optional userAction?: boolean

  Returns void

play

• play(options?): void

• Description

  Play | Continue play. if have been paused, continue play from the pause position; if playing, do nothing

  Parameters

  • Optional options: {
        userAction?: boolean;
    }

    • Optional userAction?: boolean

  Returns void

playFrom

• playFrom(options): void

• Description

  If playing, first pause, then play from keyframes index/id

  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

playFromStart

• playFromStart(options?): void

• Description

  Play from first keyframe

  Parameters

  • Optional options: {
        userAction?: boolean;
    }

    • Optional userAction?: boolean

  Returns void

setState

• setState(state, options?): void

• Description

  Set state

  Parameters

  • state: Partial<CruisePluginTypes.PluginState>

  • Optional options: BaseOptions & Record<string, any>

  Returns void

show

• show(options?): Promise<void>

• Description

  Show guide line

  Parameters

  • Optional options: {
        userAction?: boolean;
    }

    • Optional userAction?: boolean

  Returns Promise<void>