Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OrbitControl

The camera's track controller, can rotate, zoom, pan, support mouse and touch events.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

STATE

STATE: { NONE: number; PAN: number; ROTATE: number; TOUCH_PAN: number; TOUCH_ROTATE: number; TOUCH_ZOOM: number; ZOOM: number }

Type declaration

  • NONE: number
  • PAN: number
  • ROTATE: number
  • TOUCH_PAN: number
  • TOUCH_ROTATE: number
  • TOUCH_ZOOM: number
  • ZOOM: number

Protected _isLocalMatrixDirty

_isLocalMatrixDirty: boolean

Private _isMouseUp

_isMouseUp: any

_listeners

_listeners: Map<string, TinoeEventListener[]>

Protected _localMatrix

_localMatrix: Matrix4

Private _offset

_offset: any

Private _panDelta

_panDelta: any

Private _panEnd

_panEnd: any

Private _panOffset

_panOffset: any

Private _panStart

_panStart: any

Private _position

_position: any

Private _rotateDelta

_rotateDelta: any

Private _rotateEnd

_rotateEnd: any

Private _rotateStart

_rotateStart: any

Private _scale

_scale: any

Protected _shouldUpdateWorldMatrix

_shouldUpdateWorldMatrix: boolean

Private _spherical

_spherical: any

Private _sphericalDelta

_sphericalDelta: any

Private _sphericalDump

_sphericalDump: any

Private _state

_state: any

Private _vPan

_vPan: any

Private _zoomDelta

_zoomDelta: any

Private _zoomEnd

_zoomEnd: any

Private _zoomFrag

_zoomFrag: any

Private _zoomStart

_zoomStart: any

autoRotate

autoRotate: boolean

autoRotateSpeed

autoRotateSpeed: number

The radian of automatic rotation per second.

camera

camera: Camera

changed

changed: boolean

children

children: Object3D[]

constEvents

constEvents: { element?: Document | Window; listener: any; type: string }[]

dampingFactor

dampingFactor: number

domElement

domElement: Document | HTMLElement

enableDamping

enableDamping: boolean

enableKeys

enableKeys: boolean

enablePan

enablePan: boolean

enableRotate

enableRotate: boolean

enableZoom

enableZoom: boolean

fov

fov: number

keyPanSpeed

keyPanSpeed: number

keys

keys: { BOTTOM: number; LEFT: number; RIGHT: number; UP: number }

Type declaration

  • BOTTOM: number
  • LEFT: number
  • RIGHT: number
  • UP: number

mainElement

mainElement: ITinoeCanvasInstance

maxAzimuthAngle

maxAzimuthAngle: number

maxDistance

maxDistance: number

maxPolarAngle

maxPolarAngle: number

maxZoom

maxZoom: number

minAzimuthAngle

minAzimuthAngle: number

minDistance

minDistance: number

minPolarAngle

minPolarAngle: number

minZoom

minZoom: number

mouseButtons

mouseButtons: { ORBIT: number; PAN: number; ZOOM: number }

Type declaration

  • ORBIT: number
  • PAN: number
  • ZOOM: number

mouseUpEvents

mouseUpEvents: { listener: any; type: string }[]

name

name: string

parent

parent: Object3D

position

position: Vector3

rotateSpeed

rotateSpeed: number

rotation

rotation: Quaternion

scale

scale: Vector3

target

target: Vector3

touchFingers

touchFingers: { ORBIT: number; PAN: number; ZOOM: number }

Type declaration

  • ORBIT: number
  • PAN: number
  • ZOOM: number

up

up: Vector3

visible

visible: boolean

worldMatrix

worldMatrix: Matrix4

zoomFactor

zoomFactor: number

zoomSpeed

zoomSpeed: number

Accessors

localMatrix

  • Returns Matrix4

Methods

Protected _addChild

  • 添加子节点

    Parameters

    Returns void

Protected _onPositionChange

  • _onPositionChange(): void

Protected _onRotationChange

  • _onRotationChange(): void

Protected _onScaleChange

  • _onScaleChange(): void

Protected _onTransformChange

  • _onTransformChange(): void

Protected _removeChild

Protected _tapTransformChange

addChildren

  • addChildren(...children: Object3D[]): void

  • 添加1～n个子节点

    Parameters

    • Rest ...children: Object3D[]

      待添加节点

    Returns void

addEventListener

  • addEventListener(type: string, handler: ((data: any) => any), once?: boolean): void

  • 注册handler

    memberof

    EventEmitter

    Parameters

    • type: string
    • handler: ((data: any) => any)
        • (data: any): any

        • Parameters

          • data: any

          Returns any

    • Optional once: boolean

    Returns void

clone

destroy

  • destroy(): void

  • 销毁 TODO: Mesh的销毁是否需要特殊处理

    Returns void

disable

  • disable(): void

  • Returns void

dispatch

  • 派发事件

    Parameters

    Returns void

enable

  • enable(): void

  • Returns void

getAutoRotationAngle

  • getAutoRotationAngle(dtime: number): number

  • Get the radian of automatic rotation.

    Parameters

    • dtime: number

    Returns number

getChildByName

  • 根据name标识查找子节点

    Parameters

    • name: string

      标识

    • Optional findAll: boolean

      是否查找所有符合name标识的节点

    Returns Object3D | Node<Node<any>>[]

    查找到的节点

getZoomScale

  • getZoomScale(): number

  • Get zoom value.

    Returns number

handleKeyDown

  • handleKeyDown(event: KeyboardEvent): void

  • Pan parameter update when keyboard is pressed.

    Parameters

    • event: KeyboardEvent

    Returns void

handleMouseDownPan

  • handleMouseDownPan(event: any): void

  • Pan parameter update on mouse click.

    Parameters

    • event: any

    Returns void

handleMouseDownRotate

  • handleMouseDownRotate(event: any): void

  • Rotation parameter update on mouse click.

    Parameters

    • event: any

    Returns void

handleMouseDownZoom

  • handleMouseDownZoom(event: any): void

  • Zoom parameter update on mouse click.

    Parameters

    • event: any

    Returns void

handleMouseMovePan

  • handleMouseMovePan(event: MouseEvent): void

  • Pan parameters update when the mouse moves.

    Parameters

    • event: MouseEvent

    Returns void

handleMouseMoveRotate

  • handleMouseMoveRotate(event: any): void

  • Rotation parameter update when the mouse moves.

    Parameters

    • event: any

    Returns void

handleMouseMoveZoom

  • handleMouseMoveZoom(event: any): void

  • Zoom parameters update when the mouse moves.

    Parameters

    • event: any

    Returns void

handleMouseWheel

  • handleMouseWheel(event: WheelEvent): void

  • Zoom parameter update when the mouse wheel is scrolled.

    Parameters

    • event: WheelEvent

    Returns void

handleTouchMovePan

  • handleTouchMovePan(event: TouchEvent): void

  • Pan parameter update when touch moves.

    Parameters

    • event: TouchEvent

    Returns void

handleTouchMoveRotate

  • handleTouchMoveRotate(event: TouchEvent): void

  • Rotation parameter update when touch to move.

    Parameters

    • event: TouchEvent

    Returns void

handleTouchMoveZoom

  • handleTouchMoveZoom(event: any): void

  • Zoom parameter update when touch to move.

    Parameters

    • event: any

    Returns void

handleTouchStartPan

  • handleTouchStartPan(event: TouchEvent): void

  • Update the translation parameter when touch down.

    Parameters

    • event: TouchEvent

    Returns void

handleTouchStartRotate

  • handleTouchStartRotate(event: TouchEvent): void

  • Rotation parameter update when touch is dropped.

    Parameters

    • event: TouchEvent

    Returns void

handleTouchStartZoom

  • handleTouchStartZoom(event: TouchEvent): void

  • Zoom parameter update when touch down.

    Parameters

    • event: TouchEvent

    Returns void

off

  • off(type?: string, handler?: ((data: any) => any)): void

  • 注销事件

    memberof

    EventEmitter

    Parameters

    • Optional type: string
    • Optional handler: ((data: any) => any)
        • (data: any): any

        • Parameters

          • data: any

          Returns any

    Returns void

    {void}

on

  • on(type: string, handler: ((data: any) => any), once?: boolean): void

  • 注册handler

    memberof

    EventEmitter

    Parameters

    • type: string
    • handler: ((data: any) => any)
        • (data: any): any

        • Parameters

          • data: any

          Returns any

    • Optional once: boolean

    Returns void

onContextMenu

  • onContextMenu(event: any): void

  • Context event hiding.

    Parameters

    • event: any

    Returns void

onDestroy

  • onDestroy(): void

  • Returns void

onDisable

  • onDisable(): void

  • Returns void

onKeyDown

  • onKeyDown(event: KeyboardEvent): void

  • Total handling of keyboard down events.

    Parameters

    • event: KeyboardEvent

    Returns void

onMouseDown

  • onMouseDown(event: MouseEvent): void

  • Total handling of mouse down events.

    Parameters

    • event: MouseEvent

    Returns void

onMouseMove

  • onMouseMove(event: MouseEvent): void

  • Total handling of mouse movement events.

    Parameters

    • event: MouseEvent

    Returns void

onMouseUp

  • onMouseUp(): void

  • Total handling of mouse up events.

    Returns void

onMouseWheel

  • onMouseWheel(event: WheelEvent): void

  • Total handling of mouse wheel events.

    Parameters

    • event: WheelEvent

    Returns void

onTouchEnd

  • onTouchEnd(): void

  • Total handling of touch end events.

    Returns void

onTouchMove

  • onTouchMove(event: TouchEvent): void

  • Total handling of touch movement events.

    Parameters

    • event: TouchEvent

    Returns void

onTouchStart

  • onTouchStart(event: TouchEvent): void

  • Total handling of touch start events.

    Parameters

    • event: TouchEvent

    Returns void

onUpdate

  • onUpdate(dtime: any): void

  • Parameters

    • dtime: any

    Returns void

pan

  • pan(deltaX: number, deltaY: number): void

  • Pan.

    Parameters

    • deltaX: number

      The amount of translation from the screen distance in the x direction

    • deltaY: number

      The amount of translation from the screen distance in the y direction

    Returns void

panLeft

  • panLeft(distance: number, worldMatrix?: Matrix4): void

  • Pan left.

    Parameters

    • distance: number
    • Optional worldMatrix: Matrix4

    Returns void

panUp

  • panUp(distance: number, worldMatrix?: Matrix4): void

  • Pan right.

    Parameters

    • distance: number
    • Optional worldMatrix: Matrix4

    Returns void

removeChildren

  • removeChildren(...children: Object3D[]): void

  • 删除1～n个字节点

    Parameters

    • Rest ...children: Object3D[]

      待删除节点

    Returns void

removeEventListener

  • removeEventListener(type?: string, handler?: ((data: any) => any), once?: boolean): void

  • 注销handler

    memberof

    EventEmitter

    Parameters

    • Optional type: string
    • Optional handler: ((data: any) => any)
        • (data: any): any

        • Parameters

          • data: any

          Returns any

    • Optional once: boolean

    Returns void

removeFromParent

  • removeFromParent(): void

rotate

  • rotate(axis: Vector3, degrees: number): void

  • 旋转

    Parameters

    • axis: Vector3

      旋转中心轴

    • degrees: number

      旋转角度

    Returns void

rotateLeft

  • rotateLeft(radian: number): void

  • Rotate to the left by a certain randian.

    Parameters

    • radian: number

      Radian value of rotation

    Returns void

rotateUp

  • rotateUp(radian: number): void

  • Rotate to the right by a certain randian.

    Parameters

    • radian: number

      Radian value of rotation

    Returns void

rotateX

  • rotateX(degrees: number): void

  • 沿x轴旋转

    Parameters

    • degrees: number

      旋转角度

    Returns void

rotateY

  • rotateY(degrees: number): void

  • 沿y轴旋转

    Parameters

    • degrees: number

      旋转角度

    Returns void

rotateZ

  • rotateZ(degrees: number): void

  • 沿z轴旋转

    Parameters

    • degrees: number

      旋转角度

    Returns void

scaleX

  • scaleX(factor: number): void

  • 沿x轴方向缩放

    Parameters

    • factor: number

      缩放因子

    Returns void

scaleY

  • scaleY(factor: number): void

  • 沿y轴方向缩放

    Parameters

    • factor: number

      缩放因子

    Returns void

scaleZ

  • scaleZ(factor: number): void

  • 沿z轴方向缩放

    Parameters

    • factor: number

      缩放因子

    Returns void

scaling

  • scaling(x: number, y: number, z: number): void

  • 缩放

    Parameters

    • x: number
    • y: number
    • z: number

    Returns void

translate

  • translate(x: number, y: number, z: number): void

  • 平移

    Parameters

    • x: number
    • y: number
    • z: number

    Returns void

translateX

  • translateX(shift: number): void

  • 沿x轴方向平移

    Parameters

    • shift: number

      平移量

    Returns void

translateY

  • translateY(shift: number): void

  • 沿y轴方向平移

    Parameters

    • shift: number

      平移量

    Returns void

translateZ

  • translateZ(shift: number): void

  • 沿z轴方向平移

    Parameters

    • shift: number

      平移量

    Returns void

traverse

  • traverse(callback: ((n: Object3D) => void), isIncludingSelf?: boolean): void

  • 遍历节点

    Parameters

    • callback: ((n: Object3D) => void)

      回调函数

    • Optional isIncludingSelf: boolean

      自己是否执行回调函数，默认为true

    Returns void

updateCamera

  • Parameters

    Returns void

updateCanvas

updateWorldMatrix

  • updateWorldMatrix(updateChildren?: boolean, isParentDirty?: boolean): boolean

  • 更新世界矩阵

    Parameters

    • Optional updateChildren: boolean

      是否更新后代节点

    • Optional isParentDirty: boolean

      是否父节点有变更

    Returns boolean

zoomIn

  • zoomIn(zoomScale: number): void

  • Zoom in.

    Parameters

    • zoomScale: number

    Returns void

zoomOut

  • zoomOut(zoomScale: number): void

  • Zoom out.

    Parameters

    • zoomScale: number

    Returns void

Generated using TypeDoc