orbit-camera.controller overview

---

Table of contents

• utils
• OrbitCameraController (class)
  • onSpawned (method)
  • onRemoved (method)
  • tickOrder (property)
  • options (property)
  • mouseInput (property)
  • spherical (property)
  • target (property)
• OrbitCameraControllerOptions (type alias)

---

utils

OrbitCameraController (class)

Signature

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

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: Point3

OrbitCameraControllerOptions (type alias)

Signature

export type OrbitCameraControllerOptions = {
  mouseOptions: Partial<MouseInputOptions>
  orbiting: { sensitivityX: number; sensitivityY: number } | false
  zooming: { sensitivity: number } | false
  panning: { sensitivityX: number; sensitivityY: number } | false
  dollying: { sensitivity: number } | false
}