Class VRMExpressionManager

constructor

• new VRMExpressionManager(): VRMExpressionManager

  Create a new VRMExpressionManager.

  Returns VRMExpressionManager

blinkExpressionNames

lookAtExpressionNames

mouthExpressionNames

customExpressionMap

• get customExpressionMap(): { [name: string]: VRMExpression }

  A map from name to expression, but excluding preset expressions.

  Returns { [name: string]: VRMExpression }

expressionMap

• get expressionMap(): { [name: string]: VRMExpression }

  Returns { [name: string]: VRMExpression }

expressions

• get expressions(): VRMExpression[]

  Returns VRMExpression[]

presetExpressionMap

• get presetExpressionMap(): {
      aa?: VRMExpression;
      angry?: VRMExpression;
      blink?: VRMExpression;
      blinkLeft?: VRMExpression;
      blinkRight?: VRMExpression;
      ee?: VRMExpression;
      happy?: VRMExpression;
      ih?: VRMExpression;
      lookDown?: VRMExpression;
      lookLeft?: VRMExpression;
      lookRight?: VRMExpression;
      lookUp?: VRMExpression;
      neutral?: VRMExpression;
      oh?: VRMExpression;
      ou?: VRMExpression;
      relaxed?: VRMExpression;
      sad?: VRMExpression;
      surprised?: VRMExpression;
  }

  A map from name to expression, but excluding custom expressions.

  Returns {
      aa?: VRMExpression;
      angry?: VRMExpression;
      blink?: VRMExpression;
      blinkLeft?: VRMExpression;
      blinkRight?: VRMExpression;
      ee?: VRMExpression;
      happy?: VRMExpression;
      ih?: VRMExpression;
      lookDown?: VRMExpression;
      lookLeft?: VRMExpression;
      lookRight?: VRMExpression;
      lookUp?: VRMExpression;
      neutral?: VRMExpression;
      oh?: VRMExpression;
      ou?: VRMExpression;
      relaxed?: VRMExpression;
      sad?: VRMExpression;
      surprised?: VRMExpression;
  }

clone

• clone(): VRMExpressionManager

  Returns a clone of this VRMExpressionManager.

  Returns VRMExpressionManager

  Copied VRMExpressionManager

copy

• copy(source: VRMExpressionManager): this

  Copy the given VRMExpressionManager into this one.

  Parameters

  • source: VRMExpressionManager

    The VRMExpressionManager you want to copy

  Returns this

  this

getExpression

• getExpression(name: string): null | VRMExpression

  Return a registered expression. If it cannot find an expression, it will return null instead.

  Parameters

  • name: string

    Name or preset name of the expression

  Returns null | VRMExpression

getExpressionTrackName

• getExpressionTrackName(name: string): null | string

  Get a track name of specified expression. This track name is needed to manipulate its expression via keyframe animations.

  Parameters

  • name: string

    Name of the expression

  Returns null | string

  Example: Manipulate an expression using keyframe animation

  const trackName = vrm.expressionManager.getExpressionTrackName( 'blink' );
  const track = new THREE.NumberKeyframeTrack(
    name,
    [ 0.0, 0.5, 1.0 ], // times
    [ 0.0, 1.0, 0.0 ] // values
  );
  
  const clip = new THREE.AnimationClip(
    'blink', // name
    1.0, // duration
    [ track ] // tracks
  );
  
  const mixer = new THREE.AnimationMixer( vrm.scene );
  const action = mixer.clipAction( clip );
  action.play();
  Copy

getValue

• getValue(name: string): null | number

  Get the current weight of the specified expression. If it doesn't have an expression of given name, it will return null instead.

  Parameters

  • name: string

    Name of the expression

  Returns null | number

registerExpression

• registerExpression(expression: VRMExpression): void

  Register an expression.

  Parameters

  • expression: VRMExpression

    VRMExpression that describes the expression

  Returns void

resetValues

• resetValues(): void

  Reset weights of all expressions to 0.0.

  Returns void

setValue

• setValue(name: string, weight: number): void

  Set a weight to the specified expression.

  Parameters

  • name: string

    Name of the expression
  • weight: number

    Weight

  Returns void

unregisterExpression

• unregisterExpression(expression: VRMExpression): void

  Unregister an expression.

  Parameters

  • expression: VRMExpression

    The expression you want to unregister

  Returns void

update

• update(): void

  Update every expressions.

  Returns void