Class OrbitCamera

Hierarchy

Tool<OrbitCameraOptions, any>
- OrbitCamera

Index

Constructors

constructor

new OrbitCamera(options?: OrbitCameraOptions): OrbitCamera
创建观测相机
Parameters
- Optional options: OrbitCameraOptions
  
  观测相机选项
Returns OrbitCamera
Overrides Tool.constructor
- Defined in src/tools/camera/orbitCamera.ts:94

Properties

`Private` _distance

_distance: number

`Private` _pitch

_pitch: number

`Private` _pivotPoint

_pivotPoint: Vec3

`Private` _yaw

_yaw: number

app

app: AppBase

`Private` cameraForward

cameraForward: Vec3

`Private` inputHandler

inputHandler: AvailableInputHandler

isLooking

isLooking: boolean

isPaning

isPaning: boolean

isRotating

isRotating: boolean

`Private` modelsAABB

modelsAABB: BoundingBox

`Private` quatWithoutYaw

quatWithoutYaw: Quat

`Private` targetDistance

targetDistance: number

`Private` targetPitch

targetPitch: number

`Private` targetYaw

targetYaw: number

toolOptions

toolOptions: OrbitCameraOptions

`Protected` toolOptionsDefault

toolOptionsDefault: OrbitCameraOptions = ...

`Private` yawOffset

yawOffset: Quat

Accessors

device

get device(): AvailableDevices
输入设备

Returns AvailableDevices
- Defined in src/tools/camera/orbitCamera.ts:179
set device(value: AvailableDevices): void
Parameters
- value: AvailableDevices
Returns void
- Defined in src/tools/camera/orbitCamera.ts:183

distance

get distance(): number
离焦点的距离

Returns number
- Defined in src/tools/camera/orbitCamera.ts:155
set distance(value: number): void
Parameters
- value: number
Returns void
- Defined in src/tools/camera/orbitCamera.ts:159

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

pitch

get pitch(): number
俯视角

Returns number
- Defined in src/tools/camera/orbitCamera.ts:143
set pitch(value: number): void
Parameters
- value: number
Returns void
- Defined in src/tools/camera/orbitCamera.ts:147

pivotPoint

get pivotPoint(): Vec3
焦点坐标

Returns Vec3
- Defined in src/tools/camera/orbitCamera.ts:167
set pivotPoint(value: Vec3): void
Parameters
- value: Vec3
Returns void
- Defined in src/tools/camera/orbitCamera.ts:171

yaw

get yaw(): number
航向角

Returns number
- Defined in src/tools/camera/orbitCamera.ts:121
set yaw(value: number): void
Parameters
- value: number
Returns void
- Defined in src/tools/camera/orbitCamera.ts:125

Methods

`Private` buildAABB

buildAABB(entity: Entity | GraphNode | (Entity | GraphNode)[], modelsAdded: number): number
构建AABB

Returns
模型添加的数量
Parameters
- entity: Entity | GraphNode | (Entity | GraphNode)[]
  
  选中模型
- modelsAdded: number
  
  已添加模型数量
Returns number
- Defined in src/tools/camera/orbitCamera.ts:302

`Private` calcPitch

calcPitch(quat: Quat, yaw: number): number
根据旋转和航向角获得俯视角

Returns
俯视角
Parameters
- quat: Quat
  
  旋转
- yaw: number
  
  航向角
Returns number
- Defined in src/tools/camera/orbitCamera.ts:370

`Private` calcYaw

calcYaw(quat: Quat): number
根据旋转获得航向角

Returns
航向角
Parameters
- quat: Quat
  
  旋转
Returns number
- Defined in src/tools/camera/orbitCamera.ts:356

`Private` checkAspectRatio

checkAspectRatio(): void
根据宽高设置fov模式

Returns void
- Defined in src/tools/camera/orbitCamera.ts:278

`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

focus

focus(entity: Entity | Entity[]): void
聚焦
Parameters
- entity: Entity | Entity[]
  
  聚焦物体
Returns void
- Defined in src/tools/camera/orbitCamera.ts:215

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:407

`Protected` onEnable

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

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` removeInertia

removeInertia(): void
清除缓动

Returns void
- Defined in src/tools/camera/orbitCamera.ts:289

setOptions

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

stopInertia

stopInertia(): void
结束目标缓动

Returns void
- Defined in src/tools/camera/orbitCamera.ts:235

`Private` update

update(dt: number): void
更新相机
Parameters
- dt: number
  
  帧间隔
Returns void
- Defined in src/tools/camera/orbitCamera.ts:246

updateOptions

updateOptions(options: { device?: AvailableDevices; distanceCondition?: (() => boolean); distanceMax?: number; distanceMin?: number; distanceSensitivity?: number; inertiaFactor?: number; lookCondition?: (() => boolean); mainCamra?: CameraComponent; orbitSensitivity?: number; panCondition?: (() => boolean); pitchMax?: number; pitchMin?: number; rotateCondition?: (() => boolean) }): void
更新选项
Parameters
- options: { device?: AvailableDevices; distanceCondition?: (() => boolean); distanceMax?: number; distanceMin?: number; distanceSensitivity?: number; inertiaFactor?: number; lookCondition?: (() => boolean); mainCamra?: CameraComponent; orbitSensitivity?: number; panCondition?: (() => boolean); pitchMax?: number; pitchMin?: number; rotateCondition?: (() => boolean) }
  
  选项
  - Optional device?: AvailableDevices
  - Optional distanceCondition?: (() => boolean)
    - (): boolean
      
      Returns boolean
  - Optional distanceMax?: number
  - Optional distanceMin?: number
  - Optional distanceSensitivity?: number
  - Optional inertiaFactor?: number
  - Optional lookCondition?: (() => boolean)
    - (): boolean
      
      Returns boolean
  - Optional mainCamra?: CameraComponent
  - Optional orbitSensitivity?: number
  - Optional panCondition?: (() => boolean)
    - (): boolean
      
      Returns boolean
  - Optional pitchMax?: number
  - Optional pitchMin?: number
  - Optional rotateCondition?: (() => boolean)
    - (): boolean
      
      Returns boolean
Returns void
Inherited from Tool.updateOptions
- Defined in src/utils/helpers/toolBase.ts:65

`Private` updatePosition

updatePosition(): void
更新相机位置

Returns void
- Defined in src/tools/camera/orbitCamera.ts:259

Class OrbitCamera

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: OrbitCameraOptions

Returns OrbitCamera

Properties

Private _distance

Private _pitch

Private _pivotPoint

Private _yaw

app

Private cameraForward

Private inputHandler

isLooking

isPaning

isRotating

Private modelsAABB

Private quatWithoutYaw

Private targetDistance

Private targetPitch

Private targetYaw

toolOptions

Protected toolOptionsDefault

Private yawOffset

Accessors

device

Returns AvailableDevices

Parameters

value: AvailableDevices

Returns void

distance

Returns number

Parameters

value: number

Returns void

enabled

Returns boolean

Parameters

value: boolean

Returns void

pitch

Returns number

Parameters

value: number

Returns void

pivotPoint

Returns Vec3

Parameters

value: Vec3

Returns void

yaw

Returns number

Parameters

value: number

Returns void

Methods

Private buildAABB

Returns

Parameters

entity: Entity | GraphNode | (Entity | GraphNode)[]

modelsAdded: number

Returns number

Private calcPitch

Returns

Parameters

quat: Quat

yaw: number

Returns number

Private calcYaw

Returns

Parameters

quat: Quat

Returns number

`Optional` options: OrbitCameraOptions

`Private` _distance

`Private` _pitch

`Private` _pivotPoint

`Private` _yaw

`Private` cameraForward

`Private` inputHandler

`Private` modelsAABB

`Private` quatWithoutYaw

`Private` targetDistance

`Private` targetPitch

`Private` targetYaw

`Protected` toolOptionsDefault

`Private` yawOffset

`Private` buildAABB

`Private` calcPitch

`Private` calcYaw

`Private` checkAspectRatio

`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

`Optional` scope: object

`Private` removeInertia

`Private` update