Class default

HeadlockRotationCalculator is used to calculate the offset to position an object to maintain a certain offset relative to where the user is looking.

Constructors

constructor

Properties

_axisBufferRadians _axisEasing _axisEnabled _axisOffsetRadians _distance axis duration

Accessors

axisBufferRadians axisEasing axisEnabled axisOffsetRadians distance

Methods

calculateAngleDelta calculateRotationOffset getOffset skipRotation

Constructors

constructor

Properties

Private_axisBufferRadians

_axisBufferRadians: number = 0

Private_axisEasing

_axisEasing: number = 0

Private_axisEnabled

_axisEnabled: boolean = true

Private_axisOffsetRadians

_axisOffsetRadians: number = 0

Private_distance

_distance: number = 50

Privateaxis

axis: RotationAxis

Privateduration

duration: number

Accessors

axisBufferRadians

  • get axisBufferRadians(): number

    Returns number

  • set axisBufferRadians(radians: number): void

    Parameters

    • radians: number

    Returns void

axisEasing

  • get axisEasing(): number

    Returns number

  • set axisEasing(easing: number): void

    Parameters

    • easing: number

    Returns void

axisEnabled

  • get axisEnabled(): boolean

    Returns boolean

  • set axisEnabled(enabled: boolean): void

    Parameters

    • enabled: boolean

    Returns void

axisOffsetRadians

  • get axisOffsetRadians(): number

    Returns number

  • set axisOffsetRadians(radians: number): void

    Parameters

    • radians: number

    Returns void

distance

  • get distance(): number

    Returns number

  • set distance(distance: number): void

    Parameters

    • distance: number

    Returns void

Methods

PrivatecalculateAngleDelta

  • calculateAngleDelta(
        axisVector: vec3,
        positionVector: vec3,
        originVector: vec3,
        forwardVector: vec3,
        upVector?: vec3,
    ): number

    Returns the angle about specified axis to rotate the target to align with the camera. By projecting the forward/up vector onto planes defined by the relevant axis as the normal, we can separately calculate the angles of each axis. The separate calculations allow for each axis to have its own buffer / interpolation values. Because the user is expected to walk around freely, we use local X and Z axes for calculation, but global Y axis as the user's perception of 'up' is constant.

    Parameters

    Returns number

PrivatecalculateRotationOffset

  • calculateRotationOffset(
        angle: number,
        axisVector: vec3,
        positionVector: vec3,
    ): vec3

    Parameters

    • angle: number
    • axisVector: vec3
    • positionVector: vec3

    Returns vec3

getOffset

  • getOffset(
        axisVector: vec3,
        positionVector: vec3,
        originVector: vec3,
        forwardVector: vec3,
        upVector?: vec3,
    ): vec3

    Returns the offset to move the target by based on the following vectors

    Parameters

    • axisVector: vec3

      the axis to rotate the target about

    • positionVector: vec3

      the current local position of the target relative to headlock center

    • originVector: vec3

      the vector to calculate an origin of rotation to determine counterclockwise or clockwise rotation

    • forwardVector: vec3

      the current look vector of the headlock controller

    • OptionalupVector: vec3

    Returns vec3

PrivateskipRotation

  • skipRotation(): boolean

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
MMNEPVFCICPMFPCPTTAAATR