Communicator.Operator.CameraOrbitOperator

 CameraOrbitOperator

Implements

Type aliases

Static CameraRotateFunction

CameraRotateFunction: function

Type declaration

    • (turnTilt: number[]): void
    • Parameters

      • turnTilt: number[]

      Returns void

Methods

addMapping

  • Adds a button and key modifier mapping for the operator. If no mapping is provided, all combinations are considered valid. All mappings require a mouse button, but a key modifier is optional.

    Parameters

    Returns void

clearMapping

  • clearMapping(): void
  • Clears any button and key modifier mappings for the operator.

    Returns void

getBimOrbitEnabled

  • getBimOrbitEnabled(): boolean
  • Returns true if BIM orbit is enabled.

    Returns boolean

getCameraRotationMomentumEnabled

  • getCameraRotationMomentumEnabled(): boolean
  • Returns boolean

getMomentum

  • getMomentum(): number
  • Returns number

getMomentumLossPerSecond

  • getMomentumLossPerSecond(): number
  • Returns number

getOrbitFallbackMode

getOrbitTarget

  • Gets the orbit target point.

    Returns Point3

    orbit target

getPrimaryButton

  • Returns Button

    the primary orbit button

isAnimating

  • isAnimating(): boolean
  • Returns boolean

isCurrentlyAnimating

  • isCurrentlyAnimating(): boolean
  • Returns boolean

setBimOrbitEnabled

  • setBimOrbitEnabled(bimOrbitEnabled: boolean): void
  • BIM orbit is intended to make orbiting building models easier. It slows the rotation speed, clamps vertical rotation to 180 degrees, and restricts horizontal rotation to rotate around the vertical axis.

    Parameters

    • bimOrbitEnabled: boolean

    Returns void

setCameraRotationMomentumEnabled

  • setCameraRotationMomentumEnabled(val: boolean): void
  • Parameters

    • val: boolean

    Returns void

setMapping

  • Sets the button and key modifier mapping for the operator.

    Parameters

    Returns void

setMomentumLossPerSecond

  • setMomentumLossPerSecond(amountLost: number): void
  • Sets proportion of momentum lost per second if camera rotation momentum is enabled. At 0 no momentum is lost and the camera will orbit indefinitely. Above 1 the camera will stop orbiting within a second of release. Only values greater than or equal to 0 are accepted.

    Parameters

    • amountLost: number

      Proportion of momentum lost per second

    Returns void

setOrbitFallbackMode

  • Sets the fallback mode. This is used to specify whether to orbit around a set target, the model center, or camera target when there is no selection on the model, or useSelectionPointForRotation is false.

    Parameters

    Returns void

setOrbitTarget

  • setOrbitTarget(orbitTarget: Point3): void
  • Sets the orbit target for the orbit fallback mode OrbitTarget.

    Parameters

    Returns void

setPrimaryButton

  • setPrimaryButton(button: Button): void
  • Sets the primary mouse button. When this button is pressed, we will orbit around the selected point on the model. If there is no selected point, the orbit fallback mode will be used for orbit.

    Parameters

    Returns void

stopAnimation

  • stopAnimation(): void
  • Returns void

supportsAnimation

  • supportsAnimation(): boolean
  • Returns boolean