Struct ARKitBlendShapeCoefficient

An entry that specifies how much of a specific ARKitBlendShapeLocation is present in the current expression on the face.

Inherited Members

ValueType.ToString()

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetType()

Namespace: UnityEngine.XR.ARKit

Syntax

public struct ARKitBlendShapeCoefficient : IEquatable<ARKitBlendShapeCoefficient>

Remarks

Call GetBlendShapeCoefficients(TrackableId, Allocator) to get the list of coefficients for each blend shape location of the current facial expression.

Properties

blendShapeLocation

The specific ARKitBlendShapeLocation being examined.

Declaration

public readonly ARKitBlendShapeLocation blendShapeLocation { get; }

Property Value

Type	Description
ARKitBlendShapeLocation	Identifies the action unit for this coefficient value.

coefficient

A value from 0.0 to 1.0 that specifies how active the associated ARKitBlendShapeLocation is in this expression.

Declaration

public readonly float coefficient { get; }

Property Value

Type	Description
Single	A coefficient of zero represents a neutral position of this blend shape, while a coefficient of one represents a fully articulated position.

Methods

Equals(Object)

Tests for equality.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj	The object to compare against.

Returns

Type	Description
Boolean	True if obj is of type ARKitBlendShapeCoefficient and Equals(ARKitBlendShapeCoefficient) also returns true; otherwise false.

Overrides

ValueType.Equals(Object)

Equals(ARKitBlendShapeCoefficient)

Tests for equality.

Declaration

public bool Equals(ARKitBlendShapeCoefficient other)

Parameters

Type	Name	Description
ARKitBlendShapeCoefficient	other	The other ARKitBlendShapeCoefficient to compare against.

Returns

Type	Description
Boolean	True if every field in other is equal to this ARKitBlendShapeCoefficient, otherwise false.

Implements

IEquatable<T>.Equals(T)

GetHashCode()

Generates a hash suitable for use with containers like HashSet and Dictionary.

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32	A hash code generated from this object's fields.

Overrides

ValueType.GetHashCode()

Operators

Equality(ARKitBlendShapeCoefficient, ARKitBlendShapeCoefficient)

Tests for equality. Same as Equals(ARKitBlendShapeCoefficient).

Declaration

public static bool operator ==(ARKitBlendShapeCoefficient lhs, ARKitBlendShapeCoefficient rhs)

Parameters

Type	Name	Description
ARKitBlendShapeCoefficient	lhs	The left-hand side of the comparison.
ARKitBlendShapeCoefficient	rhs	The right-hand side of the comparison.

Returns

Type	Description
Boolean	True if lhs is equal to rhs, otherwise false.

Inequality(ARKitBlendShapeCoefficient, ARKitBlendShapeCoefficient)

Tests for inequality. Same as !Equals(ARKitBlendShapeCoefficient).

Declaration

public static bool operator !=(ARKitBlendShapeCoefficient lhs, ARKitBlendShapeCoefficient rhs)

Parameters

Type	Name	Description
ARKitBlendShapeCoefficient	lhs	The left-hand side of the comparison.
ARKitBlendShapeCoefficient	rhs	The right-hand side of the comparison.

Returns

Type	Description
Boolean	True if lhs is not equal to rhs, otherwise false.