Struct XRFingerShapeConfigurationState

Configuration values for how to calculate XRFingerShape stored in XRFingerShapeConfiguration. Defines minimum and maximum angles or distances between joints to normalize finger joints into each XRFingerStateType's 0 to 1 value.

Implements

IEquatable<XRFingerShapeConfigurationState>

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.XR.Hands.Gestures

Assembly: Unity.XR.Hands.dll

Syntax

[Serializable]
public struct XRFingerShapeConfigurationState : IEquatable<XRFingerShapeConfigurationState>

Properties

maximumBaseCurlDegrees

The maximum angle between the central flex joint and its closest neighbors. When the angle between those two vectors is greater than or equal to this value, the flex value will be 0.

Declaration

public float maximumBaseCurlDegrees { get; set; }

Property Value

Type	Description
float

maximumFullCurlDegrees1

The maximum degrees between vectors from the first extension joint to its closest neighbors.

Declaration

public float maximumFullCurlDegrees1 { get; set; }

Property Value

Type	Description
float

maximumFullCurlDegrees2

The maximum angle between the second extension joint and its closest neighbors.

Declaration

public float maximumFullCurlDegrees2 { get; set; }

Property Value

Type	Description
float

maximumFullCurlDegrees3

The maximum angle between the third extension joint and its closest neighbors. Ignored on the thumb.

Declaration

public float maximumFullCurlDegrees3 { get; set; }

Property Value

Type	Description
float

maximumPinchDistance

The maximum distance between each finger tip and the thumb tip which allows for non-zero pinch values.

Declaration

public float maximumPinchDistance { get; set; }

Property Value

Type	Description
float

maximumSpreadDegrees

The maximum degrees for splay between this finger and the next. Not used for the little finger.

Declaration

public float maximumSpreadDegrees { get; set; }

Property Value

Type	Description
float

maximumTipCurlDegrees1

The maximum degrees between vectors from the first curl joint to its closest neighbors.

Declaration

public float maximumTipCurlDegrees1 { get; set; }

Property Value

Type	Description
float

maximumTipCurlDegrees2

The maximum degrees between vectors from the second curl joint to its closest neighbors.

Declaration

public float maximumTipCurlDegrees2 { get; set; }

Property Value

Type	Description
float

minimumBaseCurlDegrees

The minimum angle between the central flex joint and its closest neighbors. When the angle between those two vectors is less than or equal to this value, the flex value will be 1.

Declaration

public float minimumBaseCurlDegrees { get; set; }

Property Value

Type	Description
float

minimumFullCurlDegrees1

The minimum degrees between vectors from the first extension joint to its closest neighbors.

Declaration

public float minimumFullCurlDegrees1 { get; set; }

Property Value

Type	Description
float

minimumFullCurlDegrees2

The minimum angle between the second extension joint and its closest neighbors.

Declaration

public float minimumFullCurlDegrees2 { get; set; }

Property Value

Type	Description
float

minimumFullCurlDegrees3

The minimum angle between the third extension joint and its closest neighbors. Ignored on the thumb.

Declaration

public float minimumFullCurlDegrees3 { get; set; }

Property Value

Type	Description
float

minimumPinchDistance

The minimum distance between each finger tip and the thumb tip to calculate pinch values for. Values below or equal to this will result in a pinch value of 1.

Declaration

public float minimumPinchDistance { get; set; }

Property Value

Type	Description
float

minimumSpreadDegrees

The minimum degrees for splay between this finger and the next. Not used for the little finger.

Declaration

public float minimumSpreadDegrees { get; set; }

Property Value

Type	Description
float

minimumTipCurlDegrees1

The minimum degrees between vectors from the first curl joint to its closest neighbors.

Declaration

public float minimumTipCurlDegrees1 { get; set; }

Property Value

Type	Description
float

minimumTipCurlDegrees2

The minimum degrees between vectors from the second curl joint to its closest neighbors.

Declaration

public float minimumTipCurlDegrees2 { get; set; }

Property Value

Type	Description
float

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
bool	Returns true if obj is of type XRFingerShapeConfigurationState and Equals(XRFingerShapeConfigurationState) also returns true; otherwise returns false.

Overrides

ValueType.Equals(object)

Equals(XRFingerShapeConfigurationState)

Tests for equality.

Declaration

public bool Equals(XRFingerShapeConfigurationState other)

Parameters

Type	Name	Description
XRFingerShapeConfigurationState	other	The XRFingerShapeConfigurationState to compare against.

Returns

Type	Description
bool	Returns true if every field in other is equal to this XRFingerShapeConfigurationState. Returns false otherwise.

GetHashCode()

Computes a hash code from all fields of XRFingerShapeConfigurationState.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	Returns a hash code of this object.

Overrides

ValueType.GetHashCode()

Operators

operator ==(XRFingerShapeConfigurationState, XRFingerShapeConfigurationState)

Tests for equality. Same as Equals(XRFingerShapeConfigurationState).

Declaration

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

Parameters

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

Returns

Type	Description
bool	Returns true if lhs is equal to rhs, otherwise returns false.

operator !=(XRFingerShapeConfigurationState, XRFingerShapeConfigurationState)

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

Declaration

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

Parameters

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

Returns

Type	Description
bool	Returns true if lhs is not equal to rhs, otherwise returns false.

Implements

IEquatable<T>