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/classPxHeightField.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/classPxHeightField.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxHeightField.html | 700 |
1 files changed, 700 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxHeightField.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxHeightField.html new file mode 100644 index 00000000..3f6a3173 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxHeightField.html @@ -0,0 +1,700 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxHeightField 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>PxHeightField Class Reference<br> +<small> +[<a class="el" href="group__geomutils.html">Geomutils</a>]</small> +</h1><!-- doxytag: class="PxHeightField" --><!-- doxytag: inherits="PxBase" -->A height field class. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxHeightField_8h-source.html">PxHeightField.h</a>></code> +<p> +<div class="dynheader"> +Inheritance diagram for PxHeightField:</div> +<div class="dynsection"> +<p><center><img src="classPxHeightField__inherit__graph.png" border="0" usemap="#PxHeightField__inherit__map" alt="Inheritance graph"></center> +<map name="PxHeightField__inherit__map"> +<area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="24,16,80,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> +<div class="dynheader"> +Collaboration diagram for PxHeightField:</div> +<div class="dynsection"> +<p><center><img src="classPxHeightField__coll__graph.png" border="0" usemap="#PxHeightField__coll__map" alt="Collaboration graph"></center> +<map name="PxHeightField__coll__map"> +<area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="97,106,153,128"><area shape="rect" href="classPxFlags.html" title="PxFlags\< PxBaseFlag::Enum, PxU16 \>" alt="PxFlags\< PxBaseFlag::Enum, PxU16 \>" 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="classPxHeightField-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 PX_PHYSX_COMMON_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#6b35bf964920daa991d6b509cbc02744">release</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Decrements the reference count of a height field and releases it if the new reference count is zero. <a href="#6b35bf964920daa991d6b509cbc02744"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#d509e93fd7d7fc43726160540faeb610">saveCells</a> (void *destBuffer, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> destBufferSize) const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes out the sample data array. <a href="#d509e93fd7d7fc43726160540faeb610"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#0f373ceba58f9b600be7a84103c04716">modifySamples</a> (PxI32 startCol, PxI32 startRow, const <a class="el" href="classPxHeightFieldDesc.html">PxHeightFieldDesc</a> &subfieldDesc, bool shrinkBounds=false)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Replaces a rectangular subfield in the sample data array. <a href="#0f373ceba58f9b600be7a84103c04716"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#9c23959bd90dd2acf493e4a4a85b8b2e">getNbRows</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the number of sample rows in the samples array. <a href="#9c23959bd90dd2acf493e4a4a85b8b2e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#deb227d057ba7949ad536a26ad75adab">getNbColumns</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the number of sample columns in the samples array. <a href="#deb227d057ba7949ad536a26ad75adab"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API <br class="typebreak"> +<a class="el" href="structPxHeightFieldFormat.html#d28e3afa439f8ff1df6067288c46d9c5">PxHeightFieldFormat::Enum</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#99d233a5a8ab9a835b5b2fd2115d639e">getFormat</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the format of the sample data. <a href="#99d233a5a8ab9a835b5b2fd2115d639e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#34935489b77f6d386bdfe15b4f10b00e">getSampleStride</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the offset in bytes between consecutive samples in the array. <a href="#34935489b77f6d386bdfe15b4f10b00e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#3d1c8423fdb42c8707102f4785fee97a">getThickness</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the thickness of the height volume in the vertical direction. <a href="#3d1c8423fdb42c8707102f4785fee97a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#59dfdd62f6c05c83f02bead7dad78ad8">getConvexEdgeThreshold</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the convex edge threshold. <a href="#59dfdd62f6c05c83f02bead7dad78ad8"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API <br class="typebreak"> +<a class="el" href="classPxFlags.html">PxHeightFieldFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#30f6798a40d3f1dad7bf79bae941e082">getFlags</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the 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="#30f6798a40d3f1dad7bf79bae941e082"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#f59483ecc91d83d95a81a95a97657683">getHeight</a> (PxReal x, PxReal z) const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the height at the given coordinates in grid space. <a href="#f59483ecc91d83d95a81a95a97657683"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#0419a4b453fcc887b337d49877cfab28">getReferenceCount</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the reference count for shared heightfields. <a href="#0419a4b453fcc887b337d49877cfab28"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#3546ec17c1fc7a4ce538bd2944fd443c">acquireReference</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Acquires a counted reference to a heightfield. <a href="#3546ec17c1fc7a4ce538bd2944fd443c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API <br class="typebreak"> +<a class="el" href="group__common.html#gc816bc62a68a52f01bf21f963295e822">PxMaterialTableIndex</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#497c5cb500ffc7d5cc00929c2007723b">getTriangleMaterialIndex</a> (<a class="el" href="group__common.html#g19403877bf7ce42d7240e4e4c758c016">PxTriangleID</a> triangleIndex) const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns material table index of given triangle. <a href="#497c5cb500ffc7d5cc00929c2007723b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API <a class="el" href="classPxVec3.html">PxVec3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#36357857037f9fcb257e4c4ec8b85a04">getTriangleNormal</a> (<a class="el" href="group__common.html#g19403877bf7ce42d7240e4e4c758c016">PxTriangleID</a> triangleIndex) const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a triangle face normal for a given triangle index. <a href="#36357857037f9fcb257e4c4ec8b85a04"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#e4136344e0c9ed9c773c304bc87690fe">getTimestamp</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of times the heightfield data has been modified. <a href="#e4136344e0c9ed9c773c304bc87690fe"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API <br class="typebreak"> +const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#c266359903e8e4d9f9c6af37804a32fc">getConcreteTypeName</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns string name of dynamic type. <a href="#c266359903e8e4d9f9c6af37804a32fc"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Protected 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="classPxHeightField.html#3687346446cb1c0f7ec1e36ccebb0e65">PxHeightField</a> (<a class="el" href="group__common.html#gc1fb4b256a5d900d394e89db170a2b79">PxType</a> concreteType, <a class="el" href="classPxFlags.html">PxBaseFlags</a> baseFlags)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#2803c15d545408ec8f6c8bbfbdac915c">PxHeightField</a> (<a class="el" href="classPxFlags.html">PxBaseFlags</a> baseFlags)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#e396d735d14cac4cf08958256362bc79">~PxHeightField</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#6ae6e27819ae0ea7488763c8cef3a7a2">isKindOf</a> (const char *name) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether a given type name matches with the type of this instance. <a href="#6ae6e27819ae0ea7488763c8cef3a7a2"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +A height field class. +<p> +Height fields work in a similar way as triangle meshes specified to act as height fields, with some important differences:<p> +Triangle meshes can be made of nonuniform geometry, while height fields are regular, rectangular grids. This means that with <a class="el" href="classPxHeightField.html" title="A height field class.">PxHeightField</a>, you sacrifice flexibility in return for improved performance and decreased memory consumption.<p> +In local space rows extend in X direction, columns in Z direction and height in Y direction.<p> +Like Convexes and TriangleMeshes, HeightFields are referenced by shape instances (see <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>).<p> +To avoid duplicating data when you have several instances of a particular height field differently, you do not use this class to represent a height field object directly. Instead, you create an instance of this height field via the <a class="el" href="classPxHeightFieldGeometry.html" title="Height field geometry class.">PxHeightFieldGeometry</a> and <a class="el" href="classPxShape.html" title="Abstract class for collision shapes.">PxShape</a> classes.<p> +<h3>Creation</h3> +<p> +To create an instance of this class call <a class="el" href="classPxPhysics.html#1806546c22306e8d44b7ff7719fbcc99" title="Creates a heightfield object from previously cooked stream.">PxPhysics::createHeightField()</a> or <a class="el" href="classPxCooking.html#1cb07ad25394fcb3ecb52eff93990e8f" title="Cooks and creates a heightfield mesh and inserts it into PxPhysics.">PxCooking::createHeightField(const PxHeightFieldDesc&, PxPhysicsInsertionCallback&)</a>. To delete it call <a class="el" href="classPxHeightField.html#6b35bf964920daa991d6b509cbc02744" title="Decrements the reference count of a height field and releases it if the new reference...">release()</a>. This is only possible once you have released all of its PxHeightFiedShape instances.<p> +<h3>Visualizations:</h3> +<p> +<ul> +<li><a class="el" href="structPxVisualizationParameter.html#dce8e8a77c144356b0968d2b9f79eb10714f24bab39d1bbe8b131bd10ef5552b" title="Visualize bounds (AABBs in world space).">PxVisualizationParameter::eCOLLISION_AABBS</a> </li> +<li><a class="el" href="structPxVisualizationParameter.html#dce8e8a77c144356b0968d2b9f79eb10515f4c3c72ee88d7507b52d6ccd14eab" title="Shape visualization.">PxVisualizationParameter::eCOLLISION_SHAPES</a> </li> +<li><a class="el" href="structPxVisualizationParameter.html#dce8e8a77c144356b0968d2b9f79eb100ad9dcb10f5f3d6ded3baecfc1e387d3" title="Shape axis visualization.">PxVisualizationParameter::eCOLLISION_AXES</a> </li> +<li><a class="el" href="structPxVisualizationParameter.html#dce8e8a77c144356b0968d2b9f79eb10fd900f30ba421d555e7f7b087126cd92" title="Mesh & convex face normals.">PxVisualizationParameter::eCOLLISION_FNORMALS</a> </li> +<li><a class="el" href="structPxVisualizationParameter.html#dce8e8a77c144356b0968d2b9f79eb10a0e06ca7fa1a0445abe0f4d293feb961" title="Active edges for meshes.">PxVisualizationParameter::eCOLLISION_EDGES</a></li> +</ul> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxHeightFieldDesc.html" title="Descriptor class for PxHeightField.">PxHeightFieldDesc</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#1cb07ad25394fcb3ecb52eff93990e8f" title="Cooks and creates a heightfield mesh and inserts it into PxPhysics.">PxCooking.createHeightField()</a> </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="3687346446cb1c0f7ec1e36ccebb0e65"></a><!-- doxytag: member="PxHeightField::PxHeightField" ref="3687346446cb1c0f7ec1e36ccebb0e65" args="(PxType concreteType, PxBaseFlags baseFlags)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxHeightField::PxHeightField </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__common.html#gc1fb4b256a5d900d394e89db170a2b79">PxType</a> </td> + <td class="paramname"> <em>concreteType</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classPxFlags.html">PxBaseFlags</a> </td> + <td class="paramname"> <em>baseFlags</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [inline, protected]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="2803c15d545408ec8f6c8bbfbdac915c"></a><!-- doxytag: member="PxHeightField::PxHeightField" ref="2803c15d545408ec8f6c8bbfbdac915c" args="(PxBaseFlags baseFlags)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxHeightField::PxHeightField </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxFlags.html">PxBaseFlags</a> </td> + <td class="paramname"> <em>baseFlags</em> </td> + <td> ) </td> + <td><code> [inline, protected]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="e396d735d14cac4cf08958256362bc79"></a><!-- doxytag: member="PxHeightField::~PxHeightField" ref="e396d735d14cac4cf08958256362bc79" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API PxHeightField::~PxHeightField </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </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="3546ec17c1fc7a4ce538bd2944fd443c"></a><!-- doxytag: member="PxHeightField::acquireReference" ref="3546ec17c1fc7a4ce538bd2944fd443c" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API void PxHeightField::acquireReference </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Acquires a counted reference to a heightfield. +<p> +This method increases the reference count of the heightfield by 1. Decrement the reference count by calling <a class="el" href="classPxHeightField.html#6b35bf964920daa991d6b509cbc02744" title="Decrements the reference count of a height field and releases it if the new reference...">release()</a> +</div> +</div><p> +<a class="anchor" name="c266359903e8e4d9f9c6af37804a32fc"></a><!-- doxytag: member="PxHeightField::getConcreteTypeName" ref="c266359903e8e4d9f9c6af37804a32fc" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API const char* PxHeightField::getConcreteTypeName </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns string name of dynamic type. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Class name of most derived type of this object. </dd></dl> + +<p>Implements <a class="el" href="classPxBase.html#67fe206d8897ddce896c371ac8d789a9">PxBase</a>.</p> + +</div> +</div><p> +<a class="anchor" name="59dfdd62f6c05c83f02bead7dad78ad8"></a><!-- doxytag: member="PxHeightField::getConvexEdgeThreshold" ref="59dfdd62f6c05c83f02bead7dad78ad8" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API PxReal PxHeightField::getConvexEdgeThreshold </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieves the convex edge threshold. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The convex edge threshold.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxHeightFieldDesc.html#2c40081aa73ec042021785dbe52f75fb">PxHeightFieldDesc.convexEdgeThreshold</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="30f6798a40d3f1dad7bf79bae941e082"></a><!-- doxytag: member="PxHeightField::getFlags" ref="30f6798a40d3f1dad7bf79bae941e082" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API <a class="el" href="classPxFlags.html">PxHeightFieldFlags</a> PxHeightField::getFlags </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieves the 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> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The 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>.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxHeightFieldDesc.html#ec8940d776191d6ca950025836481360" title="Flags bits, combined from values of the enum PxHeightFieldFlag.">PxHeightFieldDesc.flags</a> <a class="el" href="structPxHeightFieldFlag.html" title="Enum with flag values to be used in PxHeightFieldDesc.flags.">PxHeightFieldFlag</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="99d233a5a8ab9a835b5b2fd2115d639e"></a><!-- doxytag: member="PxHeightField::getFormat" ref="99d233a5a8ab9a835b5b2fd2115d639e" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API <a class="el" href="structPxHeightFieldFormat.html#d28e3afa439f8ff1df6067288c46d9c5">PxHeightFieldFormat::Enum</a> PxHeightField::getFormat </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieves the format of the sample data. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The format of the sample data.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxHeightFieldDesc.html#8743d198a4db234d353c1f4d2734d43d" title="Format of the sample data.">PxHeightFieldDesc.format</a> <a class="el" href="structPxHeightFieldFormat.html" title="Describes the format of height field samples.">PxHeightFieldFormat</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="f59483ecc91d83d95a81a95a97657683"></a><!-- doxytag: member="PxHeightField::getHeight" ref="f59483ecc91d83d95a81a95a97657683" args="(PxReal x, PxReal z) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API PxReal PxHeightField::getHeight </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>x</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>z</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieves the height at the given coordinates in grid space. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The height at the given coordinates or 0 if the coordinates are out of range. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="deb227d057ba7949ad536a26ad75adab"></a><!-- doxytag: member="PxHeightField::getNbColumns" ref="deb227d057ba7949ad536a26ad75adab" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxHeightField::getNbColumns </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieves the number of sample columns in the samples array. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The number of sample columns in the samples array.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxHeightFieldDesc.html#8426b15eb6ad44c11fcb84bb9e3350c0" title="Number of sample columns in the height field samples array.">PxHeightFieldDesc.nbColumns</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="9c23959bd90dd2acf493e4a4a85b8b2e"></a><!-- doxytag: member="PxHeightField::getNbRows" ref="9c23959bd90dd2acf493e4a4a85b8b2e" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxHeightField::getNbRows </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieves the number of sample rows in the samples array. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The number of sample rows in the samples array.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxHeightFieldDesc.html#c701700af3c4597a4a39a76e3331dd08" title="Number of sample rows in the height field samples array.">PxHeightFieldDesc.nbRows</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="0419a4b453fcc887b337d49877cfab28"></a><!-- doxytag: member="PxHeightField::getReferenceCount" ref="0419a4b453fcc887b337d49877cfab28" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxHeightField::getReferenceCount </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the reference count for shared heightfields. +<p> +At creation, the reference count of the heightfield is 1. Every shape referencing this heightfield increments the count by 1. When the reference count reaches 0, and only then, the heightfield gets destroyed automatically.<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>the current reference count. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="34935489b77f6d386bdfe15b4f10b00e"></a><!-- doxytag: member="PxHeightField::getSampleStride" ref="34935489b77f6d386bdfe15b4f10b00e" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxHeightField::getSampleStride </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieves the offset in bytes between consecutive samples in the array. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The offset in bytes between consecutive samples in the array.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd>PxHeightFieldDesc.sampleStride </dd></dl> + +</div> +</div><p> +<a class="anchor" name="3d1c8423fdb42c8707102f4785fee97a"></a><!-- doxytag: member="PxHeightField::getThickness" ref="3d1c8423fdb42c8707102f4785fee97a" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API PxReal PxHeightField::getThickness </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieves the thickness of the height volume in the vertical direction. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The thickness of the height volume in the vertical direction.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxHeightFieldDesc.html#6cef36e916c7350a106929ec44d8d895" title="Sets how thick the heightfield surface is.">PxHeightFieldDesc.thickness</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="e4136344e0c9ed9c773c304bc87690fe"></a><!-- doxytag: member="PxHeightField::getTimestamp" ref="e4136344e0c9ed9c773c304bc87690fe" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxHeightField::getTimestamp </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the number of times the heightfield data has been modified. +<p> +This method returns the number of times modifySamples has been called on this heightfield, so that code that has retained state that depends on the heightfield can efficiently determine whether it has been modified.<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of times the heightfield sample data has been modified. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="497c5cb500ffc7d5cc00929c2007723b"></a><!-- doxytag: member="PxHeightField::getTriangleMaterialIndex" ref="497c5cb500ffc7d5cc00929c2007723b" args="(PxTriangleID triangleIndex) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API <a class="el" href="group__common.html#gc816bc62a68a52f01bf21f963295e822">PxMaterialTableIndex</a> PxHeightField::getTriangleMaterialIndex </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__common.html#g19403877bf7ce42d7240e4e4c758c016">PxTriangleID</a> </td> + <td class="paramname"> <em>triangleIndex</em> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns material table index of given triangle. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>This function takes a post cooking triangle index.</dd></dl> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>triangleIndex</em> </td><td>(internal) index of desired triangle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Material table index, or 0xffff if no per-triangle materials are used </dd></dl> + +</div> +</div><p> +<a class="anchor" name="36357857037f9fcb257e4c4ec8b85a04"></a><!-- doxytag: member="PxHeightField::getTriangleNormal" ref="36357857037f9fcb257e4c4ec8b85a04" args="(PxTriangleID triangleIndex) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API <a class="el" href="classPxVec3.html">PxVec3</a> PxHeightField::getTriangleNormal </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__common.html#g19403877bf7ce42d7240e4e4c758c016">PxTriangleID</a> </td> + <td class="paramname"> <em>triangleIndex</em> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns a triangle face normal for a given triangle index. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>This function takes a post cooking triangle index.</dd></dl> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>triangleIndex</em> </td><td>(internal) index of desired triangle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Triangle normal for a given triangle index </dd></dl> + +</div> +</div><p> +<a class="anchor" name="6ae6e27819ae0ea7488763c8cef3a7a2"></a><!-- doxytag: member="PxHeightField::isKindOf" ref="6ae6e27819ae0ea7488763c8cef3a7a2" args="(const char *name) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API bool PxHeightField::isKindOf </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>superClass</em> </td> + <td> ) </td> + <td> const<code> [inline, protected, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns whether a given type name matches with the type of this instance. +<p> + +<p>Reimplemented from <a class="el" href="classPxBase.html#ae9d444c7cfd1715a101350a1b1226ef">PxBase</a>.</p> + +<p>References <a class="el" href="PxBase_8h-source.html#l00178">PxBase::isKindOf()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="0f373ceba58f9b600be7a84103c04716"></a><!-- doxytag: member="PxHeightField::modifySamples" ref="0f373ceba58f9b600be7a84103c04716" args="(PxI32 startCol, PxI32 startRow, const PxHeightFieldDesc &subfieldDesc, bool shrinkBounds=false)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API bool PxHeightField::modifySamples </td> + <td>(</td> + <td class="paramtype">PxI32 </td> + <td class="paramname"> <em>startCol</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxI32 </td> + <td class="paramname"> <em>startRow</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxHeightFieldDesc.html">PxHeightFieldDesc</a> & </td> + <td class="paramname"> <em>subfieldDesc</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"> <em>shrinkBounds</em> = <code>false</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Replaces a rectangular subfield in the sample data array. +<p> +The user provides the description of a rectangular subfield in subfieldDesc. The data is formatted and arranged as <a class="el" href="classPxHeightFieldDesc.html#ffbec0b3ed43d041b12152648d13821b" title="The samples array.">PxHeightFieldDesc.samples</a>.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>startCol</em> </td><td>First cell in the destination heightfield to be modified. Can be negative. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>startRow</em> </td><td>First row in the destination heightfield to be modified. Can be negative. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>subfieldDesc</em> </td><td>Description of the source subfield to read the samples from. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>shrinkBounds</em> </td><td>If left as false, the bounds will never shrink but only grow. If set to true the bounds will be recomputed from all HF samples at O(nbColums*nbRows) perf cost. </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True on success, false on failure. Failure can occur due to format mismatch.</dd></dl> +<dl class="note" compact><dt><b>Note:</b></dt><dd>Modified samples are constrained to the same height quantization range as the original heightfield. Source samples that are out of range of target heightfield will be clipped with no error. PhysX does not keep a mapping from the heightfield to heightfield shapes that reference it. Call <a class="el" href="classPxShape.html#c6112e8c0ee9803eb3436bbaf673d98a" title="Adjust the geometry of the shape.">PxShape::setGeometry</a> on each shape which references the height field, to ensure that internal data structures are updated to reflect the new geometry. Please note that <a class="el" href="classPxShape.html#c6112e8c0ee9803eb3436bbaf673d98a" title="Adjust the geometry of the shape.">PxShape::setGeometry</a> does not guarantee correct/continuous behavior when objects are resting on top of old or new geometry.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxHeightFieldDesc.html#ffbec0b3ed43d041b12152648d13821b" title="The samples array.">PxHeightFieldDesc.samples</a> <a class="el" href="classPxShape.html#c6112e8c0ee9803eb3436bbaf673d98a" title="Adjust the geometry of the shape.">PxShape.setGeometry</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="6b35bf964920daa991d6b509cbc02744"></a><!-- doxytag: member="PxHeightField::release" ref="6b35bf964920daa991d6b509cbc02744" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API void PxHeightField::release </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Decrements the reference count of a height field and releases it if the new reference count is zero. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxPhysics.html#1806546c22306e8d44b7ff7719fbcc99" title="Creates a heightfield object from previously cooked stream.">PxPhysics.createHeightField()</a> <a class="el" href="classPxHeightFieldDesc.html" title="Descriptor class for PxHeightField.">PxHeightFieldDesc</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> </dd></dl> + +<p>Implements <a class="el" href="classPxBase.html#fe6aedda1df0d6d29b1a28213a5ee25a">PxBase</a>.</p> + +</div> +</div><p> +<a class="anchor" name="d509e93fd7d7fc43726160540faeb610"></a><!-- doxytag: member="PxHeightField::saveCells" ref="d509e93fd7d7fc43726160540faeb610" args="(void *destBuffer, PxU32 destBufferSize) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxHeightField::saveCells </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>destBuffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>destBufferSize</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Writes out the sample data array. +<p> +The user provides destBufferSize bytes storage at destBuffer. The data is formatted and arranged as <a class="el" href="classPxHeightFieldDesc.html#ffbec0b3ed43d041b12152648d13821b" title="The samples array.">PxHeightFieldDesc.samples</a>.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>destBuffer</em> </td><td>The destination buffer for the sample data. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>destBufferSize</em> </td><td>The size of the destination buffer. </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The number of bytes written.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxHeightFieldDesc.html#ffbec0b3ed43d041b12152648d13821b" title="The samples array.">PxHeightFieldDesc.samples</a> </dd></dl> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxHeightField_8h-source.html">PxHeightField.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> |