tdv::nuitrack::UserStateData Class Reference

Stores the results of user state estimation. More...

#include <GestureData.h>

Inherits tdv::nuitrack::ObjectData< UserStateData >.

Public Member Functions
	UserStateData (UsersStateChanges *pimpl)
int	getNumUserStates () const
	Returns the number of user states detected.
uint64_t	getTimestamp () const
	Returns the data timestamp in microseconds. More...
const std::vector< UserState >	getUserStates () const
	Returns descriptions of detected states of users. More...

Additional Inherited Members
Public Types inherited from tdv::nuitrack::ObjectData< UserStateData >
typedef std::shared_ptr < UserStateData >	Ptr
Public Types inherited from tdv::nuitrack::BaseObjectData
typedef std::shared_ptr < BaseObjectData >	Ptr

Detailed Description

Stores the results of user state estimation.

Constructor & Destructor Documentation

tdv::nuitrack::UserStateData::UserStateData ( UsersStateChanges *  pimpl )

inline

Warning

For internal use only.

Member Function Documentation

uint64_t tdv::nuitrack::UserStateData::getTimestamp ( ) const

inlinevirtual

Returns the data timestamp in microseconds.

The timestamp characterizes the time point to which the user state data corresponds.

Note

The exact meaning of this value depends on the depth provider.

Implements tdv::nuitrack::BaseObjectData.

const std::vector<UserState> tdv::nuitrack::UserStateData::getUserStates ( ) const

inline

Returns descriptions of detected states of users.

Returns

User state information in the form of array of the UserState structures.