Class OrbitControl

Orbit相机控制器

Export

Date

2022.3.25

Author

lyx

Hierarchy

Script
- OrbitControl

Index

Constructors

constructor

Accessors

enabled engine entity panModifierKey rotateModifierKey started target

Constructors

constructor

new OrbitControl(entity, parameters?): OrbitControl
Parameters
- entity: Entity
- parameters: OrbitControlParameters = {}
Returns OrbitControl

Overrides Script.constructor

Properties

`Protected` _engine

_engine: Engine

`Protected` _entity

_entity: Entity

`Protected` _started

_started: boolean = false

dampingFactor

dampingFactor: number = 0.05

阻尼浏览系数

Memberof

OrbitControl

downRotateKey

downRotateKey: string = 's'

键盘下旋转辅助键

Memberof

OrbitControl

enableDamping

enableDamping: boolean = false

是否启用阻尼浏览

Memberof

OrbitControl

enableDblClick

enableDblClick: boolean = true

标识是否启用鼠标双击操作

Memberof

OrbitControl

enableKeyControl

enableKeyControl: boolean = true

启用键盘控制，默认true开启

Memberof

OrbitControl

`Readonly` isScript

isScript: boolean = true

脚本组件标识

Memberof

Script

keyPanSpeed

keyPanSpeed: number = 7.0

每次按下移动键移动的像素

Memberof

OrbitControl

leftRotateKey

leftRotateKey: string = 'a'

键盘左转辅助键

Memberof

OrbitControl

maxAzimuthAngle

maxAzimuthAngle: number = Infinity

水平方向旋转最大角度（单位：弧度）

Memberof

OrbitControl

maxDistance

maxDistance: number = Infinity

最远缩放距离

Memberof

OrbitControl

maxPolarAngle

maxPolarAngle: number = Math.PI

垂直方向旋转最大角度（单位：弧度）

Memberof

OrbitControl

minAzimuthAngle

minAzimuthAngle: number = -Infinity

水平方向旋转最小角度（单位：弧度）

Memberof

OrbitControl

minDistance

minDistance: number = 0

Memberof

OrbitControl

minPolarAngle

minPolarAngle: number = 0

垂直方向旋转最小角度（单位：弧度）

Memberof

OrbitControl

panButton

panButton: MouseButton = MouseButton.RIGHT

鼠标平移按键

Memberof

OrbitControl

panDownKey

panDownKey: string = 'arrowdown'

键盘后平移键

Memberof

OrbitControl

panLeftKey

panLeftKey: string = 'arrowleft'

键盘左平移键

Memberof

OrbitControl

panRightKey

panRightKey: string = 'arrowright'

键盘右平移键

Memberof

OrbitControl

panSpeed

panSpeed: number = 1.0

平移速度

Memberof

OrbitControl

panUpKey

panUpKey: string = 'arrowup'

键盘前平移键

Memberof

OrbitControl

rightRotateKey

rightRotateKey: string = 'd'

键盘右转辅助键

Memberof

OrbitControl

rotateButton

rotateButton: MouseButton = MouseButton.LEFT

鼠标旋转按键

Memberof

OrbitControl

rotateSpeed

rotateSpeed: number = 1.0

旋转速度

Memberof

OrbitControl

screenSpacePanning

screenSpacePanning: boolean = false

是否在屏幕空间进行平移

Memberof

OrbitControl

speedUpKey

speedUpKey: string = 'shift'

键盘加速键，默认'shift'

Memberof

OrbitControl

speedUpKeyScale

speedUpKeyScale: number = 2.5

速度辅助键加速的速度值，默认2.5倍初始速度

Memberof

OrbitControl

touchOne

touchOne: Touch = Touch.ROTATE

一根手指触摸操作

Memberof

OrbitControl

touchTwo

touchTwo: Touch = Touch.ZOOM_PAN

两个手指触摸操作

Memberof

OrbitControl

upRotateKey

upRotateKey: string = 'w'

键盘上旋转辅助键

Memberof

OrbitControl

userData

userData: {
[key: string]: any;
} = {}

用户数据

Type declaration

[key: string]: any

Memberof

Component

zoomSpeed

zoomSpeed: number = 1.0

缩放速度

Memberof

OrbitControl

zoomThreshold

zoomThreshold: number = 2.0

缩放距离阈值用于控制触摸缩放

Memberof

OrbitControl

Accessors

enabled

get enabled(): boolean
获取组件是否启用

Returns boolean

Memberof
Component

Inherited from Script.enabled
set enabled(value): void
启用或禁用组件
Parameters
- value: boolean
Returns void

Memberof
Component

Inherited from Script.enabled

engine

get engine(): Engine
获取引擎对象

Returns Engine

Memberof
EngineObject

Inherited from Script.engine

entity

get entity(): Entity
获取组件所属实体

Returns Entity

Memberof
Component

Inherited from Script.entity

panModifierKey

get panModifierKey(): string
获取鼠标平移辅助按键

Returns string

Memberof
OrbitControl
set panModifierKey(value): void
设置鼠标平移辅助按键
Parameters
- value: string
Returns void

Memberof
OrbitControl

rotateModifierKey

get rotateModifierKey(): string
获取鼠标旋转辅助按键

Returns string

Memberof
OrbitControl
set rotateModifierKey(value): void
设置鼠标旋转辅助按键
Parameters
- value: string
Returns void

Memberof
OrbitControl

started

get started(): boolean
获取脚本是否已启用

Returns boolean

Memberof
Script

Inherited from Script.started

target

get target(): Readonly<Vector3>
Returns Readonly<Vector3>

Methods

`Protected` _onAwake

_onAwake(): void
Protected
唤醒脚本

Returns void

Memberof
Script

Inherited from Script._onAwake

`Protected` _onDestroy

_onDestroy(): void
Protected
销毁脚本

Returns void

Memberof
Script

Inherited from Script._onDestroy

`Protected` _onDisable

_onDisable(): void
Protected
禁用脚本

Returns void

Memberof
Script

Inherited from Script._onDisable

`Protected` _onEnable

_onEnable(): void
Protected
启用脚本

Returns void

Memberof
Script

Inherited from Script._onEnable

addEventListener

addEventListener(type, callback, parameters?): number
添加事件监听器
Parameters
- type: string
  
  事件类型（不区分大小写）
- callback: ((event) => void)
  
  事件监听回调
  - - (event): void
    - Parameters
      
      event: {
      type: string;
      [key: string]: any;
      }
      
      [key: string]: any
      
      type: string
      
      Returns void
- Optional parameters: {
  priority?: Priority;
  target?: any;
  } = {}
  
  事件参数
  - Optional priority?: Priority
  - Optional target?: any
Returns number

Memberof
EventDispatcher

Inherited from Script.addEventListener

destroy

destroy(): void
销毁组件

Returns void

Memberof
Component

Inherited from Script.destroy

dispatchEvent

dispatchEvent(event): void
分发事件
Parameters
- event: {
  type: string;
  [key: string]: any;
  }
  - [key: string]: any
  - type: string
Returns void

Memberof
EventDispatcher

Inherited from Script.dispatchEvent

dispose

dispose(): void
释放接口

Returns void

Memberof
EventDispatcher

Inherited from Script.dispose

onAwake

onAwake(): void
脚本唤醒回调（首次启用脚本时调用且只会被调用一次）

Returns void

Memberof
Script

Inherited from Script.onAwake

onCameraChanged

onCameraChanged(event): void
‘camerachanged’事件回调
Parameters
- event: any
Returns void

Memberof
Script

Inherited from Script.onCameraChanged

onClick

onClick(event): void
‘click’事件回调
Parameters
- event: MouseEvent
Returns void

Memberof
Script

Inherited from Script.onClick

onCollisionEnter

onCollisionEnter(collision): void
进入碰撞器响应
Parameters
- collision: Collision
  
  碰撞信息
Returns void

Memberof
Script

Inherited from Script.onCollisionEnter

onCollisionExit

onCollisionExit(collision): void
离开碰撞器响应
Parameters
- collision: Collision
  
  碰撞信息
Returns void

Memberof
Script

Inherited from Script.onCollisionExit

onCollisionStay

onCollisionStay(collision): void
逗留在碰撞器中响应
Parameters
- collision: Collision
  
  碰撞信息
Returns void

Memberof
Script

Inherited from Script.onCollisionStay

onDblClick

onDblClick(event): void
响应‘dblclick’事件
Parameters
- event: MouseEvent
Returns void

Memberof
OrbitControl

Overrides Script.onDblClick

onDestroy

onDestroy(): void
销毁控制器

Returns void

Memberof
OrbitControl

Overrides Script.onDestroy

onDisable

onDisable(): void
禁用控制器

Returns void

Memberof
OrbitControl

Overrides Script.onDisable

onEnable

onEnable(): void
启用控制器

Returns void

Memberof
OrbitControl

Overrides Script.onEnable

onKeyDown

onKeyDown(event): void
响应‘keydown’事件
Parameters
- event: KeyboardEvent
Returns void

Memberof
OrbitControl

Overrides Script.onKeyDown

onKeyUp

onKeyUp(event): void
响应‘keyup’事件
Parameters
- event: KeyboardEvent
Returns void

Memberof
OrbitControl

Overrides Script.onKeyUp

onLateUpdate

onLateUpdate(timeSinceLastFrame, totalTime): void
更新控制器
Parameters
- timeSinceLastFrame: number
- totalTime: number
Returns void

Memberof
OrbitControl

Overrides Script.onLateUpdate

onPhysicsUpdate

onPhysicsUpdate(): void
物理更新回调，每一帧可以调用多次

Returns void

Memberof
Script

Inherited from Script.onPhysicsUpdate

onPointerCancel

onPointerCancel(event): void
响应‘pointercancel’
Parameters
- event: PointerEvent
Returns void

Memberof
OrbitControl

Overrides Script.onPointerCancel

onPointerDown

onPointerDown(event): void
响应‘pointerdown’事件
Parameters
- event: PointerEvent
Returns void

Memberof
OrbitControl

Overrides Script.onPointerDown

onPointerMove

onPointerMove(event): void
响应‘pointermove’事件
Parameters
- event: PointerEvent
Returns void

Memberof
OrbitControl

Overrides Script.onPointerMove

onPointerUp

onPointerUp(event): void
响应‘pointerup’事件
Parameters
- event: PointerEvent
Returns void

Memberof
OrbitControl

Overrides Script.onPointerUp

onResize

onResize(event): void
‘resize’事件回调
Parameters
- event: any
Returns void

Memberof
Script

Inherited from Script.onResize

onStart

onStart(): void
脚本开始执行回调（在首次帧循环时调用且只会被调用一次）

Returns void

Memberof
Script

Inherited from Script.onStart

onTriggerEnter

onTriggerEnter(collision): void
进入触发器响应
Parameters
- collision: Collision
  
  碰撞信息
Returns void

Memberof
Script

Inherited from Script.onTriggerEnter

onTriggerExit

onTriggerExit(collision): void
离开触发器响应
Parameters
- collision: Collision
  
  碰撞信息
Returns void

Memberof
Script

Inherited from Script.onTriggerExit

onTriggerStay

onTriggerStay(collision): void
逗留在触发器中响应
Parameters
- collision: Collision
  
  碰撞信息
Returns void

Memberof
Script

Inherited from Script.onTriggerStay

onUpdate

onUpdate(timeSinceLastFrame, totalTime): void
脚本更新回调（逐帧调用）
Parameters
- timeSinceLastFrame: number
  
  距离上一帧更新的时长（单位：毫秒）
- totalTime: number
  
  总时长 (单位：毫秒)
Returns void

Memberof
Script

Inherited from Script.onUpdate

onWheel

onWheel(event): void
响应‘wheel’事件
Parameters
- event: WheelEvent
Returns void

Memberof
OrbitControl

Overrides Script.onWheel

postRenderDepth

postRenderDepth(event): void
‘postrenderdepth’事件回调
Parameters
- event: any
Returns void

Memberof
Script

Inherited from Script.postRenderDepth

preRenderDepth

preRenderDepth(event): void
‘prerenderdepth’事件回调
Parameters
- event: any
Returns void

Memberof
Script

Inherited from Script.preRenderDepth

removeAllEventListeners

removeAllEventListeners(): void
移除所有事件监听器

Returns void

Memberof
EventDispatcher

Inherited from Script.removeAllEventListeners

removeEventListener

removeEventListener(type, callback?): void
移除事件监听器
Parameters
- type: string
  
  事件类型（不区分大小写）
- Optional callback: ((event) => void)
  
  事件监听回调（可选，不设置则表示移除所有监听器）
  - - (event): void
    - Parameters
      
      event: {
      type: string;
      [key: string]: any;
      }
      
      [key: string]: any
      
      type: string
      
      Returns void
Returns void

Memberof
EventDispatcher

Inherited from Script.removeEventListener

removeEventListenerByEventId

removeEventListenerByEventId(eventID): void
通过事件Id移除事件监听器
Parameters
- eventID: number
Returns void

Memberof
EventDispatcher

Inherited from Script.removeEventListenerByEventId

setActive

setActive(value): void
激活或冻结组件
Parameters
- value: boolean
Returns void

Memberof
Component

Inherited from Script.setActive

updateProperties

updateProperties(parameters): Promise<void>
批量更新组件属性
Parameters
- parameters: {
  [key: string]: any;
  }
  - [key: string]: any
Returns Promise<void>

Memberof
Component

Inherited from Script.updateProperties

Class OrbitControl

Export

Date

Author

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

entity: Entity

parameters: OrbitControlParameters = {}

Returns OrbitControl

Properties

Protected _engine

Protected _entity

Protected _started

dampingFactor

Memberof

downRotateKey

Memberof

enableDamping

Memberof

enableDblClick

Memberof

enableKeyControl

Memberof

Readonly isScript

Memberof

keyPanSpeed

Memberof

leftRotateKey

Memberof

maxAzimuthAngle

Memberof

maxDistance

Memberof

maxPolarAngle

Memberof

minAzimuthAngle

Memberof

minDistance

Memberof

minPolarAngle

Memberof

panButton

Memberof

panDownKey

Memberof

panLeftKey

Memberof

panRightKey

Memberof

panSpeed

Memberof

panUpKey

Memberof

rightRotateKey

Memberof

rotateButton

Memberof

rotateSpeed

Memberof

screenSpacePanning

Memberof

speedUpKey

Memberof

speedUpKeyScale

Memberof

touchOne

Memberof

touchTwo

Memberof

upRotateKey

Memberof

userData

Type declaration

`Protected` _engine

`Protected` _entity

`Protected` _started

`Readonly` isScript

`Protected` _onAwake

`Protected` _onDestroy

`Protected` _onDisable

`Protected` _onEnable

event: {
type: string;
[key: string]: any;
}

`Optional` parameters: {
priority?: Priority;
target?: any;
} = {}

`Optional` priority?: Priority

`Optional` target?: any