aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/classPxPvdSceneClient.html
blob: 1b450ed6c4280d4ef45a81687eb2b27486a38060 (plain) (blame)
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxPvdSceneClient Class Reference</title>
		<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
		<LINK HREF="NVIDIA.css" REL="stylesheet" TYPE="text/css">
	</head>

	<body bgcolor="#FFFFFF">
		<div id="header">
			<hr class="first">
			<img alt="" src="images/PhysXlogo.png" align="middle"> <br>
			<center>
				<a class="qindex" href="main.html">Main Page</a> &nbsp; 
				<a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; 
				<a class="qindex" href="annotated.html">Compound List</a> &nbsp; 
				<a class="qindex" href="functions.html">Compound Members</a> &nbsp;  
			</center>
			<hr class="second">
		</div>
<!-- Generated by Doxygen 1.5.8 -->
<div class="contents">
<h1>PxPvdSceneClient Class Reference<br>
<small>
[<a class="el" href="group__pvd.html">Pvd</a>]</small>
</h1><!-- doxytag: class="PxPvdSceneClient" -->Special client for <a class="el" href="classPxScene.html" title="A scene is a collection of bodies, particle systems and constraints which can interact...">PxScene</a>. It provides access to the <a class="el" href="structPxPvdSceneFlag.html" title="PVD scene Flags. They are disabled by default, and only works if PxPvdInstrumentationFlag::eDEBUG...">PxPvdSceneFlag</a>. It also provides simple user debug services that associated scene position such as immediate rendering and camera updates.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="PxPvdSceneClient_8h-source.html">PxPvdSceneClient.h</a>&gt;</code>
<p>

<p>
<a href="classPxPvdSceneClient-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdSceneClient.html#3b5e6327978fbe7a39fd53478da0c588">setScenePvdFlag</a> (<a class="el" href="structPxPvdSceneFlag.html#fa6d3e9f667028233457051fe78042bd">PxPvdSceneFlag::Enum</a> flag, bool value)=0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdSceneClient.html#74a77b0f48b6d0f9394ed7daa9c2c957">setScenePvdFlags</a> (<a class="el" href="classPxFlags.html">PxPvdSceneFlags</a> flags)=0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxFlags.html">PxPvdSceneFlags</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdSceneClient.html#a001bda702ba5738c182358035f36cc3">getScenePvdFlags</a> () const =0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdSceneClient.html#566584e2c33cba879612c468a6703ca4">updateCamera</a> (const char *name, const <a class="el" href="classPxVec3.html">PxVec3</a> &amp;origin, const <a class="el" href="classPxVec3.html">PxVec3</a> &amp;up, const <a class="el" href="classPxVec3.html">PxVec3</a> &amp;target)=0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdSceneClient.html#1f356a5ae75e8ec68026b3773f0e38ed">drawPoints</a> (const physx::pvdsdk::PvdDebugPoint *points, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> count)=0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdSceneClient.html#21e113d4a346e863848c6c30d53c594c">drawLines</a> (const physx::pvdsdk::PvdDebugLine *lines, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> count)=0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdSceneClient.html#2f6ba1cc210504c47594e2143cb64ec9">drawTriangles</a> (const physx::pvdsdk::PvdDebugTriangle *triangles, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> count)=0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdSceneClient.html#f78c548dbc479e5cc41cd6046f06d390">drawText</a> (const physx::pvdsdk::PvdDebugText &amp;text)=0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual physx::pvdsdk::PvdClient *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdSceneClient.html#e1b5736b5b44f33705a406411e3926d2">getClientInternal</a> ()=0</td></tr>

<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdSceneClient.html#0f9c59a8675b10a72f6a31f4ebb35897">~PxPvdSceneClient</a> ()</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Special client for <a class="el" href="classPxScene.html" title="A scene is a collection of bodies, particle systems and constraints which can interact...">PxScene</a>. It provides access to the <a class="el" href="structPxPvdSceneFlag.html" title="PVD scene Flags. They are disabled by default, and only works if PxPvdInstrumentationFlag::eDEBUG...">PxPvdSceneFlag</a>. It also provides simple user debug services that associated scene position such as immediate rendering and camera updates. <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="0f9c59a8675b10a72f6a31f4ebb35897"></a><!-- doxytag: member="PxPvdSceneClient::~PxPvdSceneClient" ref="0f9c59a8675b10a72f6a31f4ebb35897" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual PxPvdSceneClient::~PxPvdSceneClient           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="21e113d4a346e863848c6c30d53c594c"></a><!-- doxytag: member="PxPvdSceneClient::drawLines" ref="21e113d4a346e863848c6c30d53c594c" args="(const physx::pvdsdk::PvdDebugLine *lines, PxU32 count)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxPvdSceneClient::drawLines           </td>
          <td>(</td>
          <td class="paramtype">const physx::pvdsdk::PvdDebugLine *&nbsp;</td>
          <td class="paramname"> <em>lines</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a>&nbsp;</td>
          <td class="paramname"> <em>count</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
draw lines on PVD application's render window 
</div>
</div><p>
<a class="anchor" name="1f356a5ae75e8ec68026b3773f0e38ed"></a><!-- doxytag: member="PxPvdSceneClient::drawPoints" ref="1f356a5ae75e8ec68026b3773f0e38ed" args="(const physx::pvdsdk::PvdDebugPoint *points, PxU32 count)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxPvdSceneClient::drawPoints           </td>
          <td>(</td>
          <td class="paramtype">const physx::pvdsdk::PvdDebugPoint *&nbsp;</td>
          <td class="paramname"> <em>points</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a>&nbsp;</td>
          <td class="paramname"> <em>count</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
draw points on PVD application's render window 
</div>
</div><p>
<a class="anchor" name="f78c548dbc479e5cc41cd6046f06d390"></a><!-- doxytag: member="PxPvdSceneClient::drawText" ref="f78c548dbc479e5cc41cd6046f06d390" args="(const physx::pvdsdk::PvdDebugText &amp;text)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxPvdSceneClient::drawText           </td>
          <td>(</td>
          <td class="paramtype">const physx::pvdsdk::PvdDebugText &amp;&nbsp;</td>
          <td class="paramname"> <em>text</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
draw text on PVD application's render window 
</div>
</div><p>
<a class="anchor" name="2f6ba1cc210504c47594e2143cb64ec9"></a><!-- doxytag: member="PxPvdSceneClient::drawTriangles" ref="2f6ba1cc210504c47594e2143cb64ec9" args="(const physx::pvdsdk::PvdDebugTriangle *triangles, PxU32 count)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxPvdSceneClient::drawTriangles           </td>
          <td>(</td>
          <td class="paramtype">const physx::pvdsdk::PvdDebugTriangle *&nbsp;</td>
          <td class="paramname"> <em>triangles</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a>&nbsp;</td>
          <td class="paramname"> <em>count</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
draw triangles on PVD application's render window 
</div>
</div><p>
<a class="anchor" name="e1b5736b5b44f33705a406411e3926d2"></a><!-- doxytag: member="PxPvdSceneClient::getClientInternal" ref="e1b5736b5b44f33705a406411e3926d2" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual physx::pvdsdk::PvdClient* PxPvdSceneClient::getClientInternal           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
get the underlying client, for advanced users 
</div>
</div><p>
<a class="anchor" name="a001bda702ba5738c182358035f36cc3"></a><!-- doxytag: member="PxPvdSceneClient::getScenePvdFlags" ref="a001bda702ba5738c182358035f36cc3" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classPxFlags.html">PxPvdSceneFlags</a> PxPvdSceneClient::getScenePvdFlags           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Retrieves the PVD flags. See PxPvdSceneFlags. 
</div>
</div><p>
<a class="anchor" name="3b5e6327978fbe7a39fd53478da0c588"></a><!-- doxytag: member="PxPvdSceneClient::setScenePvdFlag" ref="3b5e6327978fbe7a39fd53478da0c588" args="(PxPvdSceneFlag::Enum flag, bool value)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxPvdSceneClient::setScenePvdFlag           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structPxPvdSceneFlag.html#fa6d3e9f667028233457051fe78042bd">PxPvdSceneFlag::Enum</a>&nbsp;</td>
          <td class="paramname"> <em>flag</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>value</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Sets the PVD flag. See <a class="el" href="structPxPvdSceneFlag.html" title="PVD scene Flags. They are disabled by default, and only works if PxPvdInstrumentationFlag::eDEBUG...">PxPvdSceneFlag</a>. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>flag</em>&nbsp;</td><td>Flag to set. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>value</em>&nbsp;</td><td>value the flag gets set to. </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="74a77b0f48b6d0f9394ed7daa9c2c957"></a><!-- doxytag: member="PxPvdSceneClient::setScenePvdFlags" ref="74a77b0f48b6d0f9394ed7daa9c2c957" args="(PxPvdSceneFlags flags)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxPvdSceneClient::setScenePvdFlags           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classPxFlags.html">PxPvdSceneFlags</a>&nbsp;</td>
          <td class="paramname"> <em>flags</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Sets the PVD flags. See PxPvdSceneFlags. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>flags</em>&nbsp;</td><td>Flags to set. </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="566584e2c33cba879612c468a6703ca4"></a><!-- doxytag: member="PxPvdSceneClient::updateCamera" ref="566584e2c33cba879612c468a6703ca4" args="(const char *name, const PxVec3 &amp;origin, const PxVec3 &amp;up, const PxVec3 &amp;target)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxPvdSceneClient::updateCamera           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>origin</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>up</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>target</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
update camera on PVD application's render window 
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxPvdSceneClient_8h-source.html">PxPvdSceneClient.h</a></ul>
</div>

<hr style="width: 100%; height: 2px;"><br>
Copyright &copy; 2008-2018 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a>
</body>
</html>