aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Include/geometry/PxHeightFieldSample.h
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/Include/geometry/PxHeightFieldSample.h
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/Include/geometry/PxHeightFieldSample.h')
-rw-r--r--PhysX_3.4/Include/geometry/PxHeightFieldSample.h124
1 files changed, 124 insertions, 0 deletions
diff --git a/PhysX_3.4/Include/geometry/PxHeightFieldSample.h b/PhysX_3.4/Include/geometry/PxHeightFieldSample.h
new file mode 100644
index 00000000..d8c9bbaa
--- /dev/null
+++ b/PhysX_3.4/Include/geometry/PxHeightFieldSample.h
@@ -0,0 +1,124 @@
+// This code contains NVIDIA Confidential Information and is disclosed to you
+// under a form of NVIDIA software license agreement provided separately to you.
+//
+// Notice
+// NVIDIA Corporation and its licensors retain all intellectual property and
+// proprietary rights in and to this software and related documentation and
+// any modifications thereto. Any use, reproduction, disclosure, or
+// distribution of this software and related documentation without an express
+// license agreement from NVIDIA Corporation is strictly prohibited.
+//
+// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
+// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
+// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
+// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
+//
+// Information and code furnished is believed to be accurate and reliable.
+// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
+// information or for any infringement of patents or other rights of third parties that may
+// result from its use. No license is granted by implication or otherwise under any patent
+// or patent rights of NVIDIA Corporation. Details are subject to change without notice.
+// This code supersedes and replaces all information previously supplied.
+// NVIDIA Corporation products are not authorized for use as critical
+// components in life support devices or systems without express written approval of
+// NVIDIA Corporation.
+//
+// Copyright (c) 2008-2016 NVIDIA Corporation. All rights reserved.
+// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
+// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.
+
+
+#ifndef PX_PHYSICS_NXHEIGHTFIELDSAMPLE
+#define PX_PHYSICS_NXHEIGHTFIELDSAMPLE
+/** \addtogroup geomutils
+@{ */
+
+#include "common/PxPhysXCommonConfig.h"
+#include "foundation/PxBitAndData.h"
+
+#if !PX_DOXYGEN
+namespace physx
+{
+#endif
+
+/**
+\brief Special material index values for height field samples.
+
+@see PxHeightFieldSample.materialIndex0 PxHeightFieldSample.materialIndex1
+*/
+struct PxHeightFieldMaterial
+{
+ enum Enum
+ {
+ eHOLE = 127 //!< A material indicating that the triangle should be treated as a hole in the mesh.
+ };
+};
+
+/**
+\brief Heightfield sample format.
+
+This format corresponds to the #PxHeightFieldFormat member PxHeightFieldFormat::eS16_TM.
+
+An array of heightfield samples are used when creating a PxHeightField to specify
+the elevation of the heightfield points. In addition the material and tessellation of the adjacent
+triangles are specified.
+
+@see PxHeightField PxHeightFieldDesc PxHeightFieldDesc.samples
+*/
+struct PxHeightFieldSample
+{
+//= ATTENTION! =====================================================================================
+// Changing the data layout of this class breaks the binary serialization format. See comments for
+// PX_BINARY_SERIAL_VERSION. If a modification is required, please adjust the getBinaryMetaData
+// function. If the modification is made on a custom branch, please change PX_BINARY_SERIAL_VERSION
+// accordingly.
+//==================================================================================================
+
+ /**
+ \brief The height of the heightfield sample
+
+ This value is scaled by PxHeightFieldGeometry::heightScale.
+
+ @see PxHeightFieldGeometry
+ */
+ PxI16 height;
+
+ /**
+ \brief The triangle material index of the quad's lower triangle + tesselation flag
+
+ An index pointing into the material table of the shape which instantiates the heightfield.
+ This index determines the material of the lower of the quad's two triangles (i.e. the quad whose
+ upper-left corner is this sample, see the Guide for illustrations).
+
+ Special values of the 7 data bits are defined by PxHeightFieldMaterial
+
+ The tesselation flag specifies which way the quad is split whose upper left corner is this sample.
+ If the flag is set, the diagonal of the quad will run from this sample to the opposite vertex; if not,
+ it will run between the other two vertices (see the Guide for illustrations).
+
+ @see PxHeightFieldGeometry materialIndex1 PxShape.setmaterials() PxShape.getMaterials()
+ */
+ PxBitAndByte materialIndex0;
+
+ PX_CUDA_CALLABLE PX_FORCE_INLINE PxU8 tessFlag() const { return PxU8(materialIndex0.isBitSet() ? 1 : 0); } // PT: explicit conversion to make sure we don't break the code
+ PX_CUDA_CALLABLE PX_FORCE_INLINE void setTessFlag() { materialIndex0.setBit(); }
+ PX_CUDA_CALLABLE PX_FORCE_INLINE void clearTessFlag() { materialIndex0.clearBit(); }
+
+ /**
+ \brief The triangle material index of the quad's upper triangle + reserved flag
+
+ An index pointing into the material table of the shape which instantiates the heightfield.
+ This index determines the material of the upper of the quad's two triangles (i.e. the quad whose
+ upper-left corner is this sample, see the Guide for illustrations).
+
+ @see PxHeightFieldGeometry materialIndex0 PxShape.setmaterials() PxShape.getMaterials()
+ */
+ PxBitAndByte materialIndex1;
+};
+
+#if !PX_DOXYGEN
+} // namespace physx
+#endif
+
+/** @} */
+#endif