Packagecom.as3nui.nativeExtensions.air.kinect.data
Classpublic class User
InheritanceUser Inheritance Object
Subclasses MSUser, OpenNIUser

This class represents a user, tracked by the kinect.

A user doesn't necessarily have a tracked skeleton, but will always have a position. You can use the hasSkeleton property, to check if a user has a tracked skeleton.

You can access the skeleton information through different properties and methods:

When you enable user masking in the kinect config, the userMask property will contain the rgb pixels for this user.



Public Properties
 PropertyDefined By
  framework : String
Framework used to generate this skeleton
User
  hasSkeleton : Boolean
Does this user have a calibrated skeleton or not?
User
  head : SkeletonJoint
[read-only]
User
  leftElbow : SkeletonJoint
[read-only]
User
  leftFoot : SkeletonJoint
[read-only]
User
  leftHand : SkeletonJoint
[read-only]
User
  leftHip : SkeletonJoint
[read-only]
User
  leftKnee : SkeletonJoint
[read-only]
User
  leftShoulder : SkeletonJoint
[read-only]
User
  neck : SkeletonJoint
[read-only]
User
  position : Position
Position of the user
User
  rightElbow : SkeletonJoint
[read-only]
User
  rightFoot : SkeletonJoint
[read-only]
User
  rightHand : SkeletonJoint
[read-only]
User
  rightHip : SkeletonJoint
[read-only]
User
  rightKnee : SkeletonJoint
[read-only]
User
  rightShoulder : SkeletonJoint
[read-only]
User
  skeletonBoneNames : Vector.<String>
List of all skeleton bone names for this user
User
  skeletonBones : Vector.<SkeletonBone>
Collection of Skeleton bones
User
  skeletonJointNames : Vector.<String>
List of all skeleton joint names for this user
User
  skeletonJoints : Vector.<SkeletonJoint>
Collection of Skeleton joints
User
  torso : SkeletonJoint
[read-only]
User
  trackingID : uint
Current user Tracking ID
User
  userID : uint
Current user User ID
User
  userMaskData : BitmapData
User Mask Bitmapdata
User
Public Methods
 MethodDefined By
  
User
  
copyFrom(otherUser:User):void
Copies the properties from the other user into this instance
User
  
getBoneByName(boneName:String):SkeletonBone
Get a bone by it's name
User
  
getJointByName(jointName:String):SkeletonJoint
Get a joint by it's name
User
Property Detail
frameworkproperty
public var framework:String

Framework used to generate this skeleton

See also

hasSkeletonproperty 
public var hasSkeleton:Boolean

Does this user have a calibrated skeleton or not?

headproperty 
head:SkeletonJoint  [read-only]


Implementation
    public function get head():SkeletonJoint
leftElbowproperty 
leftElbow:SkeletonJoint  [read-only]


Implementation
    public function get leftElbow():SkeletonJoint
leftFootproperty 
leftFoot:SkeletonJoint  [read-only]


Implementation
    public function get leftFoot():SkeletonJoint
leftHandproperty 
leftHand:SkeletonJoint  [read-only]


Implementation
    public function get leftHand():SkeletonJoint
leftHipproperty 
leftHip:SkeletonJoint  [read-only]


Implementation
    public function get leftHip():SkeletonJoint
leftKneeproperty 
leftKnee:SkeletonJoint  [read-only]


Implementation
    public function get leftKnee():SkeletonJoint
leftShoulderproperty 
leftShoulder:SkeletonJoint  [read-only]


Implementation
    public function get leftShoulder():SkeletonJoint
neckproperty 
neck:SkeletonJoint  [read-only]


Implementation
    public function get neck():SkeletonJoint
positionproperty 
public var position:Position

Position of the user

rightElbowproperty 
rightElbow:SkeletonJoint  [read-only]


Implementation
    public function get rightElbow():SkeletonJoint
rightFootproperty 
rightFoot:SkeletonJoint  [read-only]


Implementation
    public function get rightFoot():SkeletonJoint
rightHandproperty 
rightHand:SkeletonJoint  [read-only]


Implementation
    public function get rightHand():SkeletonJoint
rightHipproperty 
rightHip:SkeletonJoint  [read-only]


Implementation
    public function get rightHip():SkeletonJoint
rightKneeproperty 
rightKnee:SkeletonJoint  [read-only]


Implementation
    public function get rightKnee():SkeletonJoint
rightShoulderproperty 
rightShoulder:SkeletonJoint  [read-only]


Implementation
    public function get rightShoulder():SkeletonJoint
skeletonBoneNamesproperty 
public var skeletonBoneNames:Vector.<String>

List of all skeleton bone names for this user

skeletonBonesproperty 
public var skeletonBones:Vector.<SkeletonBone>

Collection of Skeleton bones

skeletonJointNamesproperty 
public var skeletonJointNames:Vector.<String>

List of all skeleton joint names for this user

skeletonJointsproperty 
public var skeletonJoints:Vector.<SkeletonJoint>

Collection of Skeleton joints

torsoproperty 
torso:SkeletonJoint  [read-only]


Implementation
    public function get torso():SkeletonJoint
trackingIDproperty 
public var trackingID:uint

Current user Tracking ID

userIDproperty 
public var userID:uint

Current user User ID

userMaskDataproperty 
public var userMaskData:BitmapData

User Mask Bitmapdata

Constructor Detail
User()Constructor
public function User()



Method Detail
copyFrom()method
public function copyFrom(otherUser:User):void

Copies the properties from the other user into this instance

Parameters

otherUser:User

getBoneByName()method 
public function getBoneByName(boneName:String):SkeletonBone

Get a bone by it's name

Parameters

boneName:String

Returns
SkeletonBone
getJointByName()method 
public function getJointByName(jointName:String):SkeletonJoint

Get a joint by it's name

Parameters

jointName:String

Returns
SkeletonJoint