aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/PxHeightFieldDesc_8h-source.html
diff options
context:
space:
mode:
authorgit perforce import user <a@b>2016-10-25 12:29:14 -0600
committerSheikh Dawood Abdul Ajees <Sheikh Dawood Abdul Ajees>2016-10-25 18:56:37 -0500
commit3dfe2108cfab31ba3ee5527e217d0d8e99a51162 (patch)
treefa6485c169e50d7415a651bf838f5bcd0fd3bfbd /PhysX_3.4/Documentation/PhysXAPI/files/PxHeightFieldDesc_8h-source.html
downloadphysx-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/PxHeightFieldDesc_8h-source.html')
-rw-r--r--PhysX_3.4/Documentation/PhysXAPI/files/PxHeightFieldDesc_8h-source.html133
1 files changed, 133 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/PxHeightFieldDesc_8h-source.html b/PhysX_3.4/Documentation/PhysXAPI/files/PxHeightFieldDesc_8h-source.html
new file mode 100644
index 00000000..e519dfba
--- /dev/null
+++ b/PhysX_3.4/Documentation/PhysXAPI/files/PxHeightFieldDesc_8h-source.html
@@ -0,0 +1,133 @@
+<html>
+ <head>
+ <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxHeightFieldDesc.h Source File</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> &nbsp;
+ <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp;
+ <a class="qindex" href="annotated.html">Compound List</a> &nbsp;
+ <a class="qindex" href="functions.html">Compound Members</a> &nbsp;
+ </center>
+ <hr class="second">
+ </div>
+<!-- Generated by Doxygen 1.5.8 -->
+<h1>PxHeightFieldDesc.h</h1><a href="PxHeightFieldDesc_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// This code contains NVIDIA Confidential Information and is disclosed to you</span>
+<a name="l00002"></a>00002 <span class="comment">// under a form of NVIDIA software license agreement provided separately to you.</span>
+<a name="l00003"></a>00003 <span class="comment">//</span>
+<a name="l00004"></a>00004 <span class="comment">// Notice</span>
+<a name="l00005"></a>00005 <span class="comment">// NVIDIA Corporation and its licensors retain all intellectual property and</span>
+<a name="l00006"></a>00006 <span class="comment">// proprietary rights in and to this software and related documentation and</span>
+<a name="l00007"></a>00007 <span class="comment">// any modifications thereto. Any use, reproduction, disclosure, or</span>
+<a name="l00008"></a>00008 <span class="comment">// distribution of this software and related documentation without an express</span>
+<a name="l00009"></a>00009 <span class="comment">// license agreement from NVIDIA Corporation is strictly prohibited.</span>
+<a name="l00010"></a>00010 <span class="comment">//</span>
+<a name="l00011"></a>00011 <span class="comment">// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES</span>
+<a name="l00012"></a>00012 <span class="comment">// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO</span>
+<a name="l00013"></a>00013 <span class="comment">// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,</span>
+<a name="l00014"></a>00014 <span class="comment">// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.</span>
+<a name="l00015"></a>00015 <span class="comment">//</span>
+<a name="l00016"></a>00016 <span class="comment">// Information and code furnished is believed to be accurate and reliable.</span>
+<a name="l00017"></a>00017 <span class="comment">// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such</span>
+<a name="l00018"></a>00018 <span class="comment">// information or for any infringement of patents or other rights of third parties that may</span>
+<a name="l00019"></a>00019 <span class="comment">// result from its use. No license is granted by implication or otherwise under any patent</span>
+<a name="l00020"></a>00020 <span class="comment">// or patent rights of NVIDIA Corporation. Details are subject to change without notice.</span>
+<a name="l00021"></a>00021 <span class="comment">// This code supersedes and replaces all information previously supplied.</span>
+<a name="l00022"></a>00022 <span class="comment">// NVIDIA Corporation products are not authorized for use as critical</span>
+<a name="l00023"></a>00023 <span class="comment">// components in life support devices or systems without express written approval of</span>
+<a name="l00024"></a>00024 <span class="comment">// NVIDIA Corporation.</span>
+<a name="l00025"></a>00025 <span class="comment">//</span>
+<a name="l00026"></a>00026 <span class="comment">// Copyright (c) 2008-2016 NVIDIA Corporation. All rights reserved.</span>
+<a name="l00027"></a>00027 <span class="comment">// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.</span>
+<a name="l00028"></a>00028 <span class="comment">// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.</span>
+<a name="l00029"></a>00029
+<a name="l00030"></a>00030
+<a name="l00031"></a>00031 <span class="preprocessor">#ifndef PX_COLLISION_NXHEIGHTFIELDDESC</span>
+<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="preprocessor">#define PX_COLLISION_NXHEIGHTFIELDDESC</span>
+<a name="l00033"></a>00033 <span class="preprocessor"></span>
+<a name="l00037"></a>00037 <span class="preprocessor">#include "<a class="code" href="PxBounds3_8h.html">foundation/PxBounds3.h</a>"</span>
+<a name="l00038"></a>00038 <span class="preprocessor">#include "<a class="code" href="PxPhysXCommonConfig_8h.html">common/PxPhysXCommonConfig.h</a>"</span>
+<a name="l00039"></a>00039 <span class="preprocessor">#include "<a class="code" href="PxHeightFieldFlag_8h.html">geometry/PxHeightFieldFlag.h</a>"</span>
+<a name="l00040"></a>00040 <span class="preprocessor">#include "<a class="code" href="PxCoreUtilityTypes_8h.html">common/PxCoreUtilityTypes.h</a>"</span>
+<a name="l00041"></a>00041
+<a name="l00042"></a>00042 <span class="preprocessor">#if !PX_DOXYGEN</span>
+<a name="l00043"></a>00043 <span class="preprocessor"></span><span class="keyword">namespace </span>physx
+<a name="l00044"></a>00044 {
+<a name="l00045"></a>00045 <span class="preprocessor">#endif</span>
+<a name="l00046"></a>00046 <span class="preprocessor"></span>
+<a name="l00055"></a><a class="code" href="classPxHeightFieldDesc.html">00055</a> <span class="keyword">class </span><a class="code" href="classPxHeightFieldDesc.html" title="Descriptor class for PxHeightField.">PxHeightFieldDesc</a>
+<a name="l00056"></a>00056 {
+<a name="l00057"></a>00057 <span class="keyword">public</span>:
+<a name="l00058"></a>00058
+<a name="l00067"></a><a class="code" href="classPxHeightFieldDesc.html#c701700af3c4597a4a39a76e3331dd08">00067</a> <a class="code" href="namespacephysx.html#9b7fbd746d18bf5b6545713a8d818f41">PxU32</a> nbRows;
+<a name="l00068"></a>00068
+<a name="l00077"></a><a class="code" href="classPxHeightFieldDesc.html#8426b15eb6ad44c11fcb84bb9e3350c0">00077</a> <a class="code" href="namespacephysx.html#9b7fbd746d18bf5b6545713a8d818f41">PxU32</a> nbColumns;
+<a name="l00078"></a>00078
+<a name="l00088"></a><a class="code" href="classPxHeightFieldDesc.html#8743d198a4db234d353c1f4d2734d43d">00088</a> <a class="code" href="structPxHeightFieldFormat.html#d28e3afa439f8ff1df6067288c46d9c5">PxHeightFieldFormat::Enum</a> format;
+<a name="l00089"></a>00089
+<a name="l00108"></a><a class="code" href="classPxHeightFieldDesc.html#ffbec0b3ed43d041b12152648d13821b">00108</a> <a class="code" href="structPxStridedData.html">PxStridedData</a> samples;
+<a name="l00109"></a>00109
+<a name="l00127"></a><a class="code" href="classPxHeightFieldDesc.html#6cef36e916c7350a106929ec44d8d895">00127</a> <a class="code" href="group__foundation.html#gfd8f8779793627061774cfcfa1b9fbd7">PX_DEPRECATED</a> <a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> thickness;
+<a name="l00128"></a>00128
+<a name="l00143"></a><a class="code" href="classPxHeightFieldDesc.html#2c40081aa73ec042021785dbe52f75fb">00143</a> <a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> convexEdgeThreshold;
+<a name="l00144"></a>00144
+<a name="l00152"></a><a class="code" href="classPxHeightFieldDesc.html#ec8940d776191d6ca950025836481360">00152</a> <a class="code" href="classPxFlags.html">PxHeightFieldFlags</a> flags;
+<a name="l00153"></a>00153
+<a name="l00157"></a>00157 <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <a class="code" href="classPxHeightFieldDesc.html" title="Descriptor class for PxHeightField.">PxHeightFieldDesc</a>();
+<a name="l00158"></a>00158
+<a name="l00162"></a>00162 <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <span class="keywordtype">void</span> setToDefault();
+<a name="l00163"></a>00163
+<a name="l00168"></a>00168 <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <span class="keywordtype">bool</span> isValid() <span class="keyword">const</span>;
+<a name="l00169"></a>00169 };
+<a name="l00170"></a>00170
+<a name="l00171"></a><a class="code" href="group__geomutils.html#g0e3fd140462fac286debed6c6a960c3d">00171</a> <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <a class="code" href="group__geomutils.html#g0e3fd140462fac286debed6c6a960c3d" title="Constructor sets to default.">PxHeightFieldDesc::PxHeightFieldDesc</a>() <span class="comment">//constructor sets to default</span>
+<a name="l00172"></a>00172 {
+<a name="l00173"></a>00173 <a class="code" href="classPxHeightFieldDesc.html#8426b15eb6ad44c11fcb84bb9e3350c0" title="Number of sample columns in the height field samples array.">nbColumns</a> = 0;
+<a name="l00174"></a>00174 <a class="code" href="classPxHeightFieldDesc.html#c701700af3c4597a4a39a76e3331dd08" title="Number of sample rows in the height field samples array.">nbRows</a> = 0;
+<a name="l00175"></a>00175 <a class="code" href="classPxHeightFieldDesc.html#8743d198a4db234d353c1f4d2734d43d" title="Format of the sample data.">format</a> = <a class="code" href="structPxHeightFieldFormat.html#d28e3afa439f8ff1df6067288c46d9c5a8ba1edf74a561d830b5f40e2c3e64e7" title="Height field height data is 16 bit signed integers, followed by triangle materials...">PxHeightFieldFormat::eS16_TM</a>;
+<a name="l00176"></a>00176 <a class="code" href="classPxHeightFieldDesc.html#6cef36e916c7350a106929ec44d8d895" title="Sets how thick the heightfield surface is.">thickness</a> = -1.0f;
+<a name="l00177"></a>00177 <a class="code" href="classPxHeightFieldDesc.html#2c40081aa73ec042021785dbe52f75fb">convexEdgeThreshold</a> = 0.0f;
+<a name="l00178"></a>00178 <a class="code" href="classPxHeightFieldDesc.html#ec8940d776191d6ca950025836481360" title="Flags bits, combined from values of the enum PxHeightFieldFlag.">flags</a> = <a class="code" href="group__geomutils.html#g93b547b1968a59b2d23c91aab533e2c8" title="collection of set bits defined in PxHeightFieldFlag.">PxHeightFieldFlags</a>();
+<a name="l00179"></a>00179 }
+<a name="l00180"></a>00180
+<a name="l00181"></a><a class="code" href="group__geomutils.html#gdd7ec6c255262ddceeb7e04600bc47b5">00181</a> <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <span class="keywordtype">void</span> <a class="code" href="group__geomutils.html#gdd7ec6c255262ddceeb7e04600bc47b5" title="(re)sets the structure to the default.">PxHeightFieldDesc::setToDefault</a>()
+<a name="l00182"></a>00182 {
+<a name="l00183"></a>00183 *<span class="keyword">this</span> = <a class="code" href="group__geomutils.html#g0e3fd140462fac286debed6c6a960c3d" title="Constructor sets to default.">PxHeightFieldDesc</a>();
+<a name="l00184"></a>00184 }
+<a name="l00185"></a>00185
+<a name="l00186"></a><a class="code" href="group__geomutils.html#gac3042beb40e73337fff5bddcd8f1ccc">00186</a> <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <span class="keywordtype">bool</span> <a class="code" href="group__geomutils.html#gac3042beb40e73337fff5bddcd8f1ccc" title="Returns true if the descriptor is valid.">PxHeightFieldDesc::isValid</a>()<span class="keyword"> const</span>
+<a name="l00187"></a>00187 <span class="keyword"></span>{
+<a name="l00188"></a>00188 <span class="keywordflow">if</span> (<a class="code" href="classPxHeightFieldDesc.html#8426b15eb6ad44c11fcb84bb9e3350c0" title="Number of sample columns in the height field samples array.">nbColumns</a> &lt; 2)
+<a name="l00189"></a>00189 <span class="keywordflow">return</span> <span class="keyword">false</span>;
+<a name="l00190"></a>00190 <span class="keywordflow">if</span> (<a class="code" href="classPxHeightFieldDesc.html#c701700af3c4597a4a39a76e3331dd08" title="Number of sample rows in the height field samples array.">nbRows</a> &lt; 2)
+<a name="l00191"></a>00191 <span class="keywordflow">return</span> <span class="keyword">false</span>;
+<a name="l00192"></a>00192 <span class="keywordflow">if</span>(<a class="code" href="classPxHeightFieldDesc.html#8743d198a4db234d353c1f4d2734d43d" title="Format of the sample data.">format</a> != <a class="code" href="structPxHeightFieldFormat.html#d28e3afa439f8ff1df6067288c46d9c5a8ba1edf74a561d830b5f40e2c3e64e7" title="Height field height data is 16 bit signed integers, followed by triangle materials...">PxHeightFieldFormat::eS16_TM</a>)
+<a name="l00193"></a>00193 <span class="keywordflow">return</span> <span class="keyword">false</span>;
+<a name="l00194"></a>00194 <span class="keywordflow">if</span> (<a class="code" href="classPxHeightFieldDesc.html#ffbec0b3ed43d041b12152648d13821b" title="The samples array.">samples</a>.<a class="code" href="structPxStridedData.html#abf495b4b5caec8f5350645a49e68fb3" title="The offset in bytes between consecutive samples in the data.">stride</a> &lt; 4)
+<a name="l00195"></a>00195 <span class="keywordflow">return</span> <span class="keyword">false</span>;
+<a name="l00196"></a>00196 <span class="keywordflow">if</span> (<a class="code" href="classPxHeightFieldDesc.html#2c40081aa73ec042021785dbe52f75fb">convexEdgeThreshold</a> &lt; 0)
+<a name="l00197"></a>00197 <span class="keywordflow">return</span> <span class="keyword">false</span>;
+<a name="l00198"></a>00198 <span class="keywordflow">if</span> ((<a class="code" href="classPxHeightFieldDesc.html#ec8940d776191d6ca950025836481360" title="Flags bits, combined from values of the enum PxHeightFieldFlag.">flags</a> &amp; <a class="code" href="structPxHeightFieldFlag.html#d94e98dce64e8c6f9806a20548548668b602d69a9ee1ab863ab17f503592ff2e" title="Disable collisions with height field with boundary edges.">PxHeightFieldFlag::eNO_BOUNDARY_EDGES</a>) != <a class="code" href="classPxHeightFieldDesc.html#ec8940d776191d6ca950025836481360" title="Flags bits, combined from values of the enum PxHeightFieldFlag.">flags</a>)
+<a name="l00199"></a>00199 <span class="keywordflow">return</span> <span class="keyword">false</span>;
+<a name="l00200"></a>00200 <span class="keywordflow">if</span> (thickness &lt; -PX_MAX_BOUNDS_EXTENTS || thickness &gt; <a class="code" href="group__foundation.html#gc1b800617c25ba00871816b8a0756d89">PX_MAX_BOUNDS_EXTENTS</a>)
+<a name="l00201"></a>00201 <span class="keywordflow">return</span> <span class="keyword">false</span>;
+<a name="l00202"></a>00202 <span class="keywordflow">return</span> <span class="keyword">true</span>;
+<a name="l00203"></a>00203 }
+<a name="l00204"></a>00204
+<a name="l00205"></a>00205 <span class="preprocessor">#if !PX_DOXYGEN</span>
+<a name="l00206"></a>00206 <span class="preprocessor"></span>} <span class="comment">// namespace physx</span>
+<a name="l00207"></a>00207 <span class="preprocessor">#endif</span>
+<a name="l00208"></a>00208 <span class="preprocessor"></span>
+<a name="l00210"></a>00210 <span class="preprocessor">#endif</span>
+</pre></div></div>
+
+<hr style="width: 100%; height: 2px;"><br>
+Copyright &copy; 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>