Class OrbitControl

使用Three.js OrbitControls实现的场景控制器

Hierarchy

Controller
- OrbitControl

Index

Constructors

constructor

Properties

Constructors

constructor

new OrbitControl(view: View): OrbitControl

Overrides Controller.constructor
- Defined in src/owlly/controller/orbit-control.ts:22
Parameters
- view: View
  
  需要绑定的View
Returns OrbitControl

Properties

controls

controls: OrbitControls

Protected eventMap

eventMap: Map<string, Set<Function>>

Protected renderFrame

renderFrame: boolean | undefined

Methods

Optional bindElement

bindElement(element: Element | Element[]): void

Inherited from Controller.bindElement
- Defined in src/owlly/controller/controller.ts:58
绑定元素到当前控制器

Parameters
- element: Element | Element[]
  
  需要绑定的元素或元素数组
Returns void

bindView

bindView(view: View): void

Overrides Controller.bindView
- Defined in src/owlly/controller/orbit-control.ts:45
绑定视图

Parameters
- view: View
  
  需要绑定的View
Returns void

dispose

dispose(): void

Inherited from Controller.dispose
- Defined in src/owlly/controller/controller.ts:34
Returns void

Protected emit

emit(event: string, ...args: unknown[]): void

Inherited from EventHubClassic.emit
- Defined in src/owlly/utils/event-hub.ts:100
Parameters
- event: string
- Rest ...args: unknown[]
Returns void

getCameraRotation

getCameraRotation(): number

- Defined in src/owlly/controller/orbit-control.ts:254
获得相机旋转

Returns number

当前相机的旋转, 单位为弧度

getZoom

getZoom(): number | null

- Defined in src/owlly/controller/orbit-control.ts:226
获取相机缩放

Returns number | null

Optional initWithScene

initWithScene(scene: Scene): void

Inherited from Controller.initWithScene
- Defined in src/owlly/controller/controller.ts:68
对于需要Scene的controller, 初始化时会传递scene

Parameters
- scene: Scene
  
  传入的Scene
Returns void

off

off(event: string, callback: Function): void

Inherited from EventHubClassic.off
- Defined in src/owlly/utils/event-hub.ts:113
注销事件监听

Parameters
- event: string
  
  事件名
- callback: Function
  
  回调函数
Returns void

on

on(event: string, callback: Function): void

Inherited from EventHubClassic.on
- Defined in src/owlly/utils/event-hub.ts:88
注册事件监听

Parameters
- event: string
  
  事件名
- callback: Function
  
  回调函数
Returns void

Protected renderThisFrame

renderThisFrame(): void

- Defined in src/owlly/controller/orbit-control.ts:35
Returns void

Optional renderingViewChanged

renderingViewChanged(view: View): void

Inherited from Controller.renderingViewChanged
- Defined in src/owlly/controller/controller.ts:73
对于需要根据View变化的Controller, 使用该钩子函数进行处理

Parameters
- view: View
  
  当前view
Returns void

setAzimuthAngle

setAzimuthAngle(min: number, max: number): void

- Defined in src/owlly/controller/orbit-control.ts:218
设置横向转动范围, 最低为-Math.PI, 最高为Math.PI

Parameters
- min: number
  
  横向转动范围最小值
- max: number
  
  横向转动范围最大值
Returns void

setCameraRotation

setCameraRotation(radius: number): void

- Defined in src/owlly/controller/orbit-control.ts:262
设置相机的旋转

Parameters
- radius: number
  
  目标弧度
Returns void

setCameraWorldMatrix

setCameraWorldMatrix(worldMatrix: number[]): void

- Defined in src/owlly/controller/orbit-control.ts:275
设置相机姿态

Parameters
- worldMatrix: number[]
  
  相机的姿态矩阵
Returns void

setDampingEnabled

setDampingEnabled(value: boolean): void

- Defined in src/owlly/controller/orbit-control.ts:110
设置是否启用惯性

Parameters
- value: boolean
  
  开关值
Returns void

setDampingFactor

setDampingFactor(value: number): void

- Defined in src/owlly/controller/orbit-control.ts:160
设置惯性阻尼

Parameters
- value: number
  
  衰减值
Returns void

setEnabled

setEnabled(value: boolean): void

- Defined in src/owlly/controller/orbit-control.ts:150
设置是否启用该控制器

Parameters
- value: boolean
  
  开关值
Returns void

setKeysEnabled

setKeysEnabled(value: boolean): void

- Defined in src/owlly/controller/orbit-control.ts:102
设置键盘控制启用

Parameters
- value: boolean
  
  是否启用键盘控制
Returns void

setMouseControls

setMouseControls(mouseButtons: object): void

- Defined in src/owlly/controller/orbit-control.ts:176
设置鼠标操作模式

Parameters
- mouseButtons: object
  
  鼠标按键配置
  - LEFT: MOUSE
  - MIDDLE: MOUSE
  - RIGHT: MOUSE
Returns void

setPanEnabled

setPanEnabled(value: boolean): void

- Defined in src/owlly/controller/orbit-control.ts:134
设置是否启用平移功能

Parameters
- value: boolean
  
  开关值
Returns void

setPanSpeed

setPanSpeed(value: number): void

- Defined in src/owlly/controller/orbit-control.ts:118
设置位移速度

Parameters
- value: number
  
  位移速度
Returns void

setPolarAngle

setPolarAngle(min: number, max: number): void

- Defined in src/owlly/controller/orbit-control.ts:198
设置纵向转动范围, 最低为0, 最高为Math.PI

Parameters
- min: number
  
  纵向转动范围最小值
- max: number
  
  纵向转动范围最大值
Returns void

setPosition

setPosition(x: number, y: number): void

- Defined in src/owlly/controller/orbit-control.ts:90
设置视图中心点位

Parameters
- x: number
  
  x
- y: number
  
  y
Returns void

setPositionRange

setPositionRange(min: Vector3, max: Vector3): void

- Defined in src/owlly/controller/orbit-control.ts:304
Parameters
- min: Vector3
- max: Vector3
Returns void

setRotateEnabled

setRotateEnabled(value: boolean): void

- Defined in src/owlly/controller/orbit-control.ts:126
设置是否启用旋转功能

Parameters
- value: boolean
  
  开关值
Returns void

setRotateSpeed

setRotateSpeed(speed?: number): void

- Defined in src/owlly/controller/orbit-control.ts:299
设置旋转速度

Parameters
- Default value speed: number = 1
  
  速度, 默认为1, 不传值时为重置为默认值
Returns void

setTarget

setTarget(x: number, y: number, z: number): void

- Defined in src/owlly/controller/orbit-control.ts:188
设置控制中心点

Parameters
- x: number
  
  世界坐标X
- y: number
  
  世界坐标Y
- z: number
  
  世界坐标Z
Returns void

setTouchControls

setTouchControls(touches: object): void

- Defined in src/owlly/controller/orbit-control.ts:168
设置触摸操作模式

Parameters
- touches: object
  
  触摸配置
  - ONE: TOUCH
  - TWO: TOUCH
Returns void

setZoom

setZoom(zoom: number): void

- Defined in src/owlly/controller/orbit-control.ts:239
设置相机缩放

Parameters
- zoom: number
  
  目标缩放值
Returns void

setZoomEnabled

setZoomEnabled(value: boolean): void

- Defined in src/owlly/controller/orbit-control.ts:142
设置是否启用缩放功能

Parameters
- value: boolean
  
  开关值
Returns void

setZoomRange

setZoomRange(min: number, max: number): void

- Defined in src/owlly/controller/orbit-control.ts:208
设置zoom范围

Parameters
- min: number
  
  zoom最小值
- max: number
  
  zoom最大值
Returns void

unbind

unbind(): void

Overrides Controller.unbind
- Defined in src/owlly/controller/orbit-control.ts:72
Returns void

Optional unbindElement

unbindElement(element: Element | Element[]): void

Inherited from Controller.unbindElement
- Defined in src/owlly/controller/controller.ts:63
将目标元素解除绑定, 解除绑定的元素将不再被该控制器所管理

Parameters
- element: Element | Element[]
  
  需要解绑的元素或元素数组
Returns void

unbindView

unbindView(): void

Inherited from Controller.unbindView
- Defined in src/owlly/controller/controller.ts:49
解除当前绑定的视图

Returns void