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/classPxHeightFieldGeometry.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/classPxHeightFieldGeometry.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxHeightFieldGeometry.html | 265 |
1 files changed, 265 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxHeightFieldGeometry.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxHeightFieldGeometry.html new file mode 100644 index 00000000..587e7d4a --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxHeightFieldGeometry.html @@ -0,0 +1,265 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxHeightFieldGeometry 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>PxHeightFieldGeometry Class Reference<br> +<small> +[<a class="el" href="group__geomutils.html">Geomutils</a>]</small> +</h1><!-- doxytag: class="PxHeightFieldGeometry" --><!-- doxytag: inherits="PxGeometry" -->Height field geometry class. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxHeightFieldGeometry_8h-source.html">PxHeightFieldGeometry.h</a>></code> +<p> +<div class="dynheader"> +Inheritance diagram for PxHeightFieldGeometry:</div> +<div class="dynsection"> +<p><center><img src="classPxHeightFieldGeometry__inherit__graph.png" border="0" usemap="#PxHeightFieldGeometry__inherit__map" alt="Inheritance graph"></center> +<map name="PxHeightFieldGeometry__inherit__map"> +<area shape="rect" href="classPxGeometry.html" title="A geometry object." alt="PxGeometry" coords="39,16,124,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> +<div class="dynheader"> +Collaboration diagram for PxHeightFieldGeometry:</div> +<div class="dynsection"> +<p><center><img src="classPxHeightFieldGeometry__coll__graph.png" border="0" usemap="#PxHeightFieldGeometry__coll__map" alt="Collaboration graph"></center> +<map name="PxHeightFieldGeometry__coll__map"> +<area shape="rect" href="classPxGeometry.html" title="A geometry object." alt="PxGeometry" coords="7,179,92,200"><area shape="rect" href="classPxHeightField.html" title="A height field class." alt="PxHeightField" coords="116,179,207,200"><area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="133,107,189,128"><area shape="rect" href="classPxFlags.html" title="PxFlags\< PxBaseFlag::Enum, PxU16 \>" alt="PxFlags\< PxBaseFlag::Enum, PxU16 \>" coords="43,16,280,37"><area shape="rect" href="structPxPadding.html" title="PxPadding\< 3 \>" alt="PxPadding\< 3 \>" coords="231,179,335,200"><area shape="rect" href="classPxFlags.html" title="PxFlags\< PxMeshGeometryFlag::Enum, PxU8 \>" alt="PxFlags\< PxMeshGeometryFlag::Enum, PxU8 \>" coords="359,179,649,200"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="classPxHeightFieldGeometry-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="classPxHeightFieldGeometry.html#211bb1407a1be542699e5e73ceaabbe5">PxHeightFieldGeometry</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightFieldGeometry.html#cae4be76fff66a69aa1e15aa7ffa1b8b">PxHeightFieldGeometry</a> (<a class="el" href="classPxHeightField.html">PxHeightField</a> *hf, <a class="el" href="classPxFlags.html">PxMeshGeometryFlags</a> flags, PxReal heightScale_, PxReal rowScale_, PxReal columnScale_)</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#gb22fcfaf7786e41679e88d4668a9b24e">isValid</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the geometry is valid. <a href="group__geomutils.html#gb22fcfaf7786e41679e88d4668a9b24e"></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="classPxHeightField.html">PxHeightField</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightFieldGeometry.html#de90caef2f95d56481d625ffba6ad918">heightField</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The height field data. <a href="#de90caef2f95d56481d625ffba6ad918"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightFieldGeometry.html#8ced165e5b805d5e6c2b6a4fdc33ed2a">heightScale</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The scaling factor for the height field in vertical direction (y direction in local space). <a href="#8ced165e5b805d5e6c2b6a4fdc33ed2a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightFieldGeometry.html#3ad5e1a813301ada814c778ea3a3cba7">rowScale</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The scaling factor for the height field in the row direction (x direction in local space). <a href="#3ad5e1a813301ada814c778ea3a3cba7"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightFieldGeometry.html#c6ffb9725576c6a8db8b88327719538e">columnScale</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The scaling factor for the height field in the column direction (z direction in local space). <a href="#c6ffb9725576c6a8db8b88327719538e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxFlags.html">PxMeshGeometryFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightFieldGeometry.html#a86c6a6354ec839a1300f7bd4e5141ea">heightFieldFlags</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Flags to specify some collision properties for the height field. <a href="#a86c6a6354ec839a1300f7bd4e5141ea"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structPxPadding.html">PxPadding</a>< 3 > </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightFieldGeometry.html#c6320ee337895516d651d46be99217d6">paddingFromFlags</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">padding for mesh flags. <a href="#c6320ee337895516d651d46be99217d6"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Height field geometry class. +<p> +This class allows to create a scaled height field geometry instance.<p> +There is a minimum allowed value for Y and XZ scaling - PX_MIN_HEIGHTFIELD_XZ_SCALE, heightfield creation will fail if XZ value is below this value. <hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="211bb1407a1be542699e5e73ceaabbe5"></a><!-- doxytag: member="PxHeightFieldGeometry::PxHeightFieldGeometry" ref="211bb1407a1be542699e5e73ceaabbe5" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxHeightFieldGeometry::PxHeightFieldGeometry </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="cae4be76fff66a69aa1e15aa7ffa1b8b"></a><!-- doxytag: member="PxHeightFieldGeometry::PxHeightFieldGeometry" ref="cae4be76fff66a69aa1e15aa7ffa1b8b" args="(PxHeightField *hf, PxMeshGeometryFlags flags, PxReal heightScale_, PxReal rowScale_, PxReal columnScale_)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxHeightFieldGeometry::PxHeightFieldGeometry </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxHeightField.html">PxHeightField</a> * </td> + <td class="paramname"> <em>hf</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classPxFlags.html">PxMeshGeometryFlags</a> </td> + <td class="paramname"> <em>flags</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>heightScale_</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>rowScale_</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>columnScale_</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="c6ffb9725576c6a8db8b88327719538e"></a><!-- doxytag: member="PxHeightFieldGeometry::columnScale" ref="c6ffb9725576c6a8db8b88327719538e" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal <a class="el" href="classPxHeightFieldGeometry.html#c6ffb9725576c6a8db8b88327719538e">PxHeightFieldGeometry::columnScale</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The scaling factor for the height field in the column direction (z direction in local space). +<p> + +<p>Referenced by <a class="el" href="PxHeightFieldGeometry_8h-source.html#l00124">isValid()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="de90caef2f95d56481d625ffba6ad918"></a><!-- doxytag: member="PxHeightFieldGeometry::heightField" ref="de90caef2f95d56481d625ffba6ad918" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxHeightField.html">PxHeightField</a>* <a class="el" href="classPxHeightFieldGeometry.html#de90caef2f95d56481d625ffba6ad918">PxHeightFieldGeometry::heightField</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The height field data. +<p> + +<p>Referenced by <a class="el" href="PxHeightFieldGeometry_8h-source.html#l00124">isValid()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="a86c6a6354ec839a1300f7bd4e5141ea"></a><!-- doxytag: member="PxHeightFieldGeometry::heightFieldFlags" ref="a86c6a6354ec839a1300f7bd4e5141ea" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxFlags.html">PxMeshGeometryFlags</a> <a class="el" href="classPxHeightFieldGeometry.html#a86c6a6354ec839a1300f7bd4e5141ea">PxHeightFieldGeometry::heightFieldFlags</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Flags to specify some collision properties for the height field. +<p> + +</div> +</div><p> +<a class="anchor" name="8ced165e5b805d5e6c2b6a4fdc33ed2a"></a><!-- doxytag: member="PxHeightFieldGeometry::heightScale" ref="8ced165e5b805d5e6c2b6a4fdc33ed2a" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal <a class="el" href="classPxHeightFieldGeometry.html#8ced165e5b805d5e6c2b6a4fdc33ed2a">PxHeightFieldGeometry::heightScale</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The scaling factor for the height field in vertical direction (y direction in local space). +<p> + +<p>Referenced by <a class="el" href="PxHeightFieldGeometry_8h-source.html#l00124">isValid()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="c6320ee337895516d651d46be99217d6"></a><!-- doxytag: member="PxHeightFieldGeometry::paddingFromFlags" ref="c6320ee337895516d651d46be99217d6" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structPxPadding.html">PxPadding</a><3> <a class="el" href="classPxHeightFieldGeometry.html#c6320ee337895516d651d46be99217d6">PxHeightFieldGeometry::paddingFromFlags</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +padding for mesh flags. +<p> + +</div> +</div><p> +<a class="anchor" name="3ad5e1a813301ada814c778ea3a3cba7"></a><!-- doxytag: member="PxHeightFieldGeometry::rowScale" ref="3ad5e1a813301ada814c778ea3a3cba7" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal <a class="el" href="classPxHeightFieldGeometry.html#3ad5e1a813301ada814c778ea3a3cba7">PxHeightFieldGeometry::rowScale</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The scaling factor for the height field in the row direction (x direction in local space). +<p> + +<p>Referenced by <a class="el" href="PxHeightFieldGeometry_8h-source.html#l00124">isValid()</a>.</p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxHeightFieldGeometry_8h-source.html">PxHeightFieldGeometry.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> |