Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AutoRotationBehavior

The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.

see

https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior

Hierarchy

  • AutoRotationBehavior

Implements

Index

Properties

targetAlphaSearch playground for targetAlpha

targetAlpha: Nullable<number>

Accessors

idleRotationSpeed

  • get idleRotationSpeed(): number
  • set idleRotationSpeed(speed: number): any
  • Gets the default speed at which the camera rotates around the model.

    Returns number

  • Sets the default speed at which the camera rotates around the model.

    Parameters

    • speed: number

    Returns any

idleRotationSpinupTime

  • get idleRotationSpinupTime(): number
  • set idleRotationSpinupTime(time: number): any
  • Gets the time (milliseconds) to take to spin up to the full idle rotation speed.

    Returns number

  • Sets the time (milliseconds) to take to spin up to the full idle rotation speed.

    Parameters

    • time: number

    Returns any

idleRotationWaitTime

  • get idleRotationWaitTime(): number
  • set idleRotationWaitTime(time: number): any
  • Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.

    Returns number

  • Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.

    Parameters

    • time: number

    Returns any

name

  • get name(): string
  • Gets the name of the behavior.

    Returns string

rotationInProgress

  • get rotationInProgress(): boolean
  • Gets a value indicating if the camera is currently rotating because of this behavior

    Returns boolean

zoomStopsAnimation

  • get zoomStopsAnimation(): boolean
  • set zoomStopsAnimation(flag: boolean): any
  • Gets the flag that indicates if user zooming should stop animation.

    Returns boolean

  • Sets the flag that indicates if user zooming should stop animation.

    Parameters

    • flag: boolean

    Returns any

Methods

attachSearch playground for attach

  • Attaches the behavior to its arc rotate camera.

    Parameters

    Returns void

detachSearch playground for detach

  • detach(): void
  • Detaches the behavior from its current arc rotate camera.

    Returns void

initSearch playground for init

  • init(): void
  • Initializes the behavior.

    Returns void

resetLastInteractionTimeSearch playground for resetLastInteractionTime

  • resetLastInteractionTime(customTime?: number): void
  • Force-reset the last interaction time

    Parameters

    • Optional customTime: number

      an optional time that will be used instead of the current last interaction time. For example Date.now()

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Accessor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Static property
  • Static method