Include dependency graph for XnContext.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Functions | |
Initialization | |
Functions for initializing and shutting down an OpenNI context. | |
| XN_C_API XnStatus | xnInit (XnContext **ppContext) |
| Initializes the OpenNI library. | |
| XN_C_API XnStatus | xnContextRunXmlScriptFromFile (XnContext *pContext, const XnChar *strFileName, XnEnumerationErrors *pErrors) |
| Runs an XML script in the given context. | |
| XN_C_API XnStatus | xnContextRunXmlScript (XnContext *pContext, const XnChar *xmlScript, XnEnumerationErrors *pErrors) |
| Runs an XML script in the given context. | |
| XN_C_API XnStatus | xnInitFromXmlFile (const XnChar *strFileName, XnContext **ppContext, XnEnumerationErrors *pErrors) |
| Initializes OpenNI context, and then configures it using the given file. | |
| XN_C_API XnStatus | xnContextOpenFileRecording (XnContext *pContext, const XnChar *strFileName) |
| Opens a recording file, adding all nodes in it to the context. | |
| XN_C_API void | xnShutdown (XnContext *pContext) |
| Shuts down the OpenNI library. No other OpenNI function can be called after calling this function. | |
Enumeration | |
Functions for enumeration and creation of nodes. | |
| XN_C_API XnStatus | xnEnumerateProductionTrees (XnContext *pContext, XnProductionNodeType Type, const XnNodeQuery *pQuery, XnNodeInfoList **ppTreesList, XnEnumerationErrors *pErrors) |
| Enumerates all available production trees for a specific node type. The trees populated in the list should be freed by calling xnNodeInfoListFree() once not needed. | |
| XN_C_API XnStatus | xnCreateProductionTree (XnContext *pContext, XnNodeInfo *pTree, XnNodeHandle *phNode) |
| Creates a production node. If the tree specifies additional needed nodes, and those nodes do not exist, they will be created too, and passed to this node as input. | |
| XN_C_API XnStatus | xnCreateAnyProductionTree (XnContext *pContext, XnProductionNodeType type, XnNodeQuery *pQuery, XnNodeHandle *phNode, XnEnumerationErrors *pErrors) |
| Enumerates for production trees for a specific node type, and creates the first found tree. This function is a shortcut version for using xnEnumerateProductionTrees(), iterating the list, and then calling xnCreateProductionTree(). | |
| XN_C_API XnStatus | xnCreateMockNode (XnContext *pContext, XnProductionNodeType type, const XnChar *strName, XnNodeHandle *phNode) |
| Creates a production node which is only a mock. This node does not represent an actual node, but only keeps a state and implements an interface above it. Mock nodes are useful when simulating nodes for playing recordings, or for use in tests. See also xnCreateMockNodeBasedOn(). | |
| XN_C_API XnStatus | xnCreateMockNodeBasedOn (XnContext *pContext, XnNodeHandle hOriginalNode, const XnChar *strName, XnNodeHandle *phMockNode) |
| Creates a production node which is only a mock, base on the type and properties of another node. This node does not represent an actual node, but only keeps a state and implements an interface above it. Mock nodes are useful when simulating nodes for playing recordings, or for use in tests. See also xnCreateMockNode(). | |
| XN_C_API XnStatus | xnRefProductionNode (XnNodeHandle hNode) |
| References a production node, increasing its reference count by 1. | |
| XN_C_API void | xnUnrefProductionNode (XnNodeHandle hNode) |
| Unreference a production node, decreasing its reference count by 1. If the reference count reaches zero, the node will be destroyed. | |
| XN_C_API XnStatus | xnEnumerateExistingNodes (XnContext *pContext, XnNodeInfoList **ppList) |
| Gets a list of all existing node in the context. Each node that was returned increases its ref count. The list must be freed using xnNodeInfoListFree(). | |
| XN_C_API XnStatus | xnEnumerateExistingNodesByType (XnContext *pContext, XnProductionNodeType type, XnNodeInfoList **ppList) |
| Gets a list of all existing node in the context. Each node that was returned increases its ref count. The list must be freed using xnNodeInfoListFree(). | |
| XN_C_API XnStatus | xnFindExistingNodeByType (XnContext *pContext, XnProductionNodeType type, XnNodeHandle *phNode) |
| Returns the first found existing node of the specified type. | |
| XN_C_API XnStatus | xnGetNodeHandleByName (XnContext *pContext, const XnChar *strInstanceName, XnNodeHandle *phNode) |
| Gets a handle to an existing production node instance using that instance name. | |
Multi-Node Handling | |
Functions that affect all the nodes in the context. | |
| XN_C_API XnStatus | xnWaitAndUpdateAll (XnContext *pContext) |
| Updates all generators nodes in the context, waiting for all to have new data. | |
| XN_C_API XnStatus | xnWaitOneUpdateAll (XnContext *pContext, XnNodeHandle hNode) |
| Updates all generators nodes in the context, waiting for a specific one to have new data. | |
| XN_C_API XnStatus | xnWaitAnyUpdateAll (XnContext *pContext) |
| Updates all generators nodes in the context, once any of them have new data. | |
| XN_C_API XnStatus | xnWaitNoneUpdateAll (XnContext *pContext) |
| Updates all generator nodes in the context, without any waiting. If a node has new data, it will be updated. | |
| XN_C_API XnStatus | xnStartGeneratingAll (XnContext *pContext) |
| Make sure all generators are generating data. | |
| XN_C_API XnStatus | xnStopGeneratingAll (XnContext *pContext) |
| Stop all generators from generating data. | |
| XN_C_API XnStatus | xnSetGlobalMirror (XnContext *pContext, XnBool bMirror) |
| Sets the global mirror flag. This will set all current existing nodes' mirror state, and also affect future created nodes. The default mirror flag is FALSE. | |
| XN_C_API XnBool | xnGetGlobalMirror (XnContext *pContext) |
| Gets the global mirror flag. | |
| XN_C_API XnStatus | xnGetGlobalErrorState (XnContext *pContext) |
| Gets the global error state of the context. If one of the nodes in the context is in error state, that state will be returned. If more than one node is in error state, XN_STATUS_MULTIPLE_NODES_ERROR is returned. An application can query each node error state by calling xnGetNodeErrorState(). | |
| XN_C_API XnStatus | xnRegisterToGlobalErrorStateChange (XnContext *pContext, XnErrorStateChangedHandler handler, void *pCookie, XnCallbackHandle *phCallback) |
| Registers a callback function to global error state changes. | |
| XN_C_API void | xnUnregisterFromGlobalErrorStateChange (XnContext *pContext, XnCallbackHandle hCallback) |
| Unregisters a callback function which was registered using xnRegisterToGlobalErrorStateChange(). | |