Nuitrack  1.4.0
3D Skeleton Tracking Middleware
nuitrack.UserFrame Class Reference

Represents a user map with the information about the floor. More...

Inheritance diagram for nuitrack.UserFrame:
Inheritance graph

Public Member Functions

User GetUserByID (int id)
 Get the user by ID. More...
 
- Public Member Functions inherited from nuitrack.Frame< UInt16 >
GetAt (int row, int col)
 Get the number of rows and columns. More...
 
GetAt (int i)
 Get the value of i-th element. More...
 

Protected Member Functions

override UInt16 GetValue (int i)
 
override UInt16 GetValue (int row, int col)
 

Protected Attributes

int numUsers
 
User[] users
 
Vector3 floor
 
Vector3 floorNormal
 
- Protected Attributes inherited from nuitrack.Frame< UInt16 >
int rows
 
int cols
 
ulong id
 
ulong timestamp
 
byte[] data
 

Properties

int NumUsers [get, set]
 Get the number of users. More...
 
User[] Users [get, set]
 Get the users. More...
 
Vector3 Floor [get, set]
 Get the floor in the form of a point. More...
 
Vector3 FloorNormal [get, set]
 Get the floor in the form of a normal vector. More...
 
- Properties inherited from nuitrack.Frame< UInt16 >
int Rows [get, set]
 Get the number of rows in a frame. More...
 
int Cols [get, set]
 Get the number of columns in a frame. More...
 
ulong ID [get]
 Get the frame ID. More...
 
ulong Timestamp [get, set]
 Get the frame timestamp. More...
 
this[int row, int col] [get]
 Get the value of nuitrack.Frame element with the specified row and column. More...
 
this[int i] [get]
 Get the value of nuitrack.Frame i-th element. More...
 
byte[] Data [get, set]
 Get the data. More...
 

Detailed Description

Represents a user map with the information about the floor.

Each UserFrame element stores the ID of a user to which the corresponding frame pixel belongs.

The floor is represented in the form of a plane: as a point and a normal vector. This properties can be accessed via UserFrame::Vector3.Floor and UserFrame::Vector3.FloorNormal respectively.

Member Function Documentation

User nuitrack.UserFrame.GetUserByID ( int  id)
inline

Get the user by ID.

Parameters
[in]idIdentifier
Returns
User identified by ID or an empty user.
override UInt16 nuitrack.UserFrame.GetValue ( int  i)
inlineprotectedvirtual
Warning
For internal use only.

Implements nuitrack.Frame< UInt16 >.

override UInt16 nuitrack.UserFrame.GetValue ( int  row,
int  col 
)
inlineprotectedvirtual
Warning
For internal use only.

Implements nuitrack.Frame< UInt16 >.

Member Data Documentation

int nuitrack.UserFrame.numUsers
protected
Warning
For internal use only.

Property Documentation

Vector3 nuitrack.UserFrame.Floor
getset

Get the floor in the form of a point.

Returns
The floor in the form of a point.
Vector3 nuitrack.UserFrame.FloorNormal
getset

Get the floor in the form of a normal vector.

Returns
The floor in the form of a normal vector.
int nuitrack.UserFrame.NumUsers
getset

Get the number of users.

Returns
The number of users.
User [] nuitrack.UserFrame.Users
getset

Get the users.

Returns
The users.