PxHeightFieldSample Struct Reference
[Geomutils]

Heightfield sample format. More...

#include <PxHeightFieldSample.h>

Collaboration diagram for PxHeightFieldSample:

[legend]

List of all members.

Public Member Functions
PX_CUDA_CALLABLE PX_FORCE_INLINE PxU8	tessFlag () const
PX_CUDA_CALLABLE PX_FORCE_INLINE void	setTessFlag ()
PX_CUDA_CALLABLE PX_FORCE_INLINE void	clearTessFlag ()
Public Attributes
PxI16	height
	The height of the heightfield sample.
PxBitAndByte	materialIndex0
	The triangle material index of the quad's lower triangle + tesselation flag.
PxBitAndByte	materialIndex1
	The triangle material index of the quad's upper triangle + reserved flag.

---

Detailed Description

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 also:

PxHeightField PxHeightFieldDesc PxHeightFieldDesc.samples

---

Member Function Documentation

PX_CUDA_CALLABLE PX_FORCE_INLINE void PxHeightFieldSample::clearTessFlag

(

)

[inline]

PX_CUDA_CALLABLE PX_FORCE_INLINE void PxHeightFieldSample::setTessFlag

(

)

[inline]

PX_CUDA_CALLABLE PX_FORCE_INLINE PxU8 PxHeightFieldSample::tessFlag

(

)

const [inline]

---

Member Data Documentation

PxI16 PxHeightFieldSample::height

The height of the heightfield sample.

This value is scaled by PxHeightFieldGeometry::heightScale.

See also:

PxHeightFieldGeometry

PxBitAndByte PxHeightFieldSample::materialIndex0

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 also:

PxHeightFieldGeometry materialIndex1 PxShape.setmaterials() PxShape.getMaterials()

PxBitAndByte PxHeightFieldSample::materialIndex1

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 also:

PxHeightFieldGeometry materialIndex0 PxShape.setmaterials() PxShape.getMaterials()

---

The documentation for this struct was generated from the following file:

• PxHeightFieldSample.h