Skip to main content
Version: 21 Aug 2024

MLHandTracking

Public Methods

string GetKeyPointName

public static string GetKeyPointName(
KeyPointLocation location,
int keyPointIndex
)

Parameters

TypeNameDescription
KeyPointLocationlocation
intkeyPointIndex

bool GetKeyPointStatus

public static bool GetKeyPointStatus(
InputDevice handDevice,
KeyPointLocation location,
int keyPointIndex
)

Parameters

TypeNameDescription
InputDevicehandDevice
KeyPointLocationlocation
intkeyPointIndex

void SetPreRenderHandUpdate

By default the keypoints data is updated twice. To turn this off set enable to false to potentially improve performance. This is not recommended if keypoints are visual in the app as it will significantly decrease the smoothness of visuals.

public static void SetPreRenderHandUpdate(
bool enable =true
)

Parameters

TypeNameDescription
boolenable

void StartTracking

public static void StartTracking()

void StopTracking

public static void StopTracking()

bool TryGetKeyPointsMask

public static bool TryGetKeyPointsMask(
InputDevice handDevice,
out bool [] keyPointsMask
)

Parameters

TypeNameDescription
InputDevicehandDevice
out bool []keyPointsMask

Public Attributes

MaxKeyPoints

The max number of key points to track.


public const int MaxKeyPoints = 28;


Public Enums

HandType

Represents if a hand is the right or left hand.

EnumeratorValueDescription
LeftLeft hand.
RightRight hand.

KeyPointLocation

EnumeratorValueDescription
Thumb0
Index4
Middle8
Ring12
Pinky16
Wrist20
Center23
FifthBone24

KeyPoints

EnumeratorValueDescription
Thumb_Tip0
Thumb_IP
Thumb_MCP
Thumb_CMC
Index_Tip
Index_DIP
Index_PIP
Index_MCP
Middle_Tip
Middle_DIP
Middle_PIP
Middle_MCP
Ring_Tip
Ring_DIP
Ring_PIP
Ring_MCP
Pinky_Tip
Pinky_DIP
Pinky_PIP
Pinky_MCP
Wrist_Center
Wrist_Ulnar
Wrist_Radial
Hand_Center
Index_CMC
Middle_CMC
Ring_CMC
Pinky_CMC