Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BasicController

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected eventMap

eventMap: Map<string, Set<Function>>

followMouse

followMouse: boolean

zoomScale

zoomScale: number

Methods

Optional bindElement

  • 绑定元素到当前控制器

    Parameters

    Returns void

dispose

  • dispose(): void

  • Returns void

Protected emit

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

  • Parameters

    • event: string
    • Rest ...args: unknown[]

    Returns void

getAzimuthAngle

  • getAzimuthAngle(): number

  • 获取当前横向转动值, 范围区间为[-2 * PI, 2 * PI]

    Returns number

getCameraPosition

  • getCameraPosition(): Vector3

  • 获取相机位置坐标

    Returns Vector3

getCameraTarget

  • getCameraTarget(): Vector3

  • 获取相机看向目标位置

    Returns Vector3

    vec3

getDampingFactor

  • getDampingFactor(): number

  • 获取阻尼系数

    Returns number

getEnabled

  • getEnabled(): boolean

  • 获取当前激活状态

    Returns boolean

getFov

  • getFov(): number | null

  • 获取当前相机fov, 仅限透视投影相机使用

    Returns number | null

getPolarAngle

  • getPolarAngle(): number

  • 获取当前纵向转动值

    Returns number

getRotateSpeed

  • getRotateSpeed(): number

  • 获取旋转速度

    Returns number

getZoom

  • getZoom(): number

  • 获取当前变焦倍数

    Returns number

Optional initWithScene

  • initWithScene(scene: Scene): void

  • 对于需要Scene的controller, 初始化时会传递scene

    Parameters

    • scene: Scene

      传入的Scene

    Returns void

off

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

  • 注销事件监听

    Parameters

    • event: string

      事件名

    • callback: Function

      回调函数

    Returns void

on

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

  • 注册事件监听

    Parameters

    • event: string

      事件名

    • callback: Function

      回调函数

    Returns void

Optional renderingViewChanged

  • renderingViewChanged(view: View): void

  • 对于需要根据View变化的Controller, 使用该钩子函数进行处理

    Parameters

    • view: View

      当前view

    Returns void

setAzimuthAngle

  • setAzimuthAngle(azimuth: number): void

  • 设置横向转动角度

    Parameters

    • azimuth: number

      弧度

    Returns void

setAzimuthRange

  • setAzimuthRange(min: number, max: number): void

  • 设置横向转动范围, 范围区间为[-2 * PI, 2 * PI]

    Parameters

    • min: number

      最小值

    • max: number

      最大值

    Returns void

setBoundary

  • setBoundary(min: Vector3, max: Vector3): void

  • 设置相机运动范围, 范围是一个包围盒, 使用最小值点与最大值点描述

    Parameters

    • min: Vector3

      包围盒最小值点坐标, 默认值为无限小

    • max: Vector3

      包围盒最大值点坐标, 默认值为无限大

    Returns void

setBoundaryEnabled

  • setBoundaryEnabled(enable: boolean): void

  • 设置是否限制相机运动范围

    Parameters

    • enable: boolean

      是否限制

    Returns void

setCameraLookAt

  • setCameraLookAt(target: Vector3, updateCameraPosition?: boolean): void

  • 设置当前相机看向目标位置

    Parameters

    • target: Vector3

      目标点坐标

    • Default value updateCameraPosition: boolean = false

      是否同步更新相机位置, 默认值为false

    Returns void

setCameraLookAtVector

  • setCameraLookAtVector(direction: Vector3, distance?: number): void

  • 设置当前相机视线方向

    Parameters

    • direction: Vector3

      方向向量

    • Default value distance: number = 1

      目标距离, 默认值为1

    Returns void

setCameraPosition

  • setCameraPosition(position: Vector3, updateTarget?: boolean): void

  • 设置相机位置坐标

    Parameters

    • position: Vector3

      位置坐标

    • Default value updateTarget: boolean = true

      是否更新目标点坐标, 默认为true

    Returns void

setDampingEnabled

  • setDampingEnabled(enable: boolean): void

  • 设置是否开启阻尼

    Parameters

    • enable: boolean

      布尔值

    Returns void

setDampingFactor

  • setDampingFactor(factor: number): void

  • 设置阻尼系数, 默认值为0

    Parameters

    • factor: number

      阻尼系数

    Returns void

setEnabled

  • setEnabled(enabled: boolean): void

  • 设置BasicController是否激活可用

    Parameters

    • enabled: boolean

      是否激活

    Returns void

setFov

  • setFov(fov: number): void

  • 设置当前相机fov, 仅限透视投影相机使用

    Parameters

    • fov: number

      FOV值

    Returns void

setFovRange

  • setFovRange(min: number, max: number): void

  • 设置相机fov范围, 默认值为[60, 90]

    Parameters

    • min: number

      最小值

    • max: number

      最大值

    Returns void

setInertiaFactor

  • setInertiaFactor(factor: number): void

  • 设置惯性系数

    Parameters

    • factor: number

      惯性系数

    Returns void

setMouseButtons

  • 设置鼠标操作关联

    Parameters

    Returns void

setPanEnabled

  • setPanEnabled(enable: boolean): void

  • 设置是否激活摇镜(移动)

    Parameters

    • enable: boolean

      布尔值

    Returns void

setPanInertiaEnabled

  • setPanInertiaEnabled(enabled: boolean): void

  • 设置是否激活摇镜运动的惯性

    Parameters

    • enabled: boolean

      布尔值

    Returns void

setPolarAngle

  • setPolarAngle(polar: number): void

  • 设置纵向旋转角度

    Parameters

    • polar: number

      弧度

    Returns void

setPolarRange

  • setPolarRange(min: number, max: number): void

  • 设置纵向旋转范围, 范围区间为[0, PI]

    Parameters

    • min: number

      最小值

    • max: number

      最大值

    Returns void

setRotateEnabled

  • setRotateEnabled(enable: boolean): void

  • 设置是否激活旋转

    Parameters

    • enable: boolean

      布尔值

    Returns void

setRotateInertiaEnabled

  • setRotateInertiaEnabled(enabled: boolean): void

  • 设置是否激活旋转运动的惯性

    Parameters

    • enabled: boolean

      布尔值

    Returns void

setRotateMode

  • setRotateMode(mode: "self" | "orbit"): void

  • 设置旋转模式, 可选值 'self':自转, 'orbit': 公转

    Parameters

    • mode: "self" | "orbit"

      旋转模式

    Returns void

setRotateSpeed

  • setRotateSpeed(speed: number): void

  • 设置旋转速度

    Parameters

    • speed: number

      旋转速度倍数

    Returns void

setScreenSpacePanning

  • setScreenSpacePanning(enabled: boolean): void

  • 设置摇镜操作是否跟随屏幕空间朝向

    Parameters

    • enabled: boolean

      布尔值

    Returns void

setTouches

  • setTouches(touches: Touches): void

  • 设置触摸操作关联

    Parameters

    • touches: Touches

      触摸操作关联

    Returns void

setZoom

  • setZoom(zoom: number): void

  • 设置当前变焦倍数, 倍数受倍数范围影响

    Parameters

    • zoom: number

      变焦倍数

    Returns void

setZoomEnabled

  • setZoomEnabled(enable: boolean): void

  • 设置是否激活缩放

    Parameters

    • enable: boolean

      布尔值

    Returns void

setZoomInertiaEnabled

  • setZoomInertiaEnabled(enabled: boolean): void

  • 设置是否激活变焦的惯性

    Parameters

    • enabled: boolean

      布尔值

    Returns void

setZoomMode

  • setZoomMode(mode: "zoom" | "fov"): void

  • 设置放大模式, 可选值: 'zoom': 使用变焦放大, 'fov': 使用fov放大

    Parameters

    • mode: "zoom" | "fov"

      放大模式

    Returns void

setZoomRange

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

  • 设置变焦倍数范围, 默认值为[0, 10]

    Parameters

    • min: number

      最小值

    • max: number

      最大值

    Returns void

Optional unbindElement

  • 将目标元素解除绑定, 解除绑定的元素将不再被该控制器所管理

    Parameters

    Returns void

unbindView

  • unbindView(): void

  • Returns void