XnContext.h

Go to the documentation of this file.

/****************************************************************************
*                                                                           *
*  OpenNI 1.x Alpha                                                         *
*  Copyright (C) 2011 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 XN_C_DECL xnInit(XnContext** ppContext);

XN_C_API XnStatus XN_C_DECL xnContextRunXmlScriptFromFileEx(XnContext* pContext, const XnChar* strFileName, XnEnumerationErrors* pErrors, XnNodeHandle* phScriptNode);

XN_C_API XnStatus XN_API_DEPRECATED("Please use xnContextRunXmlScriptFromFileEx() instead") xnContextRunXmlScriptFromFile(XnContext* pContext, const XnChar* strFileName, XnEnumerationErrors* pErrors);

XN_C_API XnStatus XN_C_DECL xnContextRunXmlScriptEx(XnContext* pContext, const XnChar* xmlScript, XnEnumerationErrors* pErrors, XnNodeHandle* phScriptNode);

XN_C_API XnStatus XN_API_DEPRECATED("Please use xnContextRunXmlScriptEx() instead") XN_C_DECL xnContextRunXmlScript(XnContext* pContext, const XnChar* xmlScript, XnEnumerationErrors* pErrors);

XN_C_API XnStatus XN_C_DECL xnInitFromXmlFileEx(const XnChar* strFileName, XnContext** ppContext, XnEnumerationErrors* pErrors, XnNodeHandle* phScriptNode);

XN_C_API XnStatus XN_API_DEPRECATED("Please use xnInitFromXmlFileEx() instead") XN_C_DECL xnInitFromXmlFile(const XnChar* strFileName, XnContext** ppContext, XnEnumerationErrors* pErrors);

XN_C_API XnStatus XN_C_DECL xnContextOpenFileRecordingEx(XnContext* pContext, const XnChar* strFileName, XnNodeHandle* phPlayerNode);

XN_C_API XnStatus XN_API_DEPRECATED("Please use xnContextOpenFileRecordingEx() instead") XN_C_DECL xnContextOpenFileRecording(XnContext* pContext, const XnChar* strFileName);

XN_C_API XnStatus XN_C_DECL xnContextAddRef(XnContext* pContext);

XN_C_API void XN_C_DECL xnContextRelease(XnContext* pContext);

XN_C_API void XN_API_DEPRECATED("Use xnContextRelease() instead") XN_C_DECL xnShutdown(XnContext* pContext);

XN_C_API void XN_C_DECL xnForceShutdown(XnContext* pContext);

XN_C_API XnStatus XN_C_DECL xnContextRegisterForShutdown(XnContext* pContext, XnContextShuttingDownHandler pHandler, void* pCookie, XnCallbackHandle* phCallback);

XN_C_API void XN_C_DECL xnContextUnregisterFromShutdown(XnContext* pContext, XnCallbackHandle hCallback);

// @}

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

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

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

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

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

XN_C_API XnStatus XN_C_DECL xnProductionNodeAddRef(XnNodeHandle hNode);

XN_C_API XnStatus XN_API_DEPRECATED("Please use xnProductionNodeAddRef() instead.") XN_C_DECL xnRefProductionNode(XnNodeHandle hNode);

XN_C_API void XN_C_DECL xnProductionNodeRelease(XnNodeHandle hNode);

XN_C_API void XN_API_DEPRECATED("Please use xnProductionNodeRelease() instead.") XN_C_DECL xnUnrefProductionNode(XnNodeHandle hNode);

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

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

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

XN_C_API XnStatus XN_API_DEPRECATED("Please use xnFindExistingRefNodeByType() instead") XN_C_DECL xnFindExistingNodeByType(
    XnContext* pContext,
    XnProductionNodeType type,
    XnNodeHandle* phNode
    );

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

XN_C_API XnStatus XN_API_DEPRECATED("Please use xnGetRefNodeHandleByName() instead") XN_C_DECL xnGetNodeHandleByName(
    XnContext* pContext,
    const XnChar* strInstanceName,
    XnNodeHandle* phNode
    );

// @}

XN_C_API XnStatus XN_C_DECL xnWaitAndUpdateAll(XnContext* pContext);

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

XN_C_API XnStatus XN_C_DECL xnWaitAnyUpdateAll(XnContext* pContext);

XN_C_API XnStatus XN_C_DECL xnWaitNoneUpdateAll(XnContext* pContext);

XN_C_API XnStatus XN_C_DECL xnStartGeneratingAll(XnContext* pContext);

XN_C_API XnStatus XN_C_DECL xnStopGeneratingAll(XnContext* pContext);

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

XN_C_API XnBool XN_C_DECL xnGetGlobalMirror(XnContext* pContext);

XN_C_API XnStatus XN_C_DECL xnGetGlobalErrorState(XnContext* pContext);

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

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

XN_C_API XnStatus XN_C_DECL xnRegisterToNodeCreation
    (XnContext* pContext, XnNodeCreationHandler handler,
    void* pCookie, XnCallbackHandle* phCallback);

XN_C_API void XN_C_DECL xnUnregisterFromNodeCreation
    (XnContext* pContext, XnCallbackHandle hCallback);

XN_C_API XnStatus XN_C_DECL xnRegisterToNodeDestruction
    (XnContext* pContext, XnNodeDestructionHandler handler,
    void* pCookie, XnCallbackHandle* phCallback);

XN_C_API void XN_C_DECL xnUnregisterFromNodeDestruction
    (XnContext* pContext, XnCallbackHandle hCallback);


#endif // __XN_CONTEXT_H__