Class TrajectoryController

plugin 的基本控制器

Hierarchy (view full)

Controller<PluginTemplateType.State, PluginTemplateType.EventMap, PluginTemplateType.ServerData, PluginTemplateType.PluginData>
- TrajectoryController

Index

Constructors

constructor

new TrajectoryController(five, params?): TrajectoryController
Parameters
- five: Five
- Optionalparams: PluginTemplateType.Params
Returns TrajectoryController
Overrides Controller.constructor
- Defined in lib/plugins/TrajectoryPlugin/Controller.ts:98

Properties

currentKeyFrame

currentKeyFrame: Keyframe

`Optional`data

data?: any

当前使用的数据

five

five: Five

hooks

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

Description

插件事件钩子

keyframes

keyframes: Keyframe[]

location

location: number

nextButOneKeyframe

nextButOneKeyframe: Keyframe

nextKeyframe

nextKeyframe: Keyframe

rate

rate: number

skipEnd

skipEnd: number

skipStart

skipStart: number

state

state: PluginTemplateType.State

插件当前状态

`Readonly`staticPrefix

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

totalDistance

totalDistance: number

trajectory

trajectory: Trajectory

Accessors

config

get config(): {
rate?: number;
}
Returns {
rate?: number;
}
- Optionalrate?: number
- Defined in lib/plugins/TrajectoryPlugin/Controller.ts:71

Methods

absoluteUrl

absoluteUrl(url): string
Parameters
- url: string
Returns string
Description
获取静态资源的url
Inherited from Controller.absoluteUrl
- Defined in lib/plugins/BasePlugin/index.ts:135

`Optional`appendTo

appendTo(wrapper): void
插件自身DOM添加到父容器
Parameters
- wrapper: Element
  Element元素
Returns void
Inherited from Controller.appendTo
- Defined in lib/plugins/BasePlugin/index.ts:113

disable

disable(options?): void
禁用插件，让插件停止响应交互
Parameters
- Optionaloptions: BaseOptions
Returns void
Overrides Controller.disable
- Defined in lib/plugins/TrajectoryPlugin/Controller.ts:367

dispose

dispose(): void
销毁插件，移除所有副作用，销毁后将不响应任何 API

Returns void
Overrides Controller.dispose
- Defined in lib/plugins/TrajectoryPlugin/Controller.ts:375

enable

enable(options?): void
启用插件，让插件能够响应交互
Parameters
- Optionaloptions: BaseOptions
Returns void
Overrides Controller.enable
- Defined in lib/plugins/TrajectoryPlugin/Controller.ts:357

findKeyFrameByLocation

findKeyFrameByLocation(location): number | {
keyframeIndex: number;
progress: number;
}
Parameters
- location: number
Returns number | {
keyframeIndex: number;
progress: number;
}
- Defined in lib/plugins/TrajectoryPlugin/Controller.ts:324

getCurrentState

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

Returns PluginTemplateType.State
Inherited from Controller.getCurrentState
- Defined in lib/plugins/BasePlugin/index.ts:105

`Optional`hide

hide(options?): void | Promise<void>
隐藏UI
Parameters
- Optionaloptions: BaseOptions
Returns void | Promise<void>
Inherited from Controller.hide
- Defined in lib/plugins/BasePlugin/index.ts:123

load

load(data): Promise<void>
加载插件依赖数据
Parameters
- data: PluginTemplateType.ServerData
Returns Promise<void>
Overrides Controller.load
- Defined in lib/plugins/TrajectoryPlugin/Controller.ts:150

loadTrajectory

loadTrajectory(trajectory): void
Parameters
- trajectory: Trajectory
Returns void
- Defined in lib/plugins/TrajectoryPlugin/Controller.ts:154

pause

pause(): void
Returns void
- Defined in lib/plugins/TrajectoryPlugin/Controller.ts:320

play

play(): void
Returns void
- Defined in lib/plugins/TrajectoryPlugin/Controller.ts:219

resetPlayingState

resetPlayingState(): void
Returns void
- Defined in lib/plugins/TrajectoryPlugin/Controller.ts:345

setPlayingState

setPlayingState(playingState): void
Parameters
- playingState: Partial<PlayingState>
Returns void
- Defined in lib/plugins/TrajectoryPlugin/Controller.ts:206

`Optional`setState

setState(state, options?): void
设置state
Parameters
- state: Partial<PluginTemplateType.State>
  插件的目标状态
- Optionaloptions: BaseOptions
  配置项
Returns void
Inherited from Controller.setState
- Defined in lib/plugins/BasePlugin/index.ts:130

`Optional`show

show(options?): void | Promise<void>
展示UI
Parameters
- Optionaloptions: BaseOptions
Returns void | Promise<void>
Inherited from Controller.show
- Defined in lib/plugins/BasePlugin/index.ts:118