Struct FaceBlendShapePose

Stores a face pose as a set of blend shape weights.

Namespace: Unity.LiveCapture.ARKitFaceCapture

Assembly: Unity.LiveCapture.ARKitFaceCapture.dll

Syntax

[Serializable]
public struct FaceBlendShapePose

Fields

BrowDownLeft

The downward movement of the outer portion of the left eyebrow.

Declaration

[Range(0, 1)]
public float BrowDownLeft

Field Value

Type	Description
float

BrowDownRight

The downward movement of the outer portion of the right eyebrow.

Declaration

[Range(0, 1)]
public float BrowDownRight

Field Value

Type	Description
float

BrowInnerUp

The upward movement of the inner portion of both eyebrows.

Declaration

[Range(0, 1)]
public float BrowInnerUp

Field Value

Type	Description
float

BrowOuterUpLeft

The upward movement of the outer portion of the left eyebrow.

Declaration

[Range(0, 1)]
public float BrowOuterUpLeft

Field Value

Type	Description
float

BrowOuterUpRight

The upward movement of the outer portion of the right eyebrow.

Declaration

[Range(0, 1)]
public float BrowOuterUpRight

Field Value

Type	Description
float

CheekPuff

The outward movement of both cheeks.

Declaration

[Range(0, 1)]
public float CheekPuff

Field Value

Type	Description
float

CheekSquintLeft

The upward movement of the cheek around and below the left eye.

Declaration

[Range(0, 1)]
public float CheekSquintLeft

Field Value

Type	Description
float

CheekSquintRight

The upward movement of the cheek around and below the right eye.

Declaration

[Range(0, 1)]
public float CheekSquintRight

Field Value

Type	Description
float

EyeBlinkLeft

The closure of the eyelids over the left eye.

Declaration

[Range(0, 1)]
public float EyeBlinkLeft

Field Value

Type	Description
float

EyeBlinkRight

The closure of the eyelids over the right eye.

Declaration

[Range(0, 1)]
public float EyeBlinkRight

Field Value

Type	Description
float

EyeLookDownLeft

The movement of the left eyelids consistent with a downward gaze.

Declaration

[Range(0, 1)]
public float EyeLookDownLeft

Field Value

Type	Description
float

EyeLookDownRight

The movement of the right eyelids consistent with a downward gaze.

Declaration

[Range(0, 1)]
public float EyeLookDownRight

Field Value

Type	Description
float

EyeLookInLeft

The movement of the left eyelids consistent with a rightward gaze.

Declaration

[Range(0, 1)]
public float EyeLookInLeft

Field Value

Type	Description
float

EyeLookInRight

The movement of the right eyelids consistent with a leftward gaze.

Declaration

[Range(0, 1)]
public float EyeLookInRight

Field Value

Type	Description
float

EyeLookOutLeft

The movement of the left eyelids consistent with a leftward gaze.

Declaration

[Range(0, 1)]
public float EyeLookOutLeft

Field Value

Type	Description
float

EyeLookOutRight

The movement of the right eyelids consistent with a rightward gaze.

Declaration

[Range(0, 1)]
public float EyeLookOutRight

Field Value

Type	Description
float

EyeLookUpLeft

The movement of the left eyelids consistent with an upward gaze.

Declaration

[Range(0, 1)]
public float EyeLookUpLeft

Field Value

Type	Description
float

EyeLookUpRight

The movement of the right eyelids consistent with an upward gaze.

Declaration

[Range(0, 1)]
public float EyeLookUpRight

Field Value

Type	Description
float

EyeSquintLeft

The contraction of the face around the left eye.

Declaration

[Range(0, 1)]
public float EyeSquintLeft

Field Value

Type	Description
float

EyeSquintRight

The coefficient of the face around the right eye.

Declaration

[Range(0, 1)]
public float EyeSquintRight

Field Value

Type	Description
float

EyeWideLeft

The widening of the eyelids around the left eye.

Declaration

[Range(0, 1)]
public float EyeWideLeft

Field Value

Type	Description
float

EyeWideRight

The widening of the eyelids around the right eye.

Declaration

[Range(0, 1)]
public float EyeWideRight

Field Value

Type	Description
float

JawForward

The forward movement of the lower jaw.

Declaration

[Range(0, 1)]
public float JawForward

Field Value

Type	Description
float

JawLeft

The leftward movement of the lower jaw.

Declaration

[Range(0, 1)]
public float JawLeft

Field Value

Type	Description
float

JawOpen

The opening of the lower jaw.

Declaration

[Range(0, 1)]
public float JawOpen

Field Value

Type	Description
float

JawRight

The rightward movement of the lower jaw.

Declaration

[Range(0, 1)]
public float JawRight

Field Value

Type	Description
float

MouthClose

The closure of the lips independent of jaw position.

Declaration

[Range(0, 1)]
public float MouthClose

Field Value

Type	Description
float

MouthDimpleLeft

The backward movement of the left corner of the mouth.

Declaration

[Range(0, 1)]
public float MouthDimpleLeft

Field Value

Type	Description
float

MouthDimpleRight

The backward movement of the right corner of the mouth.

Declaration

[Range(0, 1)]
public float MouthDimpleRight

Field Value

Type	Description
float

MouthFrownLeft

The downward movement of the left corner of the mouth.

Declaration

[Range(0, 1)]
public float MouthFrownLeft

Field Value

Type	Description
float

MouthFrownRight

The downward movement of the right corner of the mouth.

Declaration

[Range(0, 1)]
public float MouthFrownRight

Field Value

Type	Description
float

MouthFunnel

The contraction of both lips into an open shape.

Declaration

[Range(0, 1)]
public float MouthFunnel

Field Value

Type	Description
float

MouthLeft

The leftward movement of both lips together.

Declaration

[Range(0, 1)]
public float MouthLeft

Field Value

Type	Description
float

MouthLowerDownLeft

The downward movement of the lower lip on the left side.

Declaration

[Range(0, 1)]
public float MouthLowerDownLeft

Field Value

Type	Description
float

MouthLowerDownRight

The downward movement of the lower lip on the right side.

Declaration

[Range(0, 1)]
public float MouthLowerDownRight

Field Value

Type	Description
float

MouthPressLeft

The upward compression of the lower lip on the left side.

Declaration

[Range(0, 1)]
public float MouthPressLeft

Field Value

Type	Description
float

MouthPressRight

The upward compression of the lower lip on the right side.

Declaration

[Range(0, 1)]
public float MouthPressRight

Field Value

Type	Description
float

MouthPucker

The contraction and compression of both closed lips.

Declaration

[Range(0, 1)]
public float MouthPucker

Field Value

Type	Description
float

MouthRight

The rightward movement of both lips together.

Declaration

[Range(0, 1)]
public float MouthRight

Field Value

Type	Description
float

MouthRollLower

The movement of the lower lip toward the inside of the mouth.

Declaration

[Range(0, 1)]
public float MouthRollLower

Field Value

Type	Description
float

MouthRollUpper

The movement of the upper lip toward the inside of the mouth.

Declaration

[Range(0, 1)]
public float MouthRollUpper

Field Value

Type	Description
float

MouthShrugLower

The outward movement of the lower lip.

Declaration

[Range(0, 1)]
public float MouthShrugLower

Field Value

Type	Description
float

MouthShrugUpper

The outward movement of the upper lip.

Declaration

[Range(0, 1)]
public float MouthShrugUpper

Field Value

Type	Description
float

MouthSmileLeft

The upward movement of the left corner of the mouth.

Declaration

[Range(0, 1)]
public float MouthSmileLeft

Field Value

Type	Description
float

MouthSmileRight

The upward movement of the right corner of the mouth.

Declaration

[Range(0, 1)]
public float MouthSmileRight

Field Value

Type	Description
float

MouthStretchLeft

The leftward movement of the left corner of the mouth.

Declaration

[Range(0, 1)]
public float MouthStretchLeft

Field Value

Type	Description
float

MouthStretchRight

The rightward movement of the left corner of the mouth.

Declaration

[Range(0, 1)]
public float MouthStretchRight

Field Value

Type	Description
float

MouthUpperUpLeft

The upward movement of the upper lip on the left side.

Declaration

[Range(0, 1)]
public float MouthUpperUpLeft

Field Value

Type	Description
float

MouthUpperUpRight

The upward movement of the upper lip on the right side.

Declaration

[Range(0, 1)]
public float MouthUpperUpRight

Field Value

Type	Description
float

NoseSneerLeft

The raising of the left side of the nose around the nostril.

Declaration

[Range(0, 1)]
public float NoseSneerLeft

Field Value

Type	Description
float

NoseSneerRight

The raising of the right side of the nose around the nostril.

Declaration

[Range(0, 1)]
public float NoseSneerRight

Field Value

Type	Description
float

ShapeCount

The number of supported blend shapes.

Declaration

public const int ShapeCount = 52

Field Value

Type	Description
int

TongueOut

The extension of the tongue.

Declaration

[Range(0, 1)]
public float TongueOut

Field Value

Type	Description
float

Properties

this[int]

The pose value for a blend shape at the given index.

Declaration

public float this[int index] { get; set; }

Parameters

Type	Name	Description
int	index	The blend shape index.

Property Value

Type	Description
float

Shapes

The face blend shapes, excluding shapes with a negative value.

Declaration

public static FaceBlendShape[] Shapes { get; }

Property Value

Type	Description
FaceBlendShape[]

Methods

FlipHorizontally()

Horizontally mirrors the face pose.

Declaration

public void FlipHorizontally()

Remarks

ARKit's default blend shapes are set so that 'right' indicates the right side of the face when viewing from the front.

GetValue(FaceBlendShape)

Gets the pose value for a blend shape.

Declaration

public float GetValue(FaceBlendShape location)

Parameters

Type	Name	Description
FaceBlendShape	location	The blend shape to get the value of.

Returns

Type	Description
float	The normalized blend shape influence.

LerpUnclamped(in FaceBlendShapePose, in FaceBlendShapePose, float, out FaceBlendShapePose)

Linearly interpolates between a and b by factor t.

Declaration

public static void LerpUnclamped(in FaceBlendShapePose a, in FaceBlendShapePose b, float t, out FaceBlendShapePose result)

Parameters

Type	Name	Description
FaceBlendShapePose	a	The pose to interpolate from.
FaceBlendShapePose	b	To pose to interpolate to.
float	t	The interpolation factor.
FaceBlendShapePose	result	The interpolated pose.

Remarks

* When t is 0 result is set to a. * When t is 1 result is set to b. * When t is 0.5 result is set to the midpoint of a and b.

SetValue(FaceBlendShape, float)

Sets the pose value for a blend shape.

Declaration

public void SetValue(FaceBlendShape location, float value)

Parameters

Type	Name	Description
FaceBlendShape	location	The blend shape to set the value of.
float	value	The normalized blend shape influence.