Class FirstPersonControls

constructor

• new FirstPersonControls(
      instance: Instance,
      options?: Partial<FirstPersonControlsOptions>,
  ): FirstPersonControls

  Parameters

  • instance: Instance

    the Giro3D instance to control

  • options: Partial<FirstPersonControlsOptions> = {}

    additional options

  Returns FirstPersonControls

enabled

Readonlyoptions

isUserInteracting

• isUserInteracting(): boolean

  Returns boolean

reset

• reset(preserveRotationOnX?: boolean): void

  Resets the controls internal state to match the camera' state. This must be called when manually modifying the camera's position or rotation.

  Parameters

  • preserveRotationOnX: boolean = false

    if true, the look up/down rotation will not be copied from the camera

  Returns void

update

• update(event: { camera: View } & FrameEventPayload, force?: boolean): void

  Updates the camera position / rotation based on occured input events. This is done automatically when needed but can also be done if needed.

  Parameters

  • event: { camera: View } & FrameEventPayload

    Event

  • force: boolean = false

    set to true if you want to force the update, even if it appears unneeded.

  Returns void