Class BillboardController

constructor

• new BillboardController(config: BillboardConfig): BillboardController

  Parameters

  • config: BillboardConfig

  Returns BillboardController

pivotingInteractor

axisBufferDegrees

• get axisBufferDegrees(): vec3

  Returns vec3

• set axisBufferDegrees(bufferDegrees: vec3): void

  Parameters

  • bufferDegrees: vec3

  Returns void

axisEasing

• get axisEasing(): vec3

  Gets the easing values for each axis (x, y, z). See BillboardConfig.axisEasing for detailed documentation.

  Returns vec3
• set axisEasing(easing: vec3): void

  Sets the easing values for each axis (x, y, z). Typical values: 0.2-0.3 for smooth lag, 1.0 for instant rotation. See BillboardConfig.axisEasing for detailed documentation.

  Parameters

  • easing: vec3

  Returns void

targetTransform

• get targetTransform(): Transform

  Returns Transform

animateToLookAtCamera

• animateToLookAtCamera(onComplete?: () => void): void

  Animates rotation to directly look at the camera, ignoring current axis enabled/disabled states, buffer degrees, and easing.

  Parameters

  • OptionalonComplete: () => void

  Returns void

enableAxisRotation

• enableAxisRotation(axis: RotationAxis, enabled: boolean): void

  Parameters

  • axis: RotationAxis
  • enabled: boolean

  Returns void

resetPivotPoint

• resetPivotPoint(): void

  Resets the pivot point to billboard the target about its own origin. Recommended to use after finishing some spatial interaction that sets the pivotPoint of this component manually.

  Returns void

resetRotation

• resetRotation(): void

  Returns void

resetRotationToLookAtCamera

• resetRotationToLookAtCamera(): void

  Immediately resets rotation to directly look at the camera, ignoring current axis enabled/disabled states, buffer degrees, and easing.

  Returns void

setPivot

• setPivot(pivotPoint: vec3, interactor: Interactor): void

  Set the pivot point and pivoting Interactor to control the Billboard's pivot axis. To turn off pivoting about a point, reset the pivot point to vec3.zero()

  Parameters

  • pivotPoint: vec3

    the pivot point to billboard the target about in local space.
  • interactor: Interactor

    the pivoting Interactor.

  Returns void