XnUtils.h

Go to the documentation of this file.

/*****************************************************************************
*                                                                            *
*  OpenNI 1.0 Alpha                                                          *
*  Copyright (C) 2010 PrimeSense Ltd.                                        *
*                                                                            *
*  This file is part of OpenNI.                                              *
*                                                                            *
*  OpenNI is free software: you can redistribute it and/or modify            *
*  it under the terms of the GNU Lesser General Public License as published  *
*  by the Free Software Foundation, either version 3 of the License, or      *
*  (at your option) any later version.                                       *
*                                                                            *
*  OpenNI is distributed in the hope that it will be useful,                 *
*  but WITHOUT ANY WARRANTY; without even the implied warranty of            *
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the              *
*  GNU Lesser General Public License for more details.                       *
*                                                                            *
*  You should have received a copy of the GNU Lesser General Public License  *
*  along with OpenNI. If not, see <http://www.gnu.org/licenses/>.            *
*                                                                            *
*****************************************************************************/




#ifndef __XN_UTILS_H__
#define __XN_UTILS_H__

//---------------------------------------------------------------------------
// Includes
//---------------------------------------------------------------------------
#include <XnTypes.h>

//---------------------------------------------------------------------------
// Functions
//---------------------------------------------------------------------------

XN_C_API XnStatus xnGetVersion(XnVersion* pVersion);


XN_C_API const XnChar* xnProductionNodeTypeToString(XnProductionNodeType Type);

XN_C_API XnStatus xnProductionNodeTypeFromString(const XnChar* strType, XnProductionNodeType* pType);

XN_C_API const XnBool xnIsTypeGenerator(XnProductionNodeType type);


XN_C_API const XnChar* xnPixelFormatToString(XnPixelFormat format);

XN_C_API XnStatus xnPixelFormatFromString(const XnChar* strName, XnPixelFormat* pFormat);


XN_C_API XnUInt32 xnResolutionGetXRes(XnResolution resolution);

XN_C_API XnUInt32 xnResolutionGetYRes(XnResolution resolution);

XN_C_API XnResolution xnResolutionGetFromXYRes(XnUInt32 xRes, XnUInt32 yRes);

XN_C_API XnResolution xnResolutionGetFromName(const XnChar* strName);

XN_C_API const XnChar* xnResolutionGetName(XnResolution resolution);


XN_C_API XnInt32 xnVersionCompare(const XnVersion* pVersion1, const XnVersion* pVersion2);

XN_C_API XnStatus xnVersionToString(const XnVersion* pVersion, XnChar* csResult, XnUInt32 nSize);


XN_C_API XnStatus xnProductionNodeDescriptionToString(const XnProductionNodeDescription* pDescription, XnChar* csResult, XnUInt32 nSize);


XN_C_API XnPoint3D xnCreatePoint3D(XnFloat x, XnFloat y, XnFloat z);
XN_C_API XnPlane3D xnCreatePlane3D(XnPoint3D ptPoint, XnVector3D vNormal);


XN_C_API XnStatus xnRegisterModule(const XnChar* strModule, const XnChar* strConfigDir);
XN_C_API XnStatus xnUnregisterModule(const XnChar* strModule);
XN_C_API XnStatus xnPrintRegisteredModules();


XN_C_API XnStatus xnRegisterGlobalLicense(XnLicense* pLicense);
XN_C_API XnStatus xnUnregisterGlobalLicense(XnLicense* pLicense);
XN_C_API XnStatus xnPrintRegisteredLicenses();


XN_C_API XnOutputMetaData* xnAllocateOutputMetaData();
XN_C_API void xnFreeOutputMetaData(const XnOutputMetaData* pMetaData);
XN_C_API XnStatus xnCopyOutputMetaData(XnOutputMetaData* pDestination, const XnOutputMetaData* pSource);

XN_C_API XnMapMetaData* xnAllocateMapMetaData();
XN_C_API void xnFreeMapMetaData(const XnMapMetaData* pMetaData);
XN_C_API XnStatus xnCopyMapMetaData(XnMapMetaData* pDestination, const XnMapMetaData* pSource);

XN_C_API XnDepthMetaData* xnAllocateDepthMetaData();
XN_C_API void xnFreeDepthMetaData(const XnDepthMetaData* pMetaData);
XN_C_API XnStatus xnCopyDepthMetaData(XnDepthMetaData* pDestination, const XnDepthMetaData* pSource);

XN_C_API XnImageMetaData* xnAllocateImageMetaData();
XN_C_API void xnFreeImageMetaData(const XnImageMetaData* pMetaData);
XN_C_API XnStatus xnCopyImageMetaData(XnImageMetaData* pDestination, const XnImageMetaData* pSource);

XN_C_API XnIRMetaData* xnAllocateIRMetaData();
XN_C_API void xnFreeIRMetaData(const XnIRMetaData* pMetaData);
XN_C_API XnStatus xnCopyIRMetaData(XnIRMetaData* pDestination, const XnIRMetaData* pSource);

XN_C_API XnAudioMetaData* xnAllocateAudioMetaData();
XN_C_API void xnFreeAudioMetaData(const XnAudioMetaData* pMetaData);
XN_C_API XnStatus xnCopyAudioMetaData(XnAudioMetaData* pDestination, const XnAudioMetaData* pSource);

XN_C_API XnSceneMetaData* xnAllocateSceneMetaData();
XN_C_API void xnFreeSceneMetaData(const XnSceneMetaData* pMetaData);
XN_C_API XnStatus xnCopySceneMetaData(XnSceneMetaData* pDestination, const XnSceneMetaData* pSource);


XN_C_API XnStatus xnAutoEnumerateOverSingleInput(XnContext* pContext, XnNodeInfoList* pList, XnProductionNodeDescription* pDescription, const XnChar* strCreationInfo, XnProductionNodeType InputType, XnEnumerationErrors* pErrors, XnNodeQuery* pQuery);


#endif // __XN_UTILS_H__