diff options
| author | git perforce import user <a@b> | 2016-10-25 12:29:14 -0600 |
|---|---|---|
| committer | Sheikh Dawood Abdul Ajees <Sheikh Dawood Abdul Ajees> | 2016-10-25 18:56:37 -0500 |
| commit | 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 (patch) | |
| tree | fa6485c169e50d7415a651bf838f5bcd0fd3bfbd /PhysX_3.4/Documentation/PhysXAPI/files/structPxHeightFieldSample.html | |
| download | physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.tar.xz physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.zip | |
Initial commit:
PhysX 3.4.0 Update @ 21294896
APEX 1.4.0 Update @ 21275617
[CL 21300167]
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/structPxHeightFieldSample.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/structPxHeightFieldSample.html | 193 |
1 files changed, 193 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/structPxHeightFieldSample.html b/PhysX_3.4/Documentation/PhysXAPI/files/structPxHeightFieldSample.html new file mode 100644 index 00000000..9c165b4a --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/structPxHeightFieldSample.html @@ -0,0 +1,193 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxHeightFieldSample Struct 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>PxHeightFieldSample Struct Reference<br> +<small> +[<a class="el" href="group__geomutils.html">Geomutils</a>]</small> +</h1><!-- doxytag: class="PxHeightFieldSample" -->Heightfield sample format. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxHeightFieldSample_8h-source.html">PxHeightFieldSample.h</a>></code> +<p> +<div class="dynheader"> +Collaboration diagram for PxHeightFieldSample:</div> +<div class="dynsection"> +<p><center><img src="structPxHeightFieldSample__coll__graph.png" border="0" usemap="#PxHeightFieldSample__coll__map" alt="Collaboration graph"></center> +<map name="PxHeightFieldSample__coll__map"> +<area shape="rect" href="classPxBitAndDataT.html" title="PxBitAndDataT\< unsigned char, 0x80 \>" alt="PxBitAndDataT\< unsigned char, 0x80 \>" coords="7,16,244,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="structPxHeightFieldSample-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_CUDA_CALLABLE <br class="typebreak"> +PX_FORCE_INLINE PxU8 </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxHeightFieldSample.html#3e986de3988014b3fc6a1e449e074fd8">tessFlag</a> () const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE <br class="typebreak"> +PX_FORCE_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxHeightFieldSample.html#82ee14c99624ff3ace22e8408eea9935">setTessFlag</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE <br class="typebreak"> +PX_FORCE_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxHeightFieldSample.html#a28e24b4763400eb5bd84378a23e086f">clearTessFlag</a> ()</td></tr> + +<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxI16 </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxHeightFieldSample.html#cfdb9fa8a4f56b5c3354cd552768a026">height</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The height of the heightfield sample. <a href="#cfdb9fa8a4f56b5c3354cd552768a026"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxBitAndDataT.html">PxBitAndByte</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxHeightFieldSample.html#6ec426622c36188a3de6f295caed819f">materialIndex0</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The triangle material index of the quad's lower triangle + tesselation flag. <a href="#6ec426622c36188a3de6f295caed819f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxBitAndDataT.html">PxBitAndByte</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxHeightFieldSample.html#e97419cbc1c9fdaa3f7f88fbe2298b1a">materialIndex1</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The triangle material index of the quad's upper triangle + reserved flag. <a href="#e97419cbc1c9fdaa3f7f88fbe2298b1a"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Heightfield sample format. +<p> +This format corresponds to the <a class="el" href="structPxHeightFieldFormat.html" title="Describes the format of height field samples.">PxHeightFieldFormat</a> member <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> +An array of heightfield samples are used when creating a <a class="el" href="classPxHeightField.html" title="A height field class.">PxHeightField</a> to specify the elevation of the heightfield points. In addition the material and tessellation of the adjacent triangles are specified.<p> +<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="classPxHeightFieldDesc.html" title="Descriptor class for PxHeightField.">PxHeightFieldDesc</a> <a class="el" href="classPxHeightFieldDesc.html#ffbec0b3ed43d041b12152648d13821b" title="The samples array.">PxHeightFieldDesc.samples</a> </dd></dl> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="a28e24b4763400eb5bd84378a23e086f"></a><!-- doxytag: member="PxHeightFieldSample::clearTessFlag" ref="a28e24b4763400eb5bd84378a23e086f" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_CUDA_CALLABLE PX_FORCE_INLINE void PxHeightFieldSample::clearTessFlag </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="82ee14c99624ff3ace22e8408eea9935"></a><!-- doxytag: member="PxHeightFieldSample::setTessFlag" ref="82ee14c99624ff3ace22e8408eea9935" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_CUDA_CALLABLE PX_FORCE_INLINE void PxHeightFieldSample::setTessFlag </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="3e986de3988014b3fc6a1e449e074fd8"></a><!-- doxytag: member="PxHeightFieldSample::tessFlag" ref="3e986de3988014b3fc6a1e449e074fd8" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_CUDA_CALLABLE PX_FORCE_INLINE PxU8 PxHeightFieldSample::tessFlag </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="cfdb9fa8a4f56b5c3354cd552768a026"></a><!-- doxytag: member="PxHeightFieldSample::height" ref="cfdb9fa8a4f56b5c3354cd552768a026" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxI16 <a class="el" href="structPxHeightFieldSample.html#cfdb9fa8a4f56b5c3354cd552768a026">PxHeightFieldSample::height</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The height of the heightfield sample. +<p> +This value is scaled by <a class="el" href="classPxHeightFieldGeometry.html#8ced165e5b805d5e6c2b6a4fdc33ed2a" title="The scaling factor for the height field in vertical direction (y direction in local...">PxHeightFieldGeometry::heightScale</a>.<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxHeightFieldGeometry.html" title="Height field geometry class.">PxHeightFieldGeometry</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="6ec426622c36188a3de6f295caed819f"></a><!-- doxytag: member="PxHeightFieldSample::materialIndex0" ref="6ec426622c36188a3de6f295caed819f" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxBitAndDataT.html">PxBitAndByte</a> <a class="el" href="structPxHeightFieldSample.html#6ec426622c36188a3de6f295caed819f">PxHeightFieldSample::materialIndex0</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The triangle material index of the quad's lower triangle + tesselation flag. +<p> +An index pointing into the material table of the shape which instantiates the heightfield. This index determines the material of the lower of the quad's two triangles (i.e. the quad whose upper-left corner is this sample, see the Guide for illustrations).<p> +Special values of the 7 data bits are defined by <a class="el" href="structPxHeightFieldMaterial.html" title="Special material index values for height field samples.">PxHeightFieldMaterial</a><p> +The tesselation flag specifies which way the quad is split whose upper left corner is this sample. If the flag is set, the diagonal of the quad will run from this sample to the opposite vertex; if not, it will run between the other two vertices (see the Guide for illustrations).<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxHeightFieldGeometry.html" title="Height field geometry class.">PxHeightFieldGeometry</a> <a class="el" href="structPxHeightFieldSample.html#e97419cbc1c9fdaa3f7f88fbe2298b1a" title="The triangle material index of the quad's upper triangle + reserved flag.">materialIndex1</a> PxShape.setmaterials() <a class="el" href="classPxShape.html#dbaf4b32d62babcbab918fc64d4fcae9" title="Retrieve all the material pointers associated with the shape.">PxShape.getMaterials()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="e97419cbc1c9fdaa3f7f88fbe2298b1a"></a><!-- doxytag: member="PxHeightFieldSample::materialIndex1" ref="e97419cbc1c9fdaa3f7f88fbe2298b1a" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxBitAndDataT.html">PxBitAndByte</a> <a class="el" href="structPxHeightFieldSample.html#e97419cbc1c9fdaa3f7f88fbe2298b1a">PxHeightFieldSample::materialIndex1</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The triangle material index of the quad's upper triangle + reserved flag. +<p> +An index pointing into the material table of the shape which instantiates the heightfield. This index determines the material of the upper of the quad's two triangles (i.e. the quad whose upper-left corner is this sample, see the Guide for illustrations).<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxHeightFieldGeometry.html" title="Height field geometry class.">PxHeightFieldGeometry</a> <a class="el" href="structPxHeightFieldSample.html#6ec426622c36188a3de6f295caed819f" title="The triangle material index of the quad's lower triangle + tesselation flag.">materialIndex0</a> PxShape.setmaterials() <a class="el" href="classPxShape.html#dbaf4b32d62babcbab918fc64d4fcae9" title="Retrieve all the material pointers associated with the shape.">PxShape.getMaterials()</a> </dd></dl> + +</div> +</div><p> +<hr>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="PxHeightFieldSample_8h-source.html">PxHeightFieldSample.h</a></ul> +</div> + +<hr style="width: 100%; height: 2px;"><br> +Copyright © 2008-2016 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> |