Class OrbitCameraInput_Mouse

观测相机鼠标输入

Hierarchy

Tool<OrbitCameraInputOption, any>
- OrbitCameraInput_Mouse

Index

Constructors

Constructors

constructor

new OrbitCameraInput_Mouse(options: OrbitCameraInputOption): OrbitCameraInput_Mouse
Parameters
- options: OrbitCameraInputOption
Returns OrbitCameraInput_Mouse
Overrides Tool.constructor
- Defined in src/tools/camera/orbitCamera.ts:442

Properties

app

app: AppBase

`Private` fromWorldPoint

fromWorldPoint: Vec3

`Private` isLookButtonDown

isLookButtonDown: boolean

`Private` isPanButtonDown

isPanButtonDown: boolean

`Private` isRotateButtonDown

isRotateButtonDown: boolean

`Private` lastPoint

lastPoint: Vec2

`Private` toWorldPoint

toWorldPoint: Vec3

toolOptions

toolOptions: OrbitCameraInputOption

`Protected` toolOptionsDefault

toolOptionsDefault: OrbitCameraInputOption = ...

`Private` worldDiff

worldDiff: Vec3

Accessors

enabled

get enabled(): boolean
获得工具的启用状态

Returns boolean
Inherited from Tool.enabled
- Defined in src/utils/helpers/toolBase.ts:43
set enabled(value: boolean): void
设置工具启用状态（触发启用和禁用时的额外操作）
Parameters
- value: boolean
Returns void
Inherited from Tool.enabled
- Defined in src/utils/helpers/toolBase.ts:34

Methods

`Protected` fire

fire<EventName>(eventName: EventName, arg1?: any, arg2?: any, arg3?: any, arg4?: any, arg5?: any, arg6?: any, arg7?: any, arg8?: any): EventHandler
手动触发事件

Returns
EventHandler
Type Parameters
- EventName extends string | number | symbol
Parameters
- eventName: EventName
  
  事件名称
- Optional arg1: any
  
  参数1
- Optional arg2: any
  
  参数2
- Optional arg3: any
  
  参数3
- Optional arg4: any
  
  参数4
- Optional arg5: any
  
  参数5
- Optional arg6: any
  
  参数6
- Optional arg7: any
  
  参数7
- Optional arg8: any
  
  参数8
Returns EventHandler
Inherited from Tool.fire
- Defined in src/utils/helpers/toolBase.ts:128

hasEvent

hasEvent<EventName>(eventName: EventName): boolean
检测是否监听此事件

Returns
是否监听此事件
Type Parameters
- EventName extends string | number | symbol
Parameters
- eventName: EventName
  
  事件名称
Returns boolean
Inherited from Tool.hasEvent
- Defined in src/utils/helpers/toolBase.ts:111

off

off<EventName>(eventName: EventName, linstener: any, scope?: object): EventHandler
注销事件监听

Returns
EventHandler
Type Parameters
- EventName extends string | number | symbol
Parameters
- eventName: EventName
  
  事件名称
- linstener: any
  
  监听回调
- Optional scope: object
  
  回调函数this指向
Returns EventHandler
Inherited from Tool.off
- Defined in src/utils/helpers/toolBase.ts:102

on

on<EventName>(eventName: EventName, linstener: any, scope?: object): EventHandler
注册事件监听

Returns
EventHandler
Type Parameters
- EventName extends string | number | symbol
Parameters
- eventName: EventName
  
  事件名称
- linstener: any
  
  监听回调
- Optional scope: object
  
  回调函数this指向
Returns EventHandler
Inherited from Tool.on
- Defined in src/utils/helpers/toolBase.ts:80

`Protected` onDisable

onDisable(): void
Returns void
Overrides Tool.onDisable
- Defined in src/tools/camera/orbitCamera.ts:566

`Protected` onEnable

onEnable(): void
Returns void
Overrides Tool.onEnable
- Defined in src/tools/camera/orbitCamera.ts:558

`Private` onMouseDown

onMouseDown(event: MouseEvent$1): void
鼠标按下事件监听
Parameters
- event: MouseEvent$1
  
  鼠标按下事件
Returns void
- Defined in src/tools/camera/orbitCamera.ts:463

`Private` onMouseMove

onMouseMove(event: MouseEvent): void
鼠标移动事件监听
Parameters
- event: MouseEvent
  
  鼠标移动事件
Returns void
- Defined in src/tools/camera/orbitCamera.ts:493

`Private` onMouseUp

onMouseUp(event: MouseEvent): void
鼠标抬起事件监听
Parameters
- event: MouseEvent
  
  鼠标抬起事件
Returns void
- Defined in src/tools/camera/orbitCamera.ts:511

`Private` onMouseWheel

onMouseWheel(event: MouseEvent$1): void
鼠标滚轮事件监听
Parameters
- event: MouseEvent$1
  
  鼠标滚轮事件
Returns void
- Defined in src/tools/camera/orbitCamera.ts:535

once

once<EventName>(eventName: EventName, linstener: any, scope?: object): EventHandler
注册单次事件监听

Returns
EventHandler
Type Parameters
- EventName extends string | number | symbol
Parameters
- eventName: EventName
  
  事件名称
- linstener: any
  
  监听回调
- Optional scope: object
  
  回调函数this指向
Returns EventHandler
Inherited from Tool.once
- Defined in src/utils/helpers/toolBase.ts:91

`Private` pan

pan(event: { x: number; y: number }): void
移动鼠标时平移相机视角
Parameters
- event: { x: number; y: number }
  
  鼠标移动事件
  - x: number
  - y: number
Returns void
- Defined in src/tools/camera/orbitCamera.ts:548

setOptions

setOptions(options: OrbitCameraInputOption): void
设置选项
Parameters
- options: OrbitCameraInputOption
  
  选项
Returns void
Inherited from Tool.setOptions
- Defined in src/utils/helpers/toolBase.ts:52

updateOptions

updateOptions(options: { distanceSensitivity?: number; orbitCamera?: OrbitCamera; orbitSensitivity?: number }): void
更新选项
Parameters
- options: { distanceSensitivity?: number; orbitCamera?: OrbitCamera; orbitSensitivity?: number }
  
  选项
  - Optional distanceSensitivity?: number
  - Optional orbitCamera?: OrbitCamera
  - Optional orbitSensitivity?: number
Returns void
Inherited from Tool.updateOptions
- Defined in src/utils/helpers/toolBase.ts:65

Class OrbitCameraInput_Mouse

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: OrbitCameraInputOption

Returns OrbitCameraInput_Mouse

Properties

app

Private fromWorldPoint

Private isLookButtonDown

Private isPanButtonDown

Private isRotateButtonDown

Private lastPoint

Private toWorldPoint

toolOptions

Protected toolOptionsDefault

Private worldDiff

Accessors

enabled

Returns boolean

Parameters

value: boolean

Returns void

Methods

Protected fire

Returns

Type Parameters

EventName extends string | number | symbol

Parameters

eventName: EventName

Optional arg1: any

Optional arg2: any

Optional arg3: any

Optional arg4: any

Optional arg5: any

Optional arg6: any

Optional arg7: any

Optional arg8: any

Returns EventHandler

hasEvent

Returns

Type Parameters

EventName extends string | number | symbol

Parameters

eventName: EventName

Returns boolean

off

Returns

Type Parameters

EventName extends string | number | symbol

Parameters

eventName: EventName

linstener: any

Optional scope: object

Returns EventHandler

on

Returns

Type Parameters

EventName extends string | number | symbol

Parameters

eventName: EventName

linstener: any

Optional scope: object

Returns EventHandler

Protected onDisable

Returns void

Protected onEnable

Returns void

Private onMouseDown

Parameters

event: MouseEvent$1

Returns void

Private onMouseMove

Parameters

`Private` fromWorldPoint

`Private` isLookButtonDown

`Private` isPanButtonDown

`Private` isRotateButtonDown

`Private` lastPoint

`Private` toWorldPoint

`Protected` toolOptionsDefault

`Private` worldDiff

`Protected` fire

`Optional` arg1: any

`Optional` arg2: any

`Optional` arg3: any

`Optional` arg4: any

`Optional` arg5: any

`Optional` arg6: any

`Optional` arg7: any

`Optional` arg8: any

`Optional` scope: object

`Optional` scope: object

`Protected` onDisable

`Protected` onEnable

`Private` onMouseDown

`Private` onMouseMove

`Private` onMouseUp

`Private` onMouseWheel

`Optional` scope: object

`Private` pan

`Optional` distanceSensitivity?: number

`Optional` orbitCamera?: OrbitCamera

`Optional` orbitSensitivity?: number