Nuitrack  1.4.1
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  tdv::nuitrack::SkeletonTracker
 Represents the interface to the capabilities of the Nuitrack Skeleton Tracker module. More...
 
struct  tdv::nuitrack::Joint
 Stores the joint data. More...
 
struct  tdv::nuitrack::Skeleton
 Stores the data of the skeleton. More...
 
class  tdv::nuitrack::SkeletonData
 Stores the data of all available skeletons at a certain point in time. More...
 

Enumerations

enum  tdv::nuitrack::JointType {
  tdv::nuitrack::JOINT_NONE,
  tdv::nuitrack::JOINT_HEAD,
  tdv::nuitrack::JOINT_NECK,
  tdv::nuitrack::JOINT_TORSO,
  tdv::nuitrack::JOINT_WAIST,
  tdv::nuitrack::JOINT_LEFT_COLLAR,
  tdv::nuitrack::JOINT_LEFT_SHOULDER,
  tdv::nuitrack::JOINT_LEFT_ELBOW,
  tdv::nuitrack::JOINT_LEFT_WRIST,
  tdv::nuitrack::JOINT_LEFT_HAND,
  tdv::nuitrack::JOINT_LEFT_FINGERTIP,
  tdv::nuitrack::JOINT_RIGHT_COLLAR,
  tdv::nuitrack::JOINT_RIGHT_SHOULDER,
  tdv::nuitrack::JOINT_RIGHT_ELBOW,
  tdv::nuitrack::JOINT_RIGHT_WRIST,
  tdv::nuitrack::JOINT_RIGHT_HAND,
  tdv::nuitrack::JOINT_RIGHT_FINGERTIP,
  tdv::nuitrack::JOINT_LEFT_HIP,
  tdv::nuitrack::JOINT_LEFT_KNEE,
  tdv::nuitrack::JOINT_LEFT_ANKLE,
  tdv::nuitrack::JOINT_LEFT_FOOT,
  tdv::nuitrack::JOINT_RIGHT_HIP,
  tdv::nuitrack::JOINT_RIGHT_KNEE,
  tdv::nuitrack::JOINT_RIGHT_ANKLE,
  tdv::nuitrack::JOINT_RIGHT_FOOT
}
 Joint index meaning (please note that JOINT_LEFT_FINGERTIP, JOINT_RIGHT_FINGERTIP, JOINT_LEFT_FOOT, JOINT_RIGHT_FOOT 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 Nuitrack Skeleton Tracker module, you can track up to 6 user skeletons. By default, the skeleton of 2 users is tracked (tracking of more than 2 users may lead to performance loss). 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, if auto tracking option is enabled. You can enable or disable auto tracking with SkeletonTracker::setAutoTracking. To start or stop tracking of the skeleton of a particular user manually, use SkeletonTracker::startTracking or SkeletonTracker::stopTracking respectively.

The user skeletal data are represented in the Skeleton structure.

Enumeration Type Documentation

Joint index meaning (please note that JOINT_LEFT_FINGERTIP, JOINT_RIGHT_FINGERTIP, JOINT_LEFT_FOOT, JOINT_RIGHT_FOOT are not used in the current version).

Enumerator
JOINT_NONE 

Reserved joint (unused).

JOINT_HEAD 

Head.

JOINT_NECK 

Neck.

JOINT_TORSO 

Torso.

JOINT_WAIST 

Waist.

JOINT_LEFT_COLLAR 

Left collar.

JOINT_LEFT_SHOULDER 

Left shoulder.

JOINT_LEFT_ELBOW 

Left elbow.

JOINT_LEFT_WRIST 

Left wrist.

JOINT_LEFT_HAND 

Left hand.

JOINT_LEFT_FINGERTIP 

Left fingertip (not used in the current version).

JOINT_RIGHT_COLLAR 

Right collar.

JOINT_RIGHT_SHOULDER 

Right shoulder.

JOINT_RIGHT_ELBOW 

Right elbow.

JOINT_RIGHT_WRIST 

Right wrist.

JOINT_RIGHT_HAND 

Right hand.

JOINT_RIGHT_FINGERTIP 

Right fingertip (not used in the current version).

JOINT_LEFT_HIP 

Left hip.

JOINT_LEFT_KNEE 

Left knee.

JOINT_LEFT_ANKLE 

Left ankle.

JOINT_LEFT_FOOT 

Left foot (not used in the current version).

JOINT_RIGHT_HIP 

Right hip.

JOINT_RIGHT_KNEE 

Right knee.

JOINT_RIGHT_ANKLE 

Right ankle.

JOINT_RIGHT_FOOT 

Right foot (not used in the current version).