Class OrientationPluginController

plugin 的基本控制器

Hierarchy (view full)

Controller<OrientationPluginType.State, OrientationPluginType.EventMap, OrientationPluginType.ServerData, OrientationPluginType.PluginData>
- OrientationPluginController

Index

Constructors

Properties

ambientLight box camera controls? css3drenderer data? directionalLight faces five hooks renderer scene state staticPrefix wrapper

Accessors

Methods

absoluteUrl appendTo bindEvents disable dispose enable getCurrentState hide? init initDom load orient setState show? unbindEvents

Constructors

constructor

new OrientationPluginController(five, params?): OrientationPluginController
Parameters
- five: Five
- Optionalparams: OrientationPluginType.Params
Returns OrientationPluginController
Overrides Controller.constructor
- Defined in lib/plugins/OrientationPlugin/Controller.ts:123

Properties

ambientLight

ambientLight: AmbientLight = ...

box

box: Mesh<RoundedBoxGeometry, MeshPhongMaterial> = ...

camera

camera: Camera = ...

`Optional`controls

controls?: OrbitControls

css3drenderer

css3drenderer: CSS3DRenderer = ...

`Optional`data

data?: any

当前使用的数据

directionalLight

directionalLight: DirectionalLight = ...

faces

faces: Group = ...

five

five: Five

hooks

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

Description

插件事件钩子

renderer

renderer: WebGLRenderer = ...

scene

scene: Scene = ...

state

state: OrientationPluginType.State

插件当前状态

`Readonly`staticPrefix

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

wrapper

wrapper: HTMLDivElement = ...

Accessors

config

get config(): {
fixedLongitude: number;
orthoView: boolean;
}
Returns {
fixedLongitude: number;
orthoView: boolean;
}
- fixedLongitude: number
- orthoView: boolean
- Defined in lib/plugins/OrientationPlugin/Controller.ts:111

Methods

absoluteUrl

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

appendTo

appendTo(container): void
插件自身DOM添加到父容器
Parameters
- container: HTMLElement
Returns void
Overrides Controller.appendTo
- Defined in lib/plugins/OrientationPlugin/Controller.ts:202

bindEvents

bindEvents(): void
Returns void
- Defined in lib/plugins/OrientationPlugin/Controller.ts:365

disable

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

dispose

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

Returns void
Overrides Controller.dispose
- Defined in lib/plugins/OrientationPlugin/Controller.ts:718

enable

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

getCurrentState

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

Returns OrientationPluginType.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

init

init(): void
Returns void
- Defined in lib/plugins/OrientationPlugin/Controller.ts:210

initDom

initDom(): void
Returns void
- Defined in lib/plugins/OrientationPlugin/Controller.ts:243

load

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

orient

orient(__namedParameters): void
Parameters
- __namedParameters: {
  latitude?: number;
  longitude?: number;
  }
  - Optionallatitude?: number
  - Optionallongitude?: number
Returns void
- Defined in lib/plugins/OrientationPlugin/Controller.ts:397

setState

setState(state, options?): void
更改插件 State
Parameters
- state: Partial<OrientationPluginType.State>
- options: BaseOptions = {}
Returns void
Overrides Controller.setState
- Defined in lib/plugins/OrientationPlugin/Controller.ts:599

`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

unbindEvents

unbindEvents(): void
Returns void
- Defined in lib/plugins/OrientationPlugin/Controller.ts:381