NiTE 2.0: nite::UserData Class Reference

NiTE 2.0

nite::UserData Class Reference

#include <NiTE.h>

Inheritance diagram for nite::UserData:

List of all members.

Public Member Functions

const BoundingBoxgetBoundingBox () const
const Point3fgetCenterOfMass () const
UserId getId () const
const PoseDatagetPose (PoseType type) const
const SkeletongetSkeleton () const
bool isLost () const
bool isNew () const
bool isVisible () const

Detailed Description

Provides the current information available about a specific user detected by the UserTracker.

Note that some data is provided in depth ("projective") coordinates, and other data is provided in world ("real world") coordinates. See the OpenNI 2.0 documentation for information on the two coordinate systems used and how to convert between them.

See also:
UserTracker for more information on how this data is generated.
Skeleton for more information on a user's skeleton
UserMap for information on locating a specific user in the scene.

Member Function Documentation

const BoundingBox& nite::UserData::getBoundingBox ( ) const [inline]

Get a bounding box around the user. This provides a minimum volume cube that completely contains the user. Coordinates are "projective", so they are suitable for direct use with a depthmap.

BoundingBox that surrounds the user in the UserMap.
const Point3f& nite::UserData::getCenterOfMass ( ) const [inline]

Find the geometric center of mass of the user. This value is given in "real world" coordinates, so it must be converted before being superimposed over a raw depthmap. It is suitable for direct use with skeleton and hand point output.

Point3f indicating position in space of the user.
UserId nite::UserData::getId ( ) const [inline]

Get the ID of the user. This ID is persistent -- it will not change as long as the user is being continuously tracked.

UserId of the user being tracked.
const PoseData& nite::UserData::getPose ( PoseType  type) const [inline]

Get all information about a specific pose for this user. This will only be available if pose detection is enabled on this user for the PoseType specified.

[in]@refPoseType to retrieve data for.
PoseData for this pose type and this user.
See also:
UserTracker for moreinformation on enabling Pose detected.
const Skeleton& nite::UserData::getSkeleton ( ) const [inline]

Get the full skeleton of this user. This will only be available if Skeleton tracking has been enabled for this user, and the skeleton is calibrated and being actively tracked.

Skeleton of the user.
See also:
UserTracker for information on enabling skeleton tracking.
bool nite::UserData::isLost ( ) const [inline]

Check if the user is lost. This will happen once, in the first frame in which the user was declared lost. This user will not be provided in future frames, and his UserId may be assigned to a new user that appears in view.

True if the user is no longer being tracked, False otherwise.
bool nite::UserData::isNew ( ) const [inline]

Checks whether this user has been newly detected.

True if this is the first frame this user appears in, False otherwise.
bool nite::UserData::isVisible ( ) const [inline]

Check if the user is currently visible in the field of view.

True if the user is visible and detected, false otherwise.

The documentation for this class was generated from the following file:
Generated on Thu Jun 6 2013 17:48:15 for NiTE 2.0 by   doxygen