Class OrbitController

Orbit camera controller

Export

OrbitController

Date

2024.1.4

Author

yisky

Quote

https://github.com/mrdoob/three.js/blob/master/examples/jsm/controls/OrbitControls.js

Hierarchy

  • Script
    • OrbitController

Constructors

constructor

Properties

_awoken _enabled damping dampingFactor entity isScript maxAzimuthAngle maxDistance maxPolarAngle minAzimuthAngle minDistance minPolarAngle panButton panSpeed rotateButton rotateSpeed screenSpacePanning touchOne touchTwo userData zoomSpeed zoomThreshold

Accessors

enabled scene target

Methods

_onAwake _onDestroy _onDisable _onEnable desrtoy dispose emit off on onAfterCameraRender onAwake onBeforeCameraRender once onDestroy onDisable onDisableInScene onEnable onLateUpdate onPhysicsUpdate onStart onUpdate

Constructors

constructor

Properties

Protected_awoken

_awoken: boolean

Protected_enabled

_enabled: boolean

damping

damping: boolean = false

Whether enable damping

Memberof

OrbitController

dampingFactor

dampingFactor: number = 0.05

Damping factor

Memberof

OrbitController

Readonlyentity

entity: Entity

ReadonlyisScript

isScript: boolean

Read-only flag to check if a given component is of type Script

Memberof

Script

maxAzimuthAngle

maxAzimuthAngle: number = Infinity

Max azimuth angle

Memberof

OrbitController

maxDistance

maxDistance: number = Infinity

Max Distance

Memberof

OrbitController

maxPolarAngle

maxPolarAngle: number = Math.PI

Max polar angle

Memberof

OrbitController

minAzimuthAngle

minAzimuthAngle: number = -Infinity

Min azimuth angle

Memberof

OrbitController

minDistance

minDistance: number = 0

Min distance

Memberof

OrbitController

minPolarAngle

minPolarAngle: number = 0

Min polar angle

Memberof

OrbitController

panButton

panButton: MouseButton = MouseButton.Right

Pan button

Memberof

OrbitController

panSpeed

panSpeed: number = 1.0

Pan speed

Memberof

OrbitController

rotateButton

rotateButton: MouseButton = MouseButton.Left

Rotate button

Memberof

OrbitController

rotateSpeed

rotateSpeed: number = 1.0

Rotate speed

Memberof

OrbitController

screenSpacePanning

screenSpacePanning: boolean = false

Screen space panning

Memberof

OrbitController

touchOne

touchOne: Touch = Touch.Rotate

Touch one

Memberof

OrbitController

touchTwo

touchTwo: Touch = Touch.Zoom_Pan

Touch two

Memberof

OrbitController

userData

userData: {
    [key: string]: any;
}

Component user data

Memberof

Component

zoomSpeed

zoomSpeed: number = 1.0

Zoom speed

Memberof

OrbitController

zoomThreshold

zoomThreshold: number = 2.0

Zoom threshold

Memberof

OrbitController

Accessors

enabled

  • get enabled(): boolean

  • Indicates whether the component is enabled.

    Returns boolean

    Memberof

    Component

  • set enabled(value): void

  • Set whether the component is enabled.

    Parameters

    • value: boolean

    Returns void

    Memberof

    Component

scene

  • get scene(): Scene

  • Scene own the component

    Returns Scene

    Memberof

    Component

target

  • get target(): Readonly<Vector3>

  • Returns Readonly<Vector3>

Methods

Protected_onAwake

  • _onAwake(): void
  • Protected

    Awake script

    Returns void

    Memberof

    Script

Protected_onDestroy

  • _onDestroy(): void
  • Protected

    Destroy script

    Returns void

    Memberof

    Script

Protected_onDisable

  • _onDisable(): void
  • Protected

    Disable script

    Returns void

    Memberof

    Script

Protected_onEnable

  • _onEnable(): void
  • Protected

    Enable script

    Returns void

    Memberof

    Script

desrtoy

  • desrtoy(): void

  • Destroy component

    Returns void

    Memberof

    Component

dispose

  • dispose(): void

  • Clear subscribers

    Returns void

    Memberof

    EventDispatcher

emit

  • emit(event): void

  • Emit event

    Parameters

    • event: {
          type: string;
          [key: string]: any;
      }
      • [key: string]: any
      • type: string

    Returns void

    Memberof

    EventDispatcher

off

  • off(type, callback?): void

  • Unsubscribe a event, if the callback param is not defined, all subscribers of this type will be removed.

    Parameters

    • type: string
    • Optionalcallback: SubscriberCallbackFn

      subscriber callback

    Returns void

    Memberof

    EventDispatcher

on

  • on(type, callback, options?): void

  • Subscribe a event

    Parameters

    • type: string

      event type

    • callback: SubscriberCallbackFn

      callback functions

    • Optionaloptions: {
          priority?: Priority;
          target?: any;
      }

      options

      • Optionalpriority?: Priority
      • Optionaltarget?: any

    Returns void

    Memberof

    EventDispatcher

onAfterCameraRender

  • onAfterCameraRender(camera): void

  • Script after camera render, called per camera.

    Parameters

    • camera: Camera

    Returns void

    Memberof

    Script

onAwake

  • onAwake(): void

  • Awake script (Only call once when it's first enable)

    Returns void

    Memberof

    Script

onBeforeCameraRender

  • onBeforeCameraRender(camera): void

  • Script before camera render, called per camera.

    Parameters

    • camera: Camera

    Returns void

    Memberof

    Script

once

  • once(type, callback, options?): void

  • Subscribe a event, just emit once

    Parameters

    • type: string
    • callback: SubscriberCallbackFn

      subscriber callback

    • Optionaloptions: {
          priority?: Priority;
          target?: any;
      }
      • Optionalpriority?: Priority
      • Optionaltarget?: any

    Returns void

    Memberof

    EventDispatcher

onDestroy

  • onDestroy(): void

  • Destroy

    Returns void

    Memberof

    OrbitController

onDisable

  • onDisable(): void

  • Disable the script

    Returns void

    Memberof

    Script

onDisableInScene

  • onDisableInScene(): void

  • Disable

    Returns void

    Memberof

    OrbitController

onEnable

  • onEnable(): void

  • Enable

    Returns void

    Memberof

    OrbitController

onLateUpdate

  • onLateUpdate(timeSinceLastFrame, totalTime): void

  • Late update

    Parameters

    • timeSinceLastFrame: number
    • totalTime: number

    Returns void

    Memberof

    OrbitController

onPhysicsUpdate

  • onPhysicsUpdate(): void

  • Script physics update

    Returns void

    Memberof

    Script

onStart

  • onStart(): void

  • Start script (Call when the animation loop first start)

    Returns void

    Memberof

    Script

onUpdate

  • onUpdate(timeSinceLastFrame, totalTime): void

  • Script update

    Parameters

    • timeSinceLastFrame: number

      time since last frame in seconds

    • totalTime: number

      total time in seconds

    Returns void

    Memberof

    Script

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods