Class OrbitCtrls

orbitControls

create

• create(): void

  Creates three.js OrbitControls.

  Returns void

disable

• disable(): void

  Disables three.js OrbitControls and cleans up the event listeners.

  Returns void

dispose

• dispose(): void

  Disposes three.js OrbitControls and removes them from the render loop.

  Returns void

enable

• enable(): void

  Enables three.js OrbitControls for the current camera.

  Returns void

get

• get(): Partial<OrbitCtrlsCfg>

  Returns the parameters currently used by three.js OrbitControls.

  Returns Partial<OrbitCtrlsCfg>

  A snapshot of the mutable orbit control settings.

isEnabled

• isEnabled(): boolean

  Returns whether three.js OrbitControls are currently enabled.

  Returns boolean

  true if OrbitControls are currently enabled; otherwise, false.

set

• set(params: Partial<OrbitCtrlsCfg>): void

  Updates one or more three.js OrbitControls properties. OrbitCtrls must be enabled.

  Parameters

  • params: Partial<OrbitCtrlsCfg>

    Object containing any subset of orbit control parameters.

  Returns void

use

• use(extension: (orbitCtrls: OrbitCtrls) => void): void

  Registers and executes a low-level extension function with access to the public OrbitCtrls API.

  Parameters

  • extension: (orbitCtrls: OrbitCtrls) => void

    Function that receives the current OrbitCtrls instance and can use its public members and methods.

  Returns void

  Remarks

  This method is intended for advanced custom integrations where developers need direct access to the engine instance. The extension is executed once immediately when use() is called.