Nuitrack  1.11.2
3D Skeleton Tracking Middleware
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events Groups Pages
Nuitrack Skeleton Tracker

This module provides access to user skeleton tracking capabilities. More...

Classes

class  nuitrack.SkeletonTracker
 Represents the interface to the capabilities of the Nuitrack Skeleton Tracker module. More...
 
struct  nuitrack.Joint
 Stores the joint data. More...
 
class  nuitrack.Skeleton
 Stores the skeleton data. More...
 
class  nuitrack.SkeletonData
 Stores the information about all available skeletons at a certain point in time. More...
 

Enumerations

enum  nuitrack.JointType {
  nuitrack.JointType.None,
  nuitrack.JointType.Head,
  nuitrack.JointType.Neck,
  nuitrack.JointType.Torso,
  nuitrack.JointType.Waist,
  nuitrack.JointType.LeftCollar,
  nuitrack.JointType.LeftShoulder,
  nuitrack.JointType.LeftElbow,
  nuitrack.JointType.LeftWrist,
  nuitrack.JointType.LeftHand,
  nuitrack.JointType.LeftFingertip,
  nuitrack.JointType.RightCollar,
  nuitrack.JointType.RightShoulder,
  nuitrack.JointType.RightElbow,
  nuitrack.JointType.RightWrist,
  nuitrack.JointType.RightHand,
  nuitrack.JointType.RightFingertip,
  nuitrack.JointType.LeftHip,
  nuitrack.JointType.LeftKnee,
  nuitrack.JointType.LeftAnkle,
  nuitrack.JointType.LeftFoot,
  nuitrack.JointType.RightHip,
  nuitrack.JointType.RightKnee,
  nuitrack.JointType.RightAnkle,
  nuitrack.JointType.RightFoot
}
 Joint index meaning (please note that LeftFingertip, RightFingertip, LeftFoot, RightFoot are not used in the current version). More...
 

Detailed Description

This module provides access to user skeleton tracking capabilities.

The main class of this module is SkeletonTracker. It contains functions for configuring the module and retrieving the results of its work.

With the Nuitrack Skeleton Tracker module you can track up to 6 user skeletons. A user whose skeleton is currently being tracked is called an active user. The maximum number of tracked skeletons can be changed via SkeletonTracker.SetNumActiveUsers. User skeleton tracking can be started automatically when the user appears in the frame, if autotracking option is enabled. You can enable or disable autotracking with SkeletonTracker.SetAutoTracking. To start or stop tracking of the particular user's skeleton manually, use SkeletonTracker.StartTracking or SkeletonTracker.StopTracking respectively.

The user skeletal data are represented in the Skeleton class.

Enumeration Type Documentation

Joint index meaning (please note that LeftFingertip, RightFingertip, LeftFoot, RightFoot are not used in the current version).

Enumerator
None 

Reserved joint (unused).

Head 

Head.

Neck 

Neck.

Torso 

Torso.

Waist 

Waist.

LeftCollar 

Left collar.

LeftShoulder 

Left shoulder.

LeftElbow 

Left elbow.

LeftWrist 

Left wrist.

LeftHand 

Left hand.

LeftFingertip 

Left fingertip (not used in the current version).

RightCollar 

Right collar.

RightShoulder 

Right shoulder.

RightElbow 

Right elbow.

RightWrist 

Right wrist.

RightHand 

Right hand.

RightFingertip 

Right fingertip (not used in the current version).

LeftHip 

Left hip.

LeftKnee 

Left knee.

LeftAnkle 

Left ankle.

LeftFoot 

Left foot (not used in the current version).

RightHip 

Right hip.

RightKnee 

Right knee.

RightAnkle 

Right ankle.

RightFoot 

Right foot (not used in the current version).