967 lines
68 KiB
HTML
967 lines
68 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.14"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>PxHeightField Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(initResizable);
|
|
/* @license-end */</script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="PhysXLogoBlack.png"/></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.14 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('classPxHeightField.html','');});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="classPxHeightField-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">PxHeightField Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__geomutils.html">Geomutils</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>A height field class.
|
|
<a href="classPxHeightField.html#details">More...</a></p>
|
|
|
|
<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="dyncontent">
|
|
<div class="center"><img src="classPxHeightField__inherit__graph.png" border="0" usemap="#PxHeightField_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="PxHeightField_inherit__map" id="PxHeightField_inherit__map">
|
|
<area shape="rect" id="node2" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection. " alt="" coords="23,5,91,32"/>
|
|
</map>
|
|
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for PxHeightField:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classPxHeightField__coll__graph.png" border="0" usemap="#PxHeightField_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="PxHeightField_coll__map" id="PxHeightField_coll__map">
|
|
<area shape="rect" id="node2" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection. " alt="" coords="48,109,116,136"/>
|
|
<area shape="rect" id="node3" href="classPxFlags.html" title="PxFlags\< PxBaseFlag\l::Enum, PxU16 \>" alt="" coords="5,5,159,47"/>
|
|
</map>
|
|
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a6b35bf964920daa991d6b509cbc02744"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#a6b35bf964920daa991d6b509cbc02744">release</a> ()=0</td></tr>
|
|
<tr class="memdesc:a6b35bf964920daa991d6b509cbc02744"><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="#a6b35bf964920daa991d6b509cbc02744">More...</a><br /></td></tr>
|
|
<tr class="separator:a6b35bf964920daa991d6b509cbc02744"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad509e93fd7d7fc43726160540faeb610"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#ad509e93fd7d7fc43726160540faeb610">saveCells</a> (void *destBuffer, <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> destBufferSize) const =0</td></tr>
|
|
<tr class="memdesc:ad509e93fd7d7fc43726160540faeb610"><td class="mdescLeft"> </td><td class="mdescRight">Writes out the sample data array. <a href="#ad509e93fd7d7fc43726160540faeb610">More...</a><br /></td></tr>
|
|
<tr class="separator:ad509e93fd7d7fc43726160540faeb610"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0f373ceba58f9b600be7a84103c04716"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#a0f373ceba58f9b600be7a84103c04716">modifySamples</a> (PxI32 startCol, PxI32 startRow, const <a class="el" href="classPxHeightFieldDesc.html">PxHeightFieldDesc</a> &subfieldDesc, bool shrinkBounds=false)=0</td></tr>
|
|
<tr class="memdesc:a0f373ceba58f9b600be7a84103c04716"><td class="mdescLeft"> </td><td class="mdescRight">Replaces a rectangular subfield in the sample data array. <a href="#a0f373ceba58f9b600be7a84103c04716">More...</a><br /></td></tr>
|
|
<tr class="separator:a0f373ceba58f9b600be7a84103c04716"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9c23959bd90dd2acf493e4a4a85b8b2e"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#a9c23959bd90dd2acf493e4a4a85b8b2e">getNbRows</a> () const =0</td></tr>
|
|
<tr class="memdesc:a9c23959bd90dd2acf493e4a4a85b8b2e"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the number of sample rows in the samples array. <a href="#a9c23959bd90dd2acf493e4a4a85b8b2e">More...</a><br /></td></tr>
|
|
<tr class="separator:a9c23959bd90dd2acf493e4a4a85b8b2e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adeb227d057ba7949ad536a26ad75adab"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#adeb227d057ba7949ad536a26ad75adab">getNbColumns</a> () const =0</td></tr>
|
|
<tr class="memdesc:adeb227d057ba7949ad536a26ad75adab"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the number of sample columns in the samples array. <a href="#adeb227d057ba7949ad536a26ad75adab">More...</a><br /></td></tr>
|
|
<tr class="separator:adeb227d057ba7949ad536a26ad75adab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a99d233a5a8ab9a835b5b2fd2115d639e"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> <a class="el" href="structPxHeightFieldFormat.html#ad28e3afa439f8ff1df6067288c46d9c5">PxHeightFieldFormat::Enum</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#a99d233a5a8ab9a835b5b2fd2115d639e">getFormat</a> () const =0</td></tr>
|
|
<tr class="memdesc:a99d233a5a8ab9a835b5b2fd2115d639e"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the format of the sample data. <a href="#a99d233a5a8ab9a835b5b2fd2115d639e">More...</a><br /></td></tr>
|
|
<tr class="separator:a99d233a5a8ab9a835b5b2fd2115d639e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a34935489b77f6d386bdfe15b4f10b00e"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#a34935489b77f6d386bdfe15b4f10b00e">getSampleStride</a> () const =0</td></tr>
|
|
<tr class="memdesc:a34935489b77f6d386bdfe15b4f10b00e"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the offset in bytes between consecutive samples in the array. <a href="#a34935489b77f6d386bdfe15b4f10b00e">More...</a><br /></td></tr>
|
|
<tr class="separator:a34935489b77f6d386bdfe15b4f10b00e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a59dfdd62f6c05c83f02bead7dad78ad8"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#a59dfdd62f6c05c83f02bead7dad78ad8">getConvexEdgeThreshold</a> () const =0</td></tr>
|
|
<tr class="memdesc:a59dfdd62f6c05c83f02bead7dad78ad8"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the convex edge threshold. <a href="#a59dfdd62f6c05c83f02bead7dad78ad8">More...</a><br /></td></tr>
|
|
<tr class="separator:a59dfdd62f6c05c83f02bead7dad78ad8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a30f6798a40d3f1dad7bf79bae941e082"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> <a class="el" href="group__geomutils.html#ga93b547b1968a59b2d23c91aab533e2c8">PxHeightFieldFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#a30f6798a40d3f1dad7bf79bae941e082">getFlags</a> () const =0</td></tr>
|
|
<tr class="memdesc:a30f6798a40d3f1dad7bf79bae941e082"><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="#a30f6798a40d3f1dad7bf79bae941e082">More...</a><br /></td></tr>
|
|
<tr class="separator:a30f6798a40d3f1dad7bf79bae941e082"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af59483ecc91d83d95a81a95a97657683"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#af59483ecc91d83d95a81a95a97657683">getHeight</a> (PxReal x, PxReal z) const =0</td></tr>
|
|
<tr class="memdesc:af59483ecc91d83d95a81a95a97657683"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the height at the given coordinates in grid space. <a href="#af59483ecc91d83d95a81a95a97657683">More...</a><br /></td></tr>
|
|
<tr class="separator:af59483ecc91d83d95a81a95a97657683"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0419a4b453fcc887b337d49877cfab28"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#a0419a4b453fcc887b337d49877cfab28">getReferenceCount</a> () const =0</td></tr>
|
|
<tr class="memdesc:a0419a4b453fcc887b337d49877cfab28"><td class="mdescLeft"> </td><td class="mdescRight">Returns the reference count for shared heightfields. <a href="#a0419a4b453fcc887b337d49877cfab28">More...</a><br /></td></tr>
|
|
<tr class="separator:a0419a4b453fcc887b337d49877cfab28"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3546ec17c1fc7a4ce538bd2944fd443c"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#a3546ec17c1fc7a4ce538bd2944fd443c">acquireReference</a> ()=0</td></tr>
|
|
<tr class="memdesc:a3546ec17c1fc7a4ce538bd2944fd443c"><td class="mdescLeft"> </td><td class="mdescRight">Acquires a counted reference to a heightfield. <a href="#a3546ec17c1fc7a4ce538bd2944fd443c">More...</a><br /></td></tr>
|
|
<tr class="separator:a3546ec17c1fc7a4ce538bd2944fd443c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a497c5cb500ffc7d5cc00929c2007723b"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> <a class="el" href="group__common.html#gac816bc62a68a52f01bf21f963295e822">PxMaterialTableIndex</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#a497c5cb500ffc7d5cc00929c2007723b">getTriangleMaterialIndex</a> (<a class="el" href="group__common.html#ga19403877bf7ce42d7240e4e4c758c016">PxTriangleID</a> triangleIndex) const =0</td></tr>
|
|
<tr class="memdesc:a497c5cb500ffc7d5cc00929c2007723b"><td class="mdescLeft"> </td><td class="mdescRight">Returns material table index of given triangle. <a href="#a497c5cb500ffc7d5cc00929c2007723b">More...</a><br /></td></tr>
|
|
<tr class="separator:a497c5cb500ffc7d5cc00929c2007723b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a36357857037f9fcb257e4c4ec8b85a04"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> <a class="el" href="classPxVec3.html">PxVec3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#a36357857037f9fcb257e4c4ec8b85a04">getTriangleNormal</a> (<a class="el" href="group__common.html#ga19403877bf7ce42d7240e4e4c758c016">PxTriangleID</a> triangleIndex) const =0</td></tr>
|
|
<tr class="memdesc:a36357857037f9fcb257e4c4ec8b85a04"><td class="mdescLeft"> </td><td class="mdescRight">Returns a triangle face normal for a given triangle index. <a href="#a36357857037f9fcb257e4c4ec8b85a04">More...</a><br /></td></tr>
|
|
<tr class="separator:a36357857037f9fcb257e4c4ec8b85a04"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a15f91d308f23a987dc672614aa64d5fa"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> const <a class="el" href="structPxHeightFieldSample.html">PxHeightFieldSample</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#a15f91d308f23a987dc672614aa64d5fa">getSample</a> (<a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> row, <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> column) const =0</td></tr>
|
|
<tr class="memdesc:a15f91d308f23a987dc672614aa64d5fa"><td class="mdescLeft"> </td><td class="mdescRight">Returns heightfield sample of given row and column. <a href="#a15f91d308f23a987dc672614aa64d5fa">More...</a><br /></td></tr>
|
|
<tr class="separator:a15f91d308f23a987dc672614aa64d5fa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae4136344e0c9ed9c773c304bc87690fe"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#ae4136344e0c9ed9c773c304bc87690fe">getTimestamp</a> () const =0</td></tr>
|
|
<tr class="memdesc:ae4136344e0c9ed9c773c304bc87690fe"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of times the heightfield data has been modified. <a href="#ae4136344e0c9ed9c773c304bc87690fe">More...</a><br /></td></tr>
|
|
<tr class="separator:ae4136344e0c9ed9c773c304bc87690fe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae16c0e77bce5140d5aaa35e9a840a798"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#ae16c0e77bce5140d5aaa35e9a840a798">getConcreteTypeName</a> () const</td></tr>
|
|
<tr class="memdesc:ae16c0e77bce5140d5aaa35e9a840a798"><td class="mdescLeft"> </td><td class="mdescRight">Returns string name of dynamic type. <a href="#ae16c0e77bce5140d5aaa35e9a840a798">More...</a><br /></td></tr>
|
|
<tr class="separator:ae16c0e77bce5140d5aaa35e9a840a798"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classPxBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classPxBase')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classPxBase.html">PxBase</a></td></tr>
|
|
<tr class="memitem:a4bc720adef86ea68bfb5845f0e104d23 inherit pub_methods_classPxBase"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
|
|
<tr class="memitem:a4bc720adef86ea68bfb5845f0e104d23 inherit pub_methods_classPxBase"><td class="memTemplItemLeft" align="right" valign="top">T * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classPxBase.html#a4bc720adef86ea68bfb5845f0e104d23">is</a> ()</td></tr>
|
|
<tr class="separator:a4bc720adef86ea68bfb5845f0e104d23 inherit pub_methods_classPxBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a85aa50ac0e5670a2be64411fea62b5e3 inherit pub_methods_classPxBase"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
|
|
<tr class="memitem:a85aa50ac0e5670a2be64411fea62b5e3 inherit pub_methods_classPxBase"><td class="memTemplItemLeft" align="right" valign="top">const T * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classPxBase.html#a85aa50ac0e5670a2be64411fea62b5e3">is</a> () const</td></tr>
|
|
<tr class="separator:a85aa50ac0e5670a2be64411fea62b5e3 inherit pub_methods_classPxBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab4e0691a08e49631dc60014d49c7585f inherit pub_methods_classPxBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> <a class="el" href="group__common.html#gac1fb4b256a5d900d394e89db170a2b79">PxType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBase.html#ab4e0691a08e49631dc60014d49c7585f">getConcreteType</a> () const</td></tr>
|
|
<tr class="memdesc:ab4e0691a08e49631dc60014d49c7585f inherit pub_methods_classPxBase"><td class="mdescLeft"> </td><td class="mdescRight">Returns concrete type of object. <a href="classPxBase.html#ab4e0691a08e49631dc60014d49c7585f">More...</a><br /></td></tr>
|
|
<tr class="separator:ab4e0691a08e49631dc60014d49c7585f inherit pub_methods_classPxBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1dd20bb574075df904e1878f2e771ef9 inherit pub_methods_classPxBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBase.html#a1dd20bb574075df904e1878f2e771ef9">setBaseFlag</a> (<a class="el" href="structPxBaseFlag.html#ac258de0c7adaa37f81b6ab1b0c86a6ee">PxBaseFlag::Enum</a> flag, bool value)</td></tr>
|
|
<tr class="memdesc:a1dd20bb574075df904e1878f2e771ef9 inherit pub_methods_classPxBase"><td class="mdescLeft"> </td><td class="mdescRight">Set <a class="el" href="structPxBaseFlag.html" title="Flags for PxBase. ">PxBaseFlag</a>. <a href="classPxBase.html#a1dd20bb574075df904e1878f2e771ef9">More...</a><br /></td></tr>
|
|
<tr class="separator:a1dd20bb574075df904e1878f2e771ef9 inherit pub_methods_classPxBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afb391b692c561df0a54c413785e4ebd0 inherit pub_methods_classPxBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBase.html#afb391b692c561df0a54c413785e4ebd0">setBaseFlags</a> (<a class="el" href="group__common.html#ga1e3721588799f5fbb18d76e4aab7d018">PxBaseFlags</a> inFlags)</td></tr>
|
|
<tr class="memdesc:afb391b692c561df0a54c413785e4ebd0 inherit pub_methods_classPxBase"><td class="mdescLeft"> </td><td class="mdescRight">Set PxBaseFlags. <a href="classPxBase.html#afb391b692c561df0a54c413785e4ebd0">More...</a><br /></td></tr>
|
|
<tr class="separator:afb391b692c561df0a54c413785e4ebd0 inherit pub_methods_classPxBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad9b10efae7733ff9c8b8d3b7d90a9a5f inherit pub_methods_classPxBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> <a class="el" href="group__common.html#ga1e3721588799f5fbb18d76e4aab7d018">PxBaseFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBase.html#ad9b10efae7733ff9c8b8d3b7d90a9a5f">getBaseFlags</a> () const</td></tr>
|
|
<tr class="memdesc:ad9b10efae7733ff9c8b8d3b7d90a9a5f inherit pub_methods_classPxBase"><td class="mdescLeft"> </td><td class="mdescRight">Returns PxBaseFlags. <a href="classPxBase.html#ad9b10efae7733ff9c8b8d3b7d90a9a5f">More...</a><br /></td></tr>
|
|
<tr class="separator:ad9b10efae7733ff9c8b8d3b7d90a9a5f inherit pub_methods_classPxBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a38952fcb80e99f1f5dbf774a75ac2c3d inherit pub_methods_classPxBase"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBase.html#a38952fcb80e99f1f5dbf774a75ac2c3d">isReleasable</a> () const</td></tr>
|
|
<tr class="memdesc:a38952fcb80e99f1f5dbf774a75ac2c3d inherit pub_methods_classPxBase"><td class="mdescLeft"> </td><td class="mdescRight">Whether the object is subordinate. <a href="classPxBase.html#a38952fcb80e99f1f5dbf774a75ac2c3d">More...</a><br /></td></tr>
|
|
<tr class="separator:a38952fcb80e99f1f5dbf774a75ac2c3d inherit pub_methods_classPxBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:a3687346446cb1c0f7ec1e36ccebb0e65"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#a3687346446cb1c0f7ec1e36ccebb0e65">PxHeightField</a> (<a class="el" href="group__common.html#gac1fb4b256a5d900d394e89db170a2b79">PxType</a> concreteType, <a class="el" href="group__common.html#ga1e3721588799f5fbb18d76e4aab7d018">PxBaseFlags</a> baseFlags)</td></tr>
|
|
<tr class="separator:a3687346446cb1c0f7ec1e36ccebb0e65"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2803c15d545408ec8f6c8bbfbdac915c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#a2803c15d545408ec8f6c8bbfbdac915c">PxHeightField</a> (<a class="el" href="group__common.html#ga1e3721588799f5fbb18d76e4aab7d018">PxBaseFlags</a> baseFlags)</td></tr>
|
|
<tr class="separator:a2803c15d545408ec8f6c8bbfbdac915c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae396d735d14cac4cf08958256362bc79"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#ae396d735d14cac4cf08958256362bc79">~PxHeightField</a> ()</td></tr>
|
|
<tr class="separator:ae396d735d14cac4cf08958256362bc79"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2e6bfa5be89062a4a8156866e529f9d5"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightField.html#a2e6bfa5be89062a4a8156866e529f9d5">isKindOf</a> (const char *name) const</td></tr>
|
|
<tr class="memdesc:a2e6bfa5be89062a4a8156866e529f9d5"><td class="mdescLeft"> </td><td class="mdescRight">Returns whether a given type name matches with the type of this instance. <a href="#a2e6bfa5be89062a4a8156866e529f9d5">More...</a><br /></td></tr>
|
|
<tr class="separator:a2e6bfa5be89062a4a8156866e529f9d5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pro_methods_classPxBase"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classPxBase')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classPxBase.html">PxBase</a></td></tr>
|
|
<tr class="memitem:a263f1ef821c74058ce9335e06cb842a4 inherit pro_methods_classPxBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBase.html#a263f1ef821c74058ce9335e06cb842a4">PxBase</a> (<a class="el" href="group__common.html#gac1fb4b256a5d900d394e89db170a2b79">PxType</a> concreteType, <a class="el" href="group__common.html#ga1e3721588799f5fbb18d76e4aab7d018">PxBaseFlags</a> baseFlags)</td></tr>
|
|
<tr class="memdesc:a263f1ef821c74058ce9335e06cb842a4 inherit pro_methods_classPxBase"><td class="mdescLeft"> </td><td class="mdescRight">Constructor setting concrete type and base flags. <a href="classPxBase.html#a263f1ef821c74058ce9335e06cb842a4">More...</a><br /></td></tr>
|
|
<tr class="separator:a263f1ef821c74058ce9335e06cb842a4 inherit pro_methods_classPxBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a58b979202e7382701f74977fe3dd5c6f inherit pro_methods_classPxBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBase.html#a58b979202e7382701f74977fe3dd5c6f">PxBase</a> (<a class="el" href="group__common.html#ga1e3721588799f5fbb18d76e4aab7d018">PxBaseFlags</a> baseFlags)</td></tr>
|
|
<tr class="memdesc:a58b979202e7382701f74977fe3dd5c6f inherit pro_methods_classPxBase"><td class="mdescLeft"> </td><td class="mdescRight">Deserialization constructor setting base flags. <a href="classPxBase.html#a58b979202e7382701f74977fe3dd5c6f">More...</a><br /></td></tr>
|
|
<tr class="separator:a58b979202e7382701f74977fe3dd5c6f inherit pro_methods_classPxBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adfbf62dc32775b068db1c74c7fd3d982 inherit pro_methods_classPxBase"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBase.html#adfbf62dc32775b068db1c74c7fd3d982">~PxBase</a> ()</td></tr>
|
|
<tr class="memdesc:adfbf62dc32775b068db1c74c7fd3d982 inherit pro_methods_classPxBase"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="classPxBase.html#adfbf62dc32775b068db1c74c7fd3d982">More...</a><br /></td></tr>
|
|
<tr class="separator:adfbf62dc32775b068db1c74c7fd3d982 inherit pro_methods_classPxBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3782ca64c8f12c41443f604e300fc207 inherit pro_methods_classPxBase"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
|
|
<tr class="memitem:a3782ca64c8f12c41443f604e300fc207 inherit pro_methods_classPxBase"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classPxBase.html#a3782ca64c8f12c41443f604e300fc207">typeMatch</a> () const</td></tr>
|
|
<tr class="separator:a3782ca64c8f12c41443f604e300fc207 inherit pro_methods_classPxBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
|
|
Additional Inherited Members</h2></td></tr>
|
|
<tr class="inherit_header pro_attribs_classPxBase"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classPxBase')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classPxBase.html">PxBase</a></td></tr>
|
|
<tr class="memitem:a1abe9d19726e1f8f8e56abeb2269b5d4 inherit pro_attribs_classPxBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#gac1fb4b256a5d900d394e89db170a2b79">PxType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBase.html#a1abe9d19726e1f8f8e56abeb2269b5d4">mConcreteType</a></td></tr>
|
|
<tr class="separator:a1abe9d19726e1f8f8e56abeb2269b5d4 inherit pro_attribs_classPxBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aff7105f65905ecb9f6f7993ba28b712d inherit pro_attribs_classPxBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga1e3721588799f5fbb18d76e4aab7d018">PxBaseFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBase.html#aff7105f65905ecb9f6f7993ba28b712d">mBaseFlags</a></td></tr>
|
|
<tr class="separator:aff7105f65905ecb9f6f7993ba28b712d inherit pro_attribs_classPxBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>A height field class. </p>
|
|
<p>Height fields work in a similar way as triangle meshes specified to act as height fields, with some important differences:</p>
|
|
<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>
|
|
<p>In local space rows extend in X direction, columns in Z direction and height in Y direction.</p>
|
|
<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>
|
|
<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#a1806546c22306e8d44b7ff7719fbcc99" title="Creates a heightfield object from previously cooked stream. ">PxPhysics::createHeightField()</a> or PxCooking::createHeightField(const PxHeightFieldDesc&, PxPhysicsInsertionCallback&). To delete it call <a class="el" href="classPxHeightField.html#a6b35bf964920daa991d6b509cbc02744" title="Decrements the reference count of a height field and releases it if the new reference count is zero...">release()</a>. This is only possible once you have released all of its PxHeightFiedShape instances.</p>
|
|
<h3>Visualizations:</h3>
|
|
<ul>
|
|
<li><a class="el" href="structPxVisualizationParameter.html#adce8e8a77c144356b0968d2b9f79eb10a714f24bab39d1bbe8b131bd10ef5552b" title="Visualize bounds (AABBs in world space) ">PxVisualizationParameter::eCOLLISION_AABBS</a> </li>
|
|
<li><a class="el" href="structPxVisualizationParameter.html#adce8e8a77c144356b0968d2b9f79eb10a515f4c3c72ee88d7507b52d6ccd14eab" title="Shape visualization. ">PxVisualizationParameter::eCOLLISION_SHAPES</a> </li>
|
|
<li><a class="el" href="structPxVisualizationParameter.html#adce8e8a77c144356b0968d2b9f79eb10a0ad9dcb10f5f3d6ded3baecfc1e387d3" title="Shape axis visualization. ">PxVisualizationParameter::eCOLLISION_AXES</a> </li>
|
|
<li><a class="el" href="structPxVisualizationParameter.html#adce8e8a77c144356b0968d2b9f79eb10afd900f30ba421d555e7f7b087126cd92" title="Mesh & convex face normals. ">PxVisualizationParameter::eCOLLISION_FNORMALS</a> </li>
|
|
<li><a class="el" href="structPxVisualizationParameter.html#adce8e8a77c144356b0968d2b9f79eb10aa0e06ca7fa1a0445abe0f4d293feb961" title="Active edges for meshes. ">PxVisualizationParameter::eCOLLISION_EDGES</a></li>
|
|
</ul>
|
|
<dl class="section see"><dt>See also</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#a1806546c22306e8d44b7ff7719fbcc99" title="Creates a heightfield object from previously cooked stream. ">PxPhysics.createHeightField()</a> <a class="el" href="classPxCooking.html#a0a3d0ec6145be91dd6707535724d8ffb" title="Cooks and creates a heightfield mesh and inserts it into PxPhysics. ">PxCooking.createHeightField()</a> </dd></dl>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a3687346446cb1c0f7ec1e36ccebb0e65"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3687346446cb1c0f7ec1e36ccebb0e65">◆ </a></span>PxHeightField() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> PxHeightField::PxHeightField </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__common.html#gac1fb4b256a5d900d394e89db170a2b79">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="group__common.html#ga1e3721588799f5fbb18d76e4aab7d018">PxBaseFlags</a> </td>
|
|
<td class="paramname"><em>baseFlags</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2803c15d545408ec8f6c8bbfbdac915c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2803c15d545408ec8f6c8bbfbdac915c">◆ </a></span>PxHeightField() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> PxHeightField::PxHeightField </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__common.html#ga1e3721588799f5fbb18d76e4aab7d018">PxBaseFlags</a> </td>
|
|
<td class="paramname"><em>baseFlags</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae396d735d14cac4cf08958256362bc79"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae396d735d14cac4cf08958256362bc79">◆ </a></span>~PxHeightField()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> PxHeightField::~PxHeightField </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a3546ec17c1fc7a4ce538bd2944fd443c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3546ec17c1fc7a4ce538bd2944fd443c">◆ </a></span>acquireReference()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> void PxHeightField::acquireReference </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Acquires a counted reference to a heightfield. </p>
|
|
<p>This method increases the reference count of the heightfield by 1. Decrement the reference count by calling <a class="el" href="classPxHeightField.html#a6b35bf964920daa991d6b509cbc02744" title="Decrements the reference count of a height field and releases it if the new reference count is zero...">release()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae16c0e77bce5140d5aaa35e9a840a798"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae16c0e77bce5140d5aaa35e9a840a798">◆ </a></span>getConcreteTypeName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> const char* PxHeightField::getConcreteTypeName </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns string name of dynamic type. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Class name of most derived type of this object. </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classPxBase.html#a67fe206d8897ddce896c371ac8d789a9">PxBase</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a59dfdd62f6c05c83f02bead7dad78ad8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a59dfdd62f6c05c83f02bead7dad78ad8">◆ </a></span>getConvexEdgeThreshold()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> PxReal PxHeightField::getConvexEdgeThreshold </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves the convex edge threshold. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The convex edge threshold.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxHeightFieldDesc.html#a2c40081aa73ec042021785dbe52f75fb">PxHeightFieldDesc.convexEdgeThreshold</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a30f6798a40d3f1dad7bf79bae941e082"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a30f6798a40d3f1dad7bf79bae941e082">◆ </a></span>getFlags()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> <a class="el" href="group__geomutils.html#ga93b547b1968a59b2d23c91aab533e2c8">PxHeightFieldFlags</a> PxHeightField::getFlags </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </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="section return"><dt>Returns</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="section see"><dt>See also</dt><dd><a class="el" href="classPxHeightFieldDesc.html#aec8940d776191d6ca950025836481360" 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>
|
|
<a id="a99d233a5a8ab9a835b5b2fd2115d639e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a99d233a5a8ab9a835b5b2fd2115d639e">◆ </a></span>getFormat()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> <a class="el" href="structPxHeightFieldFormat.html#ad28e3afa439f8ff1df6067288c46d9c5">PxHeightFieldFormat::Enum</a> PxHeightField::getFormat </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves the format of the sample data. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The format of the sample data.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxHeightFieldDesc.html#a8743d198a4db234d353c1f4d2734d43d" 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>
|
|
<a id="af59483ecc91d83d95a81a95a97657683"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af59483ecc91d83d95a81a95a97657683">◆ </a></span>getHeight()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> 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>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves the height at the given coordinates in grid space. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The height at the given coordinates or 0 if the coordinates are out of range. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adeb227d057ba7949ad536a26ad75adab"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adeb227d057ba7949ad536a26ad75adab">◆ </a></span>getNbColumns()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> PxHeightField::getNbColumns </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves the number of sample columns in the samples array. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of sample columns in the samples array.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxHeightFieldDesc.html#a8426b15eb6ad44c11fcb84bb9e3350c0" title="Number of sample columns in the height field samples array. ">PxHeightFieldDesc.nbColumns</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9c23959bd90dd2acf493e4a4a85b8b2e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9c23959bd90dd2acf493e4a4a85b8b2e">◆ </a></span>getNbRows()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> PxHeightField::getNbRows </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves the number of sample rows in the samples array. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of sample rows in the samples array.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxHeightFieldDesc.html#ac701700af3c4597a4a39a76e3331dd08" title="Number of sample rows in the height field samples array. ">PxHeightFieldDesc.nbRows</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0419a4b453fcc887b337d49877cfab28"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0419a4b453fcc887b337d49877cfab28">◆ </a></span>getReferenceCount()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> PxHeightField::getReferenceCount </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the reference count for shared heightfields. </p>
|
|
<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="section return"><dt>Returns</dt><dd>the current reference count. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a15f91d308f23a987dc672614aa64d5fa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a15f91d308f23a987dc672614aa64d5fa">◆ </a></span>getSample()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> const <a class="el" href="structPxHeightFieldSample.html">PxHeightFieldSample</a>& PxHeightField::getSample </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
|
|
<td class="paramname"><em>row</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
|
|
<td class="paramname"><em>column</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns heightfield sample of given row and column. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">row</td><td>Given heightfield row </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">column</td><td>Given heightfield column </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Heightfield sample </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a34935489b77f6d386bdfe15b4f10b00e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a34935489b77f6d386bdfe15b4f10b00e">◆ </a></span>getSampleStride()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> PxHeightField::getSampleStride </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves the offset in bytes between consecutive samples in the array. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The offset in bytes between consecutive samples in the array.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd>PxHeightFieldDesc.sampleStride </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae4136344e0c9ed9c773c304bc87690fe"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae4136344e0c9ed9c773c304bc87690fe">◆ </a></span>getTimestamp()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> PxHeightField::getTimestamp </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the number of times the heightfield data has been modified. </p>
|
|
<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="section return"><dt>Returns</dt><dd>the number of times the heightfield sample data has been modified. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a497c5cb500ffc7d5cc00929c2007723b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a497c5cb500ffc7d5cc00929c2007723b">◆ </a></span>getTriangleMaterialIndex()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> <a class="el" href="group__common.html#gac816bc62a68a52f01bf21f963295e822">PxMaterialTableIndex</a> PxHeightField::getTriangleMaterialIndex </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__common.html#ga19403877bf7ce42d7240e4e4c758c016">PxTriangleID</a> </td>
|
|
<td class="paramname"><em>triangleIndex</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns material table index of given triangle. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This function takes a post cooking triangle index.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">triangleIndex</td><td>(internal) index of desired triangle </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Material table index, or 0xffff if no per-triangle materials are used </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a36357857037f9fcb257e4c4ec8b85a04"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a36357857037f9fcb257e4c4ec8b85a04">◆ </a></span>getTriangleNormal()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> <a class="el" href="classPxVec3.html">PxVec3</a> PxHeightField::getTriangleNormal </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__common.html#ga19403877bf7ce42d7240e4e4c758c016">PxTriangleID</a> </td>
|
|
<td class="paramname"><em>triangleIndex</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a triangle face normal for a given triangle index. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This function takes a post cooking triangle index.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">triangleIndex</td><td>(internal) index of desired triangle </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Triangle normal for a given triangle index </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2e6bfa5be89062a4a8156866e529f9d5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2e6bfa5be89062a4a8156866e529f9d5">◆ </a></span>isKindOf()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> bool PxHeightField::isKindOf </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>superClass</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </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#addfc067afca2f67bda6c497b14424962">PxBase</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="classPxBase.html#addfc067afca2f67bda6c497b14424962">PxBase::isKindOf()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0f373ceba58f9b600be7a84103c04716"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0f373ceba58f9b600be7a84103c04716">◆ </a></span>modifySamples()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> 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>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Replaces a rectangular subfield in the sample data array. </p>
|
|
<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#affbec0b3ed43d041b12152648d13821b" title="The samples array. ">PxHeightFieldDesc.samples</a>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">startCol</td><td>First cell in the destination heightfield to be modified. Can be negative. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">startRow</td><td>First row in the destination heightfield to be modified. Can be negative. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">subfieldDesc</td><td>Description of the source subfield to read the samples from. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">shrinkBounds</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>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True on success, false on failure. Failure can occur due to format mismatch.</dd></dl>
|
|
<dl class="section note"><dt>Note</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#ac6112e8c0ee9803eb3436bbaf673d98a" 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#ac6112e8c0ee9803eb3436bbaf673d98a" 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="section see"><dt>See also</dt><dd><a class="el" href="classPxHeightFieldDesc.html#affbec0b3ed43d041b12152648d13821b" title="The samples array. ">PxHeightFieldDesc.samples</a> <a class="el" href="classPxShape.html#ac6112e8c0ee9803eb3436bbaf673d98a" title="Adjust the geometry of the shape. ">PxShape.setGeometry</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6b35bf964920daa991d6b509cbc02744"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6b35bf964920daa991d6b509cbc02744">◆ </a></span>release()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> void PxHeightField::release </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </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="section see"><dt>See also</dt><dd><a class="el" href="classPxPhysics.html#a1806546c22306e8d44b7ff7719fbcc99" 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#afe6aedda1df0d6d29b1a28213a5ee25a">PxBase</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad509e93fd7d7fc43726160540faeb610"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad509e93fd7d7fc43726160540faeb610">◆ </a></span>saveCells()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="group__common.html#ga87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">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#gacce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
|
|
<td class="paramname"><em>destBufferSize</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Writes out the sample data array. </p>
|
|
<p>The user provides destBufferSize bytes storage at destBuffer. The data is formatted and arranged as <a class="el" href="classPxHeightFieldDesc.html#affbec0b3ed43d041b12152648d13821b" title="The samples array. ">PxHeightFieldDesc.samples</a>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">destBuffer</td><td>The destination buffer for the sample data. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">destBufferSize</td><td>The size of the destination buffer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of bytes written.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxHeightFieldDesc.html#affbec0b3ed43d041b12152648d13821b" title="The samples array. ">PxHeightFieldDesc.samples</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<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></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- HTML footer for doxygen 1.8.14-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="classPxHeightField.html">PxHeightField</a></li>
|
|
<li class="footer">Copyright © 2008-2021 NVIDIA Corporation, 2788 San Tomas Expressway, Santa Clara, CA 95051 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a></li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|