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
|
<html>
<head>
<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxHeightFieldDesc 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>
<a class="qindex" href="hierarchy.html">Class Hierarchy</a>
<a class="qindex" href="annotated.html">Compound List</a>
<a class="qindex" href="functions.html">Compound Members</a>
</center>
<hr class="second">
</div>
<!-- Generated by Doxygen 1.5.8 -->
<div class="contents">
<h1>PxHeightFieldDesc Class Reference<br>
<small>
[<a class="el" href="group__geomutils.html">Geomutils</a>]</small>
</h1><!-- doxytag: class="PxHeightFieldDesc" -->Descriptor class for <a class="el" href="classPxHeightField.html" title="A height field class.">PxHeightField</a>.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="PxHeightFieldDesc_8h-source.html">PxHeightFieldDesc.h</a>></code>
<p>
<div class="dynheader">
Collaboration diagram for PxHeightFieldDesc:</div>
<div class="dynsection">
<p><center><img src="classPxHeightFieldDesc__coll__graph.png" border="0" usemap="#PxHeightFieldDesc__coll__map" alt="Collaboration graph"></center>
<map name="PxHeightFieldDesc__coll__map">
<area shape="rect" href="classPxFlags.html" title="PxFlags\< PxHeightFieldFlag::Enum, PxU16 \>" alt="PxFlags\< PxHeightFieldFlag::Enum, PxU16 \>" coords="7,16,279,37"><area shape="rect" href="structPxStridedData.html" title="PxStridedData" alt="PxStridedData" coords="303,16,396,37"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classPxHeightFieldDesc-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">PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="group__geomutils.html#g0e3fd140462fac286debed6c6a960c3d">PxHeightFieldDesc</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor sets to default. <a href="group__geomutils.html#g0e3fd140462fac286debed6c6a960c3d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__geomutils.html#gdd7ec6c255262ddceeb7e04600bc47b5">setToDefault</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(re)sets the structure to the default. <a href="group__geomutils.html#gdd7ec6c255262ddceeb7e04600bc47b5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__geomutils.html#gac3042beb40e73337fff5bddcd8f1ccc">isValid</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the descriptor is valid. <a href="group__geomutils.html#gac3042beb40e73337fff5bddcd8f1ccc"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightFieldDesc.html#c701700af3c4597a4a39a76e3331dd08">nbRows</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Number of sample rows in the height field samples array. <a href="#c701700af3c4597a4a39a76e3331dd08"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightFieldDesc.html#8426b15eb6ad44c11fcb84bb9e3350c0">nbColumns</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Number of sample columns in the height field samples array. <a href="#8426b15eb6ad44c11fcb84bb9e3350c0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structPxHeightFieldFormat.html#d28e3afa439f8ff1df6067288c46d9c5">PxHeightFieldFormat::Enum</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightFieldDesc.html#8743d198a4db234d353c1f4d2734d43d">format</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Format of the sample data. <a href="#8743d198a4db234d353c1f4d2734d43d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structPxStridedData.html">PxStridedData</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightFieldDesc.html#ffbec0b3ed43d041b12152648d13821b">samples</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The samples array. <a href="#ffbec0b3ed43d041b12152648d13821b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_DEPRECATED PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightFieldDesc.html#6cef36e916c7350a106929ec44d8d895">thickness</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets how thick the heightfield surface is. <a href="#6cef36e916c7350a106929ec44d8d895"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightFieldDesc.html#2c40081aa73ec042021785dbe52f75fb">convexEdgeThreshold</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxFlags.html">PxHeightFieldFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightFieldDesc.html#ec8940d776191d6ca950025836481360">flags</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flags bits, combined from values of the enum <a class="el" href="structPxHeightFieldFlag.html" title="Enum with flag values to be used in PxHeightFieldDesc.flags.">PxHeightFieldFlag</a>. <a href="#ec8940d776191d6ca950025836481360"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Descriptor class for <a class="el" href="classPxHeightField.html" title="A height field class.">PxHeightField</a>.
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>The heightfield data is *copied* when a <a class="el" href="classPxHeightField.html" title="A height field class.">PxHeightField</a> object is created from this descriptor. After the call the user may discard the height data.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxHeightField.html" title="A height field class.">PxHeightField</a> <a class="el" href="classPxHeightFieldGeometry.html" title="Height field geometry class.">PxHeightFieldGeometry</a> <a class="el" href="classPxShape.html" title="Abstract class for collision shapes.">PxShape</a> <a class="el" href="classPxPhysics.html#1806546c22306e8d44b7ff7719fbcc99" title="Creates a heightfield object from previously cooked stream.">PxPhysics.createHeightField()</a> <a class="el" href="classPxCooking.html#0a3d0ec6145be91dd6707535724d8ffb" title="Cooks and creates a heightfield mesh and inserts it into PxPhysics.">PxCooking.createHeightField()</a> </dd></dl>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="2c40081aa73ec042021785dbe52f75fb"></a><!-- doxytag: member="PxHeightFieldDesc::convexEdgeThreshold" ref="2c40081aa73ec042021785dbe52f75fb" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxReal <a class="el" href="classPxHeightFieldDesc.html#2c40081aa73ec042021785dbe52f75fb">PxHeightFieldDesc::convexEdgeThreshold</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This threshold is used by the collision detection to determine if a height field edge is convex and can generate contact points. Usually the convexity of an edge is determined from the angle (or cosine of the angle) between the normals of the faces sharing that edge. The height field allows a more efficient approach by comparing height values of neighboring vertices. This parameter offsets the comparison. Smaller changes than 0.5 will not alter the set of convex edges. The rule of thumb is that larger values will result in fewer edge contacts.<p>
This parameter is ignored in contact generation with sphere and capsule primitives.<p>
<b>Range:</b> [0, PX_MAX_F32)<br>
<b>Default:</b> 0
<p>Referenced by <a class="el" href="PxHeightFieldDesc_8h-source.html#l00186">isValid()</a>, and <a class="el" href="PxHeightFieldDesc_8h-source.html#l00171">PxHeightFieldDesc()</a>.</p>
</div>
</div><p>
<a class="anchor" name="ec8940d776191d6ca950025836481360"></a><!-- doxytag: member="PxHeightFieldDesc::flags" ref="ec8940d776191d6ca950025836481360" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classPxFlags.html">PxHeightFieldFlags</a> <a class="el" href="classPxHeightFieldDesc.html#ec8940d776191d6ca950025836481360">PxHeightFieldDesc::flags</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Flags bits, combined from values of the enum <a class="el" href="structPxHeightFieldFlag.html" title="Enum with flag values to be used in PxHeightFieldDesc.flags.">PxHeightFieldFlag</a>.
<p>
<b>Default:</b> 0<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxHeightFieldFlag.html" title="Enum with flag values to be used in PxHeightFieldDesc.flags.">PxHeightFieldFlag</a> <a class="el" href="group__geomutils.html#g93b547b1968a59b2d23c91aab533e2c8" title="collection of set bits defined in PxHeightFieldFlag.">PxHeightFieldFlags</a> </dd></dl>
<p>Referenced by <a class="el" href="PxHeightFieldDesc_8h-source.html#l00186">isValid()</a>, and <a class="el" href="PxHeightFieldDesc_8h-source.html#l00171">PxHeightFieldDesc()</a>.</p>
</div>
</div><p>
<a class="anchor" name="8743d198a4db234d353c1f4d2734d43d"></a><!-- doxytag: member="PxHeightFieldDesc::format" ref="8743d198a4db234d353c1f4d2734d43d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structPxHeightFieldFormat.html#d28e3afa439f8ff1df6067288c46d9c5">PxHeightFieldFormat::Enum</a> <a class="el" href="classPxHeightFieldDesc.html#8743d198a4db234d353c1f4d2734d43d">PxHeightFieldDesc::format</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Format of the sample data.
<p>
Currently the only supported format is <a class="el" href="structPxHeightFieldFormat.html#d28e3afa439f8ff1df6067288c46d9c5a8ba1edf74a561d830b5f40e2c3e64e7" title="Height field height data is 16 bit signed integers, followed by triangle materials...">PxHeightFieldFormat::eS16_TM</a>:<p>
<b>Default:</b> <a class="el" href="structPxHeightFieldFormat.html#d28e3afa439f8ff1df6067288c46d9c5a8ba1edf74a561d830b5f40e2c3e64e7" title="Height field height data is 16 bit signed integers, followed by triangle materials...">PxHeightFieldFormat::eS16_TM</a><p>
<dl class="see" compact><dt><b>See also:</b></dt><dd>PxHeightFormat <a class="el" href="classPxHeightFieldDesc.html#ffbec0b3ed43d041b12152648d13821b" title="The samples array.">PxHeightFieldDesc.samples</a> </dd></dl>
<p>Referenced by <a class="el" href="PxHeightFieldDesc_8h-source.html#l00186">isValid()</a>, and <a class="el" href="PxHeightFieldDesc_8h-source.html#l00171">PxHeightFieldDesc()</a>.</p>
</div>
</div><p>
<a class="anchor" name="8426b15eb6ad44c11fcb84bb9e3350c0"></a><!-- doxytag: member="PxHeightFieldDesc::nbColumns" ref="8426b15eb6ad44c11fcb84bb9e3350c0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="classPxHeightFieldDesc.html#8426b15eb6ad44c11fcb84bb9e3350c0">PxHeightFieldDesc::nbColumns</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Number of sample columns in the height field samples array.
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Local space Z-axis corresponds to columns.</dd></dl>
<b>Range:</b> >1<br>
<b>Default:</b> 0
<p>Referenced by <a class="el" href="PxHeightFieldDesc_8h-source.html#l00186">isValid()</a>, and <a class="el" href="PxHeightFieldDesc_8h-source.html#l00171">PxHeightFieldDesc()</a>.</p>
</div>
</div><p>
<a class="anchor" name="c701700af3c4597a4a39a76e3331dd08"></a><!-- doxytag: member="PxHeightFieldDesc::nbRows" ref="c701700af3c4597a4a39a76e3331dd08" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="classPxHeightFieldDesc.html#c701700af3c4597a4a39a76e3331dd08">PxHeightFieldDesc::nbRows</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Number of sample rows in the height field samples array.
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Local space X-axis corresponds to rows.</dd></dl>
<b>Range:</b> >1<br>
<b>Default:</b> 0
<p>Referenced by <a class="el" href="PxHeightFieldDesc_8h-source.html#l00186">isValid()</a>, and <a class="el" href="PxHeightFieldDesc_8h-source.html#l00171">PxHeightFieldDesc()</a>.</p>
</div>
</div><p>
<a class="anchor" name="ffbec0b3ed43d041b12152648d13821b"></a><!-- doxytag: member="PxHeightFieldDesc::samples" ref="ffbec0b3ed43d041b12152648d13821b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structPxStridedData.html">PxStridedData</a> <a class="el" href="classPxHeightFieldDesc.html#ffbec0b3ed43d041b12152648d13821b">PxHeightFieldDesc::samples</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The samples array.
<p>
It is copied to the SDK's storage at creation time.<p>
There are nbRows * nbColumn samples in the array, which define nbRows * nbColumn vertices and cells, of which (nbRows - 1) * (nbColumns - 1) cells are actually used.<p>
The array index of sample(row, column) = row * nbColumns + column. The byte offset of sample(row, column) = sampleStride * (row * nbColumns + column). The sample data follows at the offset and spans the number of bytes defined by the format. Then there are zero or more unused bytes depending on sampleStride before the next sample.<p>
<b>Default:</b> NULL<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd>PxHeightFormat </dd></dl>
<p>Referenced by <a class="el" href="PxHeightFieldDesc_8h-source.html#l00186">isValid()</a>.</p>
</div>
</div><p>
<a class="anchor" name="6cef36e916c7350a106929ec44d8d895"></a><!-- doxytag: member="PxHeightFieldDesc::thickness" ref="6cef36e916c7350a106929ec44d8d895" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PX_DEPRECATED PxReal <a class="el" href="classPxHeightFieldDesc.html#6cef36e916c7350a106929ec44d8d895">PxHeightFieldDesc::thickness</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets how thick the heightfield surface is.
<p>
In this way even objects which are under the surface of the height field but above this cutoff are treated as colliding with the height field.<p>
The thickness is measured relative to the surface at the given point.<p>
You may set this to a positive value, in which case the extent will be cast along the opposite side of the height field.<p>
You may use a smaller finite value for the extent if you want to put some space under the height field, such as a cave.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Please refer to the Raycasts Against Heightfields section of the user guide for details of how this value affects raycasts.</dd></dl>
<b>Range:</b> (-PX_MAX_BOUNDS_EXTENTS, PX_MAX_BOUNDS_EXTENTS)<br>
<b>Default:</b> -1
<p>Referenced by <a class="el" href="PxHeightFieldDesc_8h-source.html#l00171">PxHeightFieldDesc()</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxHeightFieldDesc_8h-source.html">PxHeightFieldDesc.h</a></ul>
</div>
<hr style="width: 100%; height: 2px;"><br>
Copyright © 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>
|