Class BoneLookController

constructor

• new BoneLookController(
      mesh: TransformNode,
      bone: Bone,
      target: Vector3,
      options?: {
          adjustPitch?: number;
          adjustRoll?: number;
          adjustYaw?: number;
          maxPitch?: number;
          maxYaw?: number;
          minPitch?: number;
          minYaw?: number;
          pitchAxis?: Vector3;
          slerpAmount?: number;
          upAxis?: Vector3;
          upAxisSpace?: Space;
          useAbsoluteValueForYaw?: boolean;
          yawAxis?: Vector3;
      },
  ): BoneLookController

  Create a BoneLookController

  Parameters

  • mesh: TransformNode

    the TransformNode that the bone belongs to

  • bone: Bone

    the bone that will be looking to the target

  • target: Vector3

    the target Vector3 to look at

  • Optionaloptions: {
        adjustPitch?: number;
        adjustRoll?: number;
        adjustYaw?: number;
        maxPitch?: number;
        maxYaw?: number;
        minPitch?: number;
        minYaw?: number;
        pitchAxis?: Vector3;
        slerpAmount?: number;
        upAxis?: Vector3;
        upAxisSpace?: Space;
        useAbsoluteValueForYaw?: boolean;
        yawAxis?: Vector3;
    }

    optional settings:

    • maxYaw: the maximum angle the bone will yaw to
    • minYaw: the minimum angle the bone will yaw to
    • maxPitch: the maximum angle the bone will pitch to
    • minPitch: the minimum angle the bone will yaw to
    • slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
    • upAxis: the up axis of the coordinate system
    • upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
    • yawAxis: set yawAxis if the bone does not yaw on the y axis
    • pitchAxis: set pitchAxis if the bone does not pitch on the x axis
    • adjustYaw: used to make an adjustment to the yaw of the bone
    • adjustPitch: used to make an adjustment to the pitch of the bone
    • adjustRoll: used to make an adjustment to the roll of the bone

  Returns BoneLookController

adjustPitch

adjustRoll

adjustYaw

bone

mesh

slerpAmount

target

upAxis

upAxisSpace

useAbsoluteValueForYaw

maxPitch

• get maxPitch(): number

  Gets or sets the maximum pitch angle that the bone can look to

  Returns number

• set maxPitch(value: number): void

  Parameters

  • value: number

  Returns void

maxYaw

• get maxYaw(): number

  Gets or sets the maximum yaw angle that the bone can look to

  Returns number

• set maxYaw(value: number): void

  Parameters

  • value: number

  Returns void

minPitch

• get minPitch(): number

  Gets or sets the minimum pitch angle that the bone can look to

  Returns number

• set minPitch(value: number): void

  Parameters

  • value: number

  Returns void

minYaw

• get minYaw(): number

  Gets or sets the minimum yaw angle that the bone can look to

  Returns number

• set minYaw(value: number): void

  Parameters

  • value: number

  Returns void

update

• update(): void

  Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())

  Returns void