XnContext.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_CONTEXT_H__
#define __XN_CONTEXT_H__

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

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

XN_C_API XnStatus xnInit(XnContext** ppContext);

XN_C_API XnStatus xnContextRunXmlScriptFromFile(XnContext* pContext, const XnChar* strFileName, XnEnumerationErrors* pErrors);

XN_C_API XnStatus xnContextRunXmlScript(XnContext* pContext, const XnChar* xmlScript, XnEnumerationErrors* pErrors);

XN_C_API XnStatus xnInitFromXmlFile(const XnChar* strFileName, XnContext** ppContext, XnEnumerationErrors* pErrors);

XN_C_API XnStatus xnContextOpenFileRecording(XnContext* pContext, const XnChar* strFileName);

XN_C_API void xnShutdown(XnContext* pContext);

// @}

XN_C_API XnStatus xnEnumerateProductionTrees(
        XnContext* pContext,
        XnProductionNodeType Type, 
        const XnNodeQuery* pQuery,
        XnNodeInfoList** ppTreesList,
        XnEnumerationErrors* pErrors
        );

XN_C_API XnStatus xnCreateProductionTree(
         XnContext* pContext,
         XnNodeInfo* pTree,
         XnNodeHandle* phNode
         );

XN_C_API XnStatus xnCreateAnyProductionTree(
        XnContext* pContext,
        XnProductionNodeType type,
        XnNodeQuery* pQuery,
        XnNodeHandle* phNode,
        XnEnumerationErrors* pErrors
        );

XN_C_API XnStatus xnCreateMockNode(
        XnContext* pContext, 
        XnProductionNodeType type,
        const XnChar* strName,
        XnNodeHandle* phNode
        );

XN_C_API XnStatus xnCreateMockNodeBasedOn(
        XnContext* pContext,
        XnNodeHandle hOriginalNode,
        const XnChar* strName,
        XnNodeHandle* phMockNode
        );

XN_C_API XnStatus xnRefProductionNode(XnNodeHandle hNode);

XN_C_API void xnUnrefProductionNode(XnNodeHandle hNode);

XN_C_API XnStatus xnEnumerateExistingNodes(XnContext* pContext, XnNodeInfoList** ppList);

XN_C_API XnStatus xnEnumerateExistingNodesByType(XnContext* pContext, XnProductionNodeType type, XnNodeInfoList** ppList);

XN_C_API XnStatus xnFindExistingNodeByType(
        XnContext* pContext,
        XnProductionNodeType type,
        XnNodeHandle* phNode
        );

XN_C_API XnStatus xnGetNodeHandleByName(
        XnContext* pContext,
        const XnChar* strInstanceName,
        XnNodeHandle* phNode
        );

// @}

XN_C_API XnStatus xnWaitAndUpdateAll(XnContext* pContext);

XN_C_API XnStatus xnWaitOneUpdateAll(XnContext* pContext, XnNodeHandle hNode);

XN_C_API XnStatus xnWaitAnyUpdateAll(XnContext* pContext);

XN_C_API XnStatus xnWaitNoneUpdateAll(XnContext* pContext);

XN_C_API XnStatus xnStartGeneratingAll(XnContext* pContext);

XN_C_API XnStatus xnStopGeneratingAll(XnContext* pContext);

XN_C_API XnStatus xnSetGlobalMirror(XnContext* pContext, XnBool bMirror);

XN_C_API XnBool xnGetGlobalMirror(XnContext* pContext);

XN_C_API XnStatus xnGetGlobalErrorState(XnContext* pContext);

XN_C_API XnStatus xnRegisterToGlobalErrorStateChange
        (XnContext* pContext, XnErrorStateChangedHandler handler,
        void* pCookie, XnCallbackHandle* phCallback);

XN_C_API void xnUnregisterFromGlobalErrorStateChange
        (XnContext* pContext, XnCallbackHandle hCallback);


#endif // __XN_CONTEXT_H__