1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
/****************************************************************************
* *
* 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_PRD_NODE_INFO_H__
#define __XN_PRD_NODE_INFO_H__
/**
* @ingroup cref
* @defgroup prdnodeinfo Production Node Info
* This page describes the functionality of a production node info object. Each info object
* can represent a possible production node, or an existing one.
* @{
*/
//---------------------------------------------------------------------------
// Includes
//---------------------------------------------------------------------------
#include <XnTypes.h>
//---------------------------------------------------------------------------
// Functions
//---------------------------------------------------------------------------
/**
* Allocates a node info object, and sets its details.
*
* @param pDescription [in] The description for the new node info object.
* @param strCreationInfo [in] The creation info for the new node info object.
* @param pNeededNodes [in] A list of node info's that are needed by the new node info.
* @param ppNodeInfo [out] A pointer to pointer to the new node info object.
*/
XN_C_API XnStatus XN_C_DECL xnNodeInfoAllocate(const XnProductionNodeDescription* pDescription, const XnChar* strCreationInfo, XnNodeInfoList* pNeededNodes, XnNodeInfo** ppNodeInfo);
/**
* Frees a node info object
*
* @param pNodeInfo [in] The node info object to free.
*/
XN_C_API void XN_C_DECL xnNodeInfoFree(XnNodeInfo* pNodeInfo);
/**
* Sets the instance name of the node info object. The name can only be set BEFORE the instance is
* created.
*
* @param pNodeInfo [in] A production node info object.
* @param strInstanceName [in] The name to give to this instance.
*/
XN_C_API XnStatus XN_C_DECL xnNodeInfoSetInstanceName(XnNodeInfo* pNodeInfo, const XnChar* strInstanceName);
/**
* Gets the description of the production node.
*
* @param pNodeInfo [in] A production node info object.
*/
XN_C_API const XnProductionNodeDescription* XN_C_DECL xnNodeInfoGetDescription(XnNodeInfo* pNodeInfo);
/**
* Creates a printable representation of the production tree.
*
* @param pNodeInfo [in] A production node info object.
* @param csResult [in] A buffer to be filled with the printable representation.
* @param nSize [in] Size of the buffer.
*/
XN_C_API XnStatus XN_C_DECL xnNodeInfoGetTreeStringRepresentation(XnNodeInfo* pNodeInfo, XnChar* csResult, XnUInt32 nSize);
/**
* Gets the instance name of the production node.
*
* @param pNodeInfo [in] A production node info object.
*/
XN_C_API const XnChar* XN_C_DECL xnNodeInfoGetInstanceName(XnNodeInfo* pNodeInfo);
/**
* Gets the creation info of the production node.
*
* @param pNodeInfo [in] A production node info object.
*/
XN_C_API const XnChar* XN_C_DECL xnNodeInfoGetCreationInfo(XnNodeInfo* pNodeInfo);
/**
* Gets the list of needed nodes of the production node.
*
* @param pNodeInfo [in] A production node info object.
*/
XN_C_API XnNodeInfoList* XN_C_DECL xnNodeInfoGetNeededNodes(XnNodeInfo* pNodeInfo);
/**
* Gets the handle of the production node. For nodes that weren't created yet, NULL is returned.
* If a handle is returned, it should be released when no longer used by calling @ref xnProductionNodeRelease().
*
* @param pNodeInfo [in] A production node info object.
*/
XN_C_API XnNodeHandle XN_C_DECL xnNodeInfoGetRefHandle(XnNodeInfo* pNodeInfo);
XN_C_API XnNodeHandle XN_API_DEPRECATED("Please use xnNodeInfoGetRefHandle() instead") XN_C_DECL xnNodeInfoGetHandle(XnNodeInfo* pNodeInfo);
/**
* Gets the additional data object attached to the node info object.
*
* @param pNodeInfo [in] A production node info object.
*/
XN_C_API const void* XN_C_DECL xnNodeInfoGetAdditionalData(XnNodeInfo* pNodeInfo);
/** @} */
#endif // __XN_PRD_NODE_INFO_H__
|
