Nuitrack  1.3.10
3D Skeleton Tracking Middleware
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events Groups Pages
nuitrack.DepthSensor Class Referenceabstract

Represents the interface to the capabilities of the Nuitrack Depth Sensor module. More...

Inheritance diagram for nuitrack.DepthSensor:
Inheritance graph

Public Member Functions

delegate void OnUpdate (DepthFrame frame)
 
OutputMode GetOutputMode ()
 Get output mode of the depth sensor. More...
 
abstract bool IsMirror ()
 Determine the mirror mode state. More...
 
abstract void SetMirror (bool mirror)
 Set mirror mode. More...
 
DepthFrame GetDepthFrame ()
 Get the depth frame. More...
 
Vector3 ConvertProjToRealCoords (int x, int y, UInt16 depth)
 Convert projective coordinates to real world coordinates from x, y and the depth map. More...
 
Vector3 ConvertProjToRealCoords (Vector3 p)
 Convert projective coordinates to real world coordinates from the Vector3 point. More...
 
Vector3 ConvertRealToProjCoords (float x, float y, float z)
 Convert real world coordinates to projective coordinates from x, y, z. More...
 
Vector3 ConvertRealToProjCoords (Vector3 p)
 Convert real world coordinates to projective coordinates from the Vector3 point. More...
 
- Public Member Functions inherited from nuitrack.Module
String GetPerformanceInfo ()
 
virtual void Release ()
 
void subscribe ()
 

Static Public Member Functions

static DepthSensor Create ()
 Initializes a new instance of the nuitrack.DepthSensor class.
 

Protected Member Functions

void SignalOnUpdate (DepthFrame frame)
 
- Protected Member Functions inherited from nuitrack.Module
void unsubscribe ()
 
abstract void subscribeImpl ()
 
abstract void unsubscribeImpl ()
 

Protected Attributes

DepthFrame frame
 
OutputMode mode
 
float cX
 
float cY
 
float fX
 
float fY
 
- 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.
 
- 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 Depth Sensor module.

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

Member Function Documentation

Vector3 nuitrack.DepthSensor.ConvertProjToRealCoords ( int  x,
int  y,
UInt16  depth 
)
inline

Convert projective coordinates to real world coordinates from x, y and the depth map.

Parameters
[in]x,yProjective point coordinates.
[in]depthDepth map.
Returns
Real world coordinates.
Vector3 nuitrack.DepthSensor.ConvertProjToRealCoords ( Vector3  p)
inline

Convert projective coordinates to real world coordinates from the Vector3 point.

Parameters
[in]pProjective point coordinates.
Returns
Real world coordinates.
Vector3 nuitrack.DepthSensor.ConvertRealToProjCoords ( float  x,
float  y,
float  z 
)
inline

Convert real world coordinates to projective coordinates from x, y, z.

Parameters
[in]x,y,zReal world coordinates.
Returns
Projective coordinates.
Vector3 nuitrack.DepthSensor.ConvertRealToProjCoords ( Vector3  p)
inline

Convert real world coordinates to projective coordinates from the Vector3 point.

Parameters
[in]pReal world coordinates.
Returns
Projective coordinates.
DepthFrame nuitrack.DepthSensor.GetDepthFrame ( )
inline

Get the depth frame.

Returns
Returns the depth frame.
OutputMode nuitrack.DepthSensor.GetOutputMode ( )
inline

Get output mode of the depth sensor.

Returns
Returns output mode of the depth sensor.
abstract bool nuitrack.DepthSensor.IsMirror ( )
pure virtual

Determine the mirror mode state.

Returns
Returns true if mirror mode is enabled, otherwise, false.
See Also
SetMirror
abstract void nuitrack.DepthSensor.SetMirror ( bool  mirror)
pure virtual

Set mirror mode.

Call SetMirror(true) to enable mirror mode. Call SetMirror(false) to disable mirror mode.

If the mirror mode is on, the depth map from the sensor will be reflected horizontally before consequent processing.

Parameters
[in]mirrorMirror mode to be set.
See Also
IsMirror
void nuitrack.DepthSensor.SignalOnUpdate ( DepthFrame  frame)
inlineprotected
Warning
For internal use only.

Member Data Documentation

DepthFrame nuitrack.DepthSensor.frame
protected
Warning
For internal use only.