Class ArcballCameraControl

arcball 控制器

Hierarchy (View Summary)

CamreaControl
- ArcballCameraControl
  - OrbitCameraControl

Constructors

constructor

new ArcballCameraControl(
option: IV_CamreaControl,
manager: InputManager,
): ArcballCameraControl
Parameters
- option: IV_CamreaControl
- manager: InputManager
Returns ArcballCameraControl
Overrides CamreaControl.constructor
- Defined in src/we/core/control/arcballCameraControl.ts:51

Properties

_analog

_analog: analog = ...

_camera

_camera: BaseCamera

_canvas

_canvas: HTMLCanvasElement

_digital

_digital: digital = ...

_id

_id: number

_isDestroy

_isDestroy: boolean = false

_key

_key: undefined | KeyboardEvent

_manager

_manager: any

_pointer

_pointer: undefined | PointerEvent | MouseEvent | TouchEvent

angularVelocity

angularVelocity: number = 0

axis_

axis_: Float32Array<ArrayBufferLike> = ...

distance

distance: number = 0

epsilon

epsilon: number = 0.000001

event

event: {
    callback: (scope: any) => void;
    option: any;
    target: any;
    type: string;
}[] = ...

eventValues

eventValues: {
    click: undefined | MouseEvent;
    dblclick: undefined | MouseEvent;
    key: undefined | KeyboardEvent;
    keyValue: {
        altKey: boolean;
        ctrlKey: boolean;
        downOrUP: undefined | "down" | "up";
        keyCode: undefined | string;
        shiftKey: boolean;
    };
    mouse: undefined
    | MouseEvent;
    mouseValue: {
        alreadyUp: boolean;
        altKey: boolean;
        buttons: number;
        ctrlKey: boolean;
        downOrUP: undefined | "down" | "up";
        move: boolean;
        shiftKey: boolean;
        x: undefined | number;
        y: undefined | number;
    };
    pointer: undefined
    | PointerEvent;
    touch: undefined | TouchEvent;
    wheel: undefined | WheelEvent;
} = ...

frictionCoefficient

frictionCoefficient: number = 0.999

Rotation velocity drag coeffient [0 .. 1] 0: Spins forever 1: Instantly stops spinning

rightKeyRate

rightKeyRate: number = 0.01

右键旋转系数

rotationSpeed

rotationSpeed: number = 1

type

type: string = ""

UUID

UUID: string

window

window: Window

zoomSpeed

zoomSpeed: number = 0.1

Accessors

axis

get axis(): Float32Array<ArrayBufferLike>
Returns Float32Array<ArrayBufferLike>
- Defined in src/we/core/control/arcballCameraControl.ts:40
set axis(vec: Float32Array): void
Parameters
- vec: Float32Array
Returns void
- Defined in src/we/core/control/arcballCameraControl.ts:44

camera

get camera(): BaseCamera
Returns BaseCamera
Inherited from CamreaControl.camera
- Defined in src/we/core/control/cameracControl.ts:362
set camera(camera: BaseCamera): void
Parameters
- camera: BaseCamera
Returns void
Inherited from CamreaControl.camera
- Defined in src/we/core/control/cameracControl.ts:359

isDestroy

get isDestroy(): boolean
Returns boolean
Inherited from CamreaControl.isDestroy
- Defined in src/we/core/control/cameracControl.ts:365
set isDestroy(destroy: boolean): void
Parameters
- destroy: boolean
Returns void
Inherited from CamreaControl.isDestroy
- Defined in src/we/core/control/cameracControl.ts:368

Methods

__destroy

__destroy(): void
Returns void
Inherited from CamreaControl.__destroy
- Defined in src/we/core/control/cameracControl.ts:104

_destroy

_destroy(): any
Returns any
Inherited from CamreaControl._destroy
- Defined in src/we/core/control/cameracControl.ts:112

clean

clean(): void
清理控制器的eventValues和自定义数据结构

Returns void
Inherited from CamreaControl.clean
- Defined in src/we/core/control/cameracControl.ts:150

computeCameraZByPosition

computeCameraZByPosition(position: Float32Array): Float32Array
计算摄像机Z方向
Parameters
- position: Float32Array
  ：摄像机位置
Returns Float32Array
：摄像机Z方向（归一化）
- Defined in src/we/core/control/arcballCameraControl.ts:183

computeCosOfUpDirectionAndPositionOld

computeCosOfUpDirectionAndPositionOld(position: Float32Array): number
判断前后计算 camera Z向量与 up方向的点积（cos)，orbiteControl中使用 1、camera在上半球，cos 正值 2、camera在下半球，cos 负值
```
               | Y cross
               | 
               |          
               |_________________________________________________X (原来的 Y up)
```
camera / 。 / 。camera的Z轴向量(求xy与(1,0)的点积) / /
/ / Z （camera -X ）
Parameters
- position: Float32Array
  ：摄像机位置
Returns number
：Up向量与Z向量的点积（标量值,共面二维化）
- Defined in src/we/core/control/arcballCameraControl.ts:256

computeSinAndCosOfUpDirectionAndX0z

computeSinAndCosOfUpDirectionAndX0z(
position: Float32Array,
): { cos: number; sin: number }
计算摄像机Up向量与Z向量的点积，orbiteControl中使用
```
| Y不变
|          。point(求xy与(1,0)的点积)
|_________________________________________________X (X0Z)
```
/ / Z （cross）
Parameters
- position: Float32Array
  ：摄像机位置
Returns { cos: number; sin: number }
：Up向量与Z向量的点积（标量值,共面二维化）
- Defined in src/we/core/control/arcballCameraControl.ts:292

computeSinOfUpDirectionAndPosition

computeSinOfUpDirectionAndPosition(
up: Float32Array,
position: Float32Array,
): number
判断左右计算 Y轴Up向量与camera Z向量的叉积(sin)，orbiteControl中使用 1、右侧：摄像机Z指向北极，sin 负值 2、左侧：摄像机Z指向南极，sin 正值；翻转了
```
      |Y（cross)
      |
      |       。vector(point乘逆矩阵，忽略z值，xy与（1，—0)进行cross,即sin
      ——————————————————————————————————————————————————————————————————————————————————X（原来的Y轴）
     /        。point
    /
   /Z（camera  -X）
```
Parameters
- up: Float32Array
  ：Up向量：固定，top时：(0,1,0)，bottom时：(0,-1,0)
- position: Float32Array
  ：摄像机位置
Returns number
：Up向量与Z向量的叉积（标量值,共面二维化）
- Defined in src/we/core/control/arcballCameraControl.ts:215

destroy

destroy(): void
Returns void
Inherited from CamreaControl.destroy
- Defined in src/we/core/input/baseInputControl.ts:90

getInputValue

getInputValue(): InputForCamera
获取相机控制器的输入值 1、arcball、wasd相同，都是用此函数

Returns InputForCamera
Inherited from CamreaControl.getInputValue
- Defined in src/we/core/control/cameracControl.ts:126

init

init(): void
Returns void
Overrides CamreaControl.init
- Defined in src/we/core/control/arcballCameraControl.ts:58

receiveInput

receiveInput(event: Event, type: E_InputEvent): boolean
接收输入事件，处理事件相关数据，并返回是否后续继续处理了该事件（仅独占intercept优先级） 1、接受输入event，并按需写入eventValues 2、或者控制器自定义的数据结构
Parameters
- event: Event
  事件对象
- type: E_InputEvent
  事件类型
Returns boolean
返回true/false，取决于对应的优先级别。 true, A、broadcastStart|broadcastEnd优先级，返回不影响后续处理。 B、InputManager 将终止处理（仅独占intercept优先级）该事件（继续广播） false A、broadcastStart|broadcastEnd无影响 B、如果是intercept优先级，返回false，InputManager 将继续处理该事件（继续广播）例如： 1、pickup 事件，只是获取点击和xy坐标，不影响其他控制器,返回false。pickup是举例，不在这里实现。 2、camera control，也是具有兼容性，在最后处理。如果有控制器截获并终止，camera control 就不会收到处理 3、object control，就会截获并终止，其他object control 就不会收到处理
Inherited from CamreaControl.receiveInput
- Defined in src/we/core/control/cameracControl.ts:220

registerEvent

registerEvent(
    event: E_InputEvent,
    priority: E_InputPriority,
    control: BaseInputControl,
): boolean
注册控制器使用的input事件到ECS对应事件队列
Parameters
- event: E_InputEvent
  事件类型
- priority: E_InputPriority
  优先级
- control: BaseInputControl
  控制器
Returns boolean
是否注册成功
Inherited from CamreaControl.registerEvent
- Defined in src/we/core/input/baseInputControl.ts:102

removeRegisterEvent

removeRegisterEvent(
    event: E_InputEvent,
    priority: E_InputPriority,
    entity: BaseInputControl,
): void
Parameters
- event: E_InputEvent
- priority: E_InputPriority
- entity: BaseInputControl
Returns void
Inherited from CamreaControl.removeRegisterEvent
- Defined in src/we/core/input/baseInputControl.ts:105

update

update(deltaTime: number): boolean
更新相机位置，这里更新camera的position和dir 1、position是在camera的lookat位置为原点的坐标系下的位置（最后调用camera的updateByPositionDirection()会转化为camera的local坐标系下的位置） 2、direction是在camera的lookat位置为原点的坐标系下的方向向量 A、lookat为原点的坐标系与camera的local坐标系是只有position是不一样的，各自为原点。view空间是一致的，即xyz的分量相对于camera的parent的坐标系一致
Parameters
- deltaTime: number
Returns boolean
Overrides CamreaControl.update
- Defined in src/we/core/control/arcballCameraControl.ts:70

Class ArcballCameraControl

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ArcballCameraControl

Properties

_analog

_camera

_canvas

_digital

_id

_isDestroy

_key

_manager

_pointer

angularVelocity

axis_

distance

epsilon

event

eventValues

frictionCoefficient

inputValues

kind

manager

rightKeyRate

rotationSpeed

type

UUID

window

zoomSpeed

Accessors

axis

Returns Float32Array<ArrayBufferLike>

Parameters

Returns void

camera

Returns BaseCamera

Parameters

Returns void

isDestroy

Returns boolean

Parameters

Returns void

Methods

__destroy

Returns void

_destroy

Returns any

clean

Returns void

computeCameraZByPosition

Parameters

Returns Float32Array

computeCosOfUpDirectionAndPositionOld

Parameters

Returns number

computeSinAndCosOfUpDirectionAndX0z

Parameters

Returns { cos: number; sin: number }

computeSinOfUpDirectionAndPosition

Parameters

Returns number

destroy

Returns void

getInputValue

Returns InputForCamera

init

Returns void

receiveInput

Parameters

Returns boolean

registerEvent

Parameters