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.

Index

Constructors

Accessors

axisBufferRadians axisEasing axisEnabled axisOffsetRadians distance

Methods

Constructors

constructor

new default(config: RotationCalculatorConfig): default
Parameters
- config: RotationCalculatorConfig
Returns default

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

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