nuitrack.UserTracker Class Reference

Represents the interface to the capabilities of the Nuitrack User Tracker module. More...

Inherits nuitrack.Module.

Public Member Functions
delegate void	OnNewUser (int userID)
delegate void	OnLostUser (int userID)
delegate void	OnUpdate (UserFrame frame)
virtual UserFrame	GetUserFrame ()
	Get the user frame. More...
abstract float	GetProcessingTime ()
	Gets the processing time of the last frame. More...
Public Member Functions inherited from nuitrack.Module
String	GetPerformanceInfo ()
virtual void	Release ()
void	subscribe ()

Static Public Member Functions
static UserTracker	Create ()
	Initializes a new instance of the nuitrack.UserTracker class.

Protected Member Functions
void	SignalOnNewUser (int userID)
void	SignalOnLostUser (int userID)
void	SignalOnUpdate (UserFrame userFrame)
Protected Member Functions inherited from nuitrack.Module
void	unsubscribe ()
abstract void	subscribeImpl ()
abstract void	unsubscribeImpl ()

Protected Attributes
UserFrame	frame
Protected Attributes inherited from nuitrack.Module
System.IntPtr	ptr
int	usageCount
int	isSubscribed
long	lastCall

Properties
OnUpdate	OnUpdateEvent
	Raised when the module data is updated.
OnNewUser	OnNewUserEvent
	Raised when the new user is detected.
OnLostUser	OnLostUserEvent
	Raised when the user is lost.
Properties inherited from nuitrack.Module
System.IntPtr	Ptr [get]
	Gets the native ptr. More...

Detailed Description

Represents the interface to the capabilities of the Nuitrack User Tracker module.

To enable the module, you must create an instance of this class. To create the instance, use UserTracker Create() method. This instance is called UserTracker module object.

Member Function Documentation

abstract float nuitrack.UserTracker.GetProcessingTime ( )

pure virtual

Gets the processing time of the last frame.

Returns

The processing time of the last frame in ms.

virtual UserFrame nuitrack.UserTracker.GetUserFrame ( )

inlinevirtual

Get the user frame.

Returns

The user frame.

void nuitrack.UserTracker.SignalOnLostUser ( int  userID )

inlineprotected

Warning

For internal use only.

void nuitrack.UserTracker.SignalOnNewUser ( int  userID )

inlineprotected

Warning

For internal use only.

void nuitrack.UserTracker.SignalOnUpdate ( UserFrame  userFrame )

inlineprotected

Warning

For internal use only.

Member Data Documentation

UserFrame nuitrack.UserTracker.frame

protected

Warning

For internal use only.