Init

physx/include/geometry/PxHeightFieldSample.h

@@ -0,0 +1,124 @@
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions
+// are met:
+//  * Redistributions of source code must retain the above copyright
+//    notice, this list of conditions and the following disclaimer.
+//  * Redistributions in binary form must reproduce the above copyright
+//    notice, this list of conditions and the following disclaimer in the
+//    documentation and/or other materials provided with the distribution.
+//  * Neither the name of NVIDIA CORPORATION nor the names of its
+//    contributors may be used to endorse or promote products derived
+//    from this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
+// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+// PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+//
+// Copyright (c) 2008-2021 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