Lens Scripting API
    Preparing search index...

    Class BillboardRotationCalculator

    BillboardRotationCalculator is used to calculate the quaternion to rotate an object by to align with a new vector along an axis. More specifically, this calculator is used along a SceneObject's local X/Z-axes and global Y-axis. These calculators only take in vec3's as SceneObject manipulation is handled in BillboardController.

    Index

    Constructors

    constructor

    Accessors

    axisBufferRadians axisEasing axisEnabled

    Methods

    getRotation resetRotation

    Constructors

    Accessors

    • get axisBufferRadians(): number

      Returns number

    • set axisBufferRadians(radians: number): void

      Parameters

      • radians: number

      Returns void

    • get axisEasing(): number

      Gets the axis easing value (0-1). See RotationCalculatorConfig.axisEasing for detailed documentation.

      Returns number

    • set axisEasing(easing: number): void

      Sets the axis easing value (0-1). Typical values: 0.2-0.3 for smooth lag, 1.0 for instant rotation. See RotationCalculatorConfig.axisEasing for detailed documentation.

      Parameters

      • easing: number

      Returns void

    • get axisEnabled(): boolean

      Returns boolean

    • set axisEnabled(enabled: boolean): void

      Parameters

      • enabled: boolean

      Returns void

    Methods

    • Parameters

      • axisVector: vec3
      • forwardVector: vec3
      • cameraVector: vec3
      • originVector: vec3
      • deltaTime: number

      Returns quat

    • Used to snap the target immediately into proper rotation according to configuration.

      Parameters

      • axisVector: vec3

        the vector to rotate about

      • forwardVector: vec3

        the forward vector of the target

      • cameraVector: vec3

        the vector from camera to target

      • originVector: vec3

        the origin of rotation as a reference to ensure proper rotation

      Returns quat

      the rotation about the given axis to align the target's forward vector with the camera.

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods