Documentation - v20.0.0-dev
    Preparing search index...

    The viewport's camera and its controls (camera-controls), in a mode (orbital, first person, floor plan...). The controls are updated on demand, as the frames are drawn: frame after frame while the camera moves (an input, a transition, a move asked for), none once it stays.

    Index

    Constructors

    Accessors

    • set draggingSmoothTime(value: number): void

      The inertia of the controls while dragged, perspective and orthographic, in seconds.

      Parameters

      • value: number

      Returns void

    • get enabled(): boolean

      Returns boolean

    • set enabled(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • set smoothTime(value: number): void

      The inertia of the controls, perspective and orthographic, in seconds.

      Parameters

      • value: number

      Returns void

    Methods

    • Listens to element's pointer and wheel input: the viewport's canvas.

      Parameters

      • element: HTMLElement

      Returns void

    • Stops listening to the element connected.

      Returns void

    • Returns void

    • Parameters

      • sphere: Sphere
      • duration: number = 0.25

      Returns Promise<void>

    • Returns number

    • Parameters

      Returns Vector3

    • Parameters

      Returns Vector3

    • Returns number

    • Moves the current camera to given position looking at the given target.

      Parameters

      Returns Promise<void>

      A promise indicating when the animation is finished

    • Parameters

      • distance: number
      • duration: number = 0.25

      Returns void

    • Parameters

      • distance: number
      • duration: number = 0.25

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      • event: WheelEvent

      Returns void

    • Returns void

    • Parameters

      • factor: number = 1.5
      • duration: number = 0.25

      Returns Promise<void>

    • Parameters

      • width: number
      • height: number

      Returns void

    • Parameters

      Returns Promise<void>

    • Parameters

      • distance: number = 5
      • duration: number = 0.25

      Returns Promise<void>

    • Parameters

      • distance: number = 5
      • duration: number = 0.25

      Returns Promise<void>

    • Parameters

      • newValue: number
      • duration: number = 0.25

      Returns Promise<void>