orbit-camera.controller overview

---

Table of contents

• utils
• OrbitCameraController (class)
  • reset (method)
  • onSpawned (method)
  • onRemoved (method)
  • tickOrder (property)
  • options (property)
  • mouseInput (property)
  • _spherical (property)
  • target (property)
  • resetMotion$ (property)
• OrbitCameraControllerOptions (type alias)

---

utils

OrbitCameraController (class)

Signature

export declare class OrbitCameraController {
  constructor(protected readonly camera: Renderer3dEntity, options: Partial<OrbitCameraControllerOptions> = {})
}

reset (method)

Signature

public reset(): void

onSpawned (method)

Signature

async onSpawned(world: GgWorld<any, any>): Promise<void>

onRemoved (method)

Signature

async onRemoved(): Promise<void>

tickOrder (property)

Signature

readonly tickOrder: TickOrder.INPUT_CONTROLLERS

options (property)

Signature

readonly options: OrbitCameraControllerOptions

mouseInput (property)

Signature

readonly mouseInput: MouseInput

_spherical (property)

Signature

_spherical: MutableSpherical

target (property)

Signature

target: Readonly<MutablePoint3>

resetMotion$ (property)

Signature

resetMotion$: any

OrbitCameraControllerOptions (type alias)

Signature

export type OrbitCameraControllerOptions = {
  /**
   * Options for configuring mouse input.
   */
  mouseOptions: Partial<MouseInputOptions>
  /**
   * Orbiting options. false disables orbiting, sensitivity fields are the speed in radians per 1000px mouse movement. 1 by default
   */
  orbiting: { sensitivityX: number; sensitivityY: number } | false
  /**
   * An elasticity factor for orbiting. 0 by default (no elastic motion)
   */
  orbitingElasticity: number
  /**
   * Zooming options. false disables zooming. Enabled by default
   */
  zooming: { sensitivity: number } | false
  /**
   * Panning options. false disables panning. Enabled by default
   */
  panning: { sensitivityX: number; sensitivityY: number } | false
  /**
   * Dollying options. false disables dollying. Enabled by default
   */
  dollying: { sensitivity: number } | false
}