#include <PxHeightField.h>
Public Member Functions | |
virtual PX_PHYSX_COMMON_API void | release ()=0 |
Decrements the reference count of a height field and releases it if the new reference count is zero. | |
virtual PX_PHYSX_COMMON_API PxU32 | saveCells (void *destBuffer, PxU32 destBufferSize) const =0 |
Writes out the sample data array. | |
virtual PX_PHYSX_COMMON_API bool | modifySamples (PxI32 startCol, PxI32 startRow, const PxHeightFieldDesc &subfieldDesc, bool shrinkBounds=false)=0 |
Replaces a rectangular subfield in the sample data array. | |
virtual PX_PHYSX_COMMON_API PxU32 | getNbRows () const =0 |
Retrieves the number of sample rows in the samples array. | |
virtual PX_PHYSX_COMMON_API PxU32 | getNbColumns () const =0 |
Retrieves the number of sample columns in the samples array. | |
virtual PX_PHYSX_COMMON_API PxHeightFieldFormat::Enum | getFormat () const =0 |
Retrieves the format of the sample data. | |
virtual PX_PHYSX_COMMON_API PxU32 | getSampleStride () const =0 |
Retrieves the offset in bytes between consecutive samples in the array. | |
virtual PX_PHYSX_COMMON_API PxReal | getThickness () const =0 |
Retrieves the thickness of the height volume in the vertical direction. | |
virtual PX_PHYSX_COMMON_API PxReal | getConvexEdgeThreshold () const =0 |
Retrieves the convex edge threshold. | |
virtual PX_PHYSX_COMMON_API PxHeightFieldFlags | getFlags () const =0 |
Retrieves the flags bits, combined from values of the enum PxHeightFieldFlag. | |
virtual PX_PHYSX_COMMON_API PxReal | getHeight (PxReal x, PxReal z) const =0 |
Retrieves the height at the given coordinates in grid space. | |
virtual PX_PHYSX_COMMON_API PxU32 | getReferenceCount () const =0 |
Returns the reference count for shared heightfields. | |
virtual PX_PHYSX_COMMON_API void | acquireReference ()=0 |
Acquires a counted reference to a heightfield. | |
virtual PX_PHYSX_COMMON_API PxMaterialTableIndex | getTriangleMaterialIndex (PxTriangleID triangleIndex) const =0 |
Returns material table index of given triangle. | |
virtual PX_PHYSX_COMMON_API PxVec3 | getTriangleNormal (PxTriangleID triangleIndex) const =0 |
Returns a triangle face normal for a given triangle index. | |
virtual PX_PHYSX_COMMON_API PxU32 | getTimestamp () const =0 |
Returns the number of times the heightfield data has been modified. | |
virtual PX_PHYSX_COMMON_API const char * | getConcreteTypeName () const |
Returns string name of dynamic type. | |
Protected Member Functions | |
PX_INLINE | PxHeightField (PxType concreteType, PxBaseFlags baseFlags) |
PX_INLINE | PxHeightField (PxBaseFlags baseFlags) |
virtual PX_PHYSX_COMMON_API | ~PxHeightField () |
virtual PX_PHYSX_COMMON_API bool | isKindOf (const char *name) const |
Returns whether a given type name matches with the type of this instance. |
Height fields work in a similar way as triangle meshes specified to act as height fields, with some important differences:
Triangle meshes can be made of nonuniform geometry, while height fields are regular, rectangular grids. This means that with PxHeightField, you sacrifice flexibility in return for improved performance and decreased memory consumption.
In local space rows extend in X direction, columns in Z direction and height in Y direction.
Like Convexes and TriangleMeshes, HeightFields are referenced by shape instances (see PxHeightFieldGeometry, PxShape).
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 PxHeightFieldGeometry and PxShape classes.
To create an instance of this class call PxPhysics::createHeightField() or PxCooking::createHeightField(const PxHeightFieldDesc&, PxPhysicsInsertionCallback&). To delete it call release(). This is only possible once you have released all of its PxHeightFiedShape instances.
PX_INLINE PxHeightField::PxHeightField | ( | PxType | concreteType, | |
PxBaseFlags | baseFlags | |||
) | [inline, protected] |
PX_INLINE PxHeightField::PxHeightField | ( | PxBaseFlags | baseFlags | ) | [inline, protected] |
virtual PX_PHYSX_COMMON_API PxHeightField::~PxHeightField | ( | ) | [inline, protected, virtual] |
virtual PX_PHYSX_COMMON_API void PxHeightField::acquireReference | ( | ) | [pure virtual] |
Acquires a counted reference to a heightfield.
This method increases the reference count of the heightfield by 1. Decrement the reference count by calling release()
virtual PX_PHYSX_COMMON_API const char* PxHeightField::getConcreteTypeName | ( | ) | const [inline, virtual] |
Returns string name of dynamic type.
Implements PxBase.
virtual PX_PHYSX_COMMON_API PxReal PxHeightField::getConvexEdgeThreshold | ( | ) | const [pure virtual] |
Retrieves the convex edge threshold.
virtual PX_PHYSX_COMMON_API PxHeightFieldFlags PxHeightField::getFlags | ( | ) | const [pure virtual] |
Retrieves the flags bits, combined from values of the enum PxHeightFieldFlag.
virtual PX_PHYSX_COMMON_API PxHeightFieldFormat::Enum PxHeightField::getFormat | ( | ) | const [pure virtual] |
Retrieves the format of the sample data.
virtual PX_PHYSX_COMMON_API PxReal PxHeightField::getHeight | ( | PxReal | x, | |
PxReal | z | |||
) | const [pure virtual] |
Retrieves the height at the given coordinates in grid space.
virtual PX_PHYSX_COMMON_API PxU32 PxHeightField::getNbColumns | ( | ) | const [pure virtual] |
Retrieves the number of sample columns in the samples array.
virtual PX_PHYSX_COMMON_API PxU32 PxHeightField::getNbRows | ( | ) | const [pure virtual] |
Retrieves the number of sample rows in the samples array.
virtual PX_PHYSX_COMMON_API PxU32 PxHeightField::getReferenceCount | ( | ) | const [pure virtual] |
Returns the reference count for shared heightfields.
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.
virtual PX_PHYSX_COMMON_API PxU32 PxHeightField::getSampleStride | ( | ) | const [pure virtual] |
Retrieves the offset in bytes between consecutive samples in the array.
virtual PX_PHYSX_COMMON_API PxReal PxHeightField::getThickness | ( | ) | const [pure virtual] |
Retrieves the thickness of the height volume in the vertical direction.
virtual PX_PHYSX_COMMON_API PxU32 PxHeightField::getTimestamp | ( | ) | const [pure virtual] |
Returns the number of times the heightfield data has been modified.
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.
virtual PX_PHYSX_COMMON_API PxMaterialTableIndex PxHeightField::getTriangleMaterialIndex | ( | PxTriangleID | triangleIndex | ) | const [pure virtual] |
Returns material table index of given triangle.
[in] | triangleIndex | (internal) index of desired triangle |
virtual PX_PHYSX_COMMON_API PxVec3 PxHeightField::getTriangleNormal | ( | PxTriangleID | triangleIndex | ) | const [pure virtual] |
Returns a triangle face normal for a given triangle index.
[in] | triangleIndex | (internal) index of desired triangle |
virtual PX_PHYSX_COMMON_API bool PxHeightField::isKindOf | ( | const char * | superClass | ) | const [inline, protected, virtual] |
Returns whether a given type name matches with the type of this instance.
Reimplemented from PxBase.
References PxBase::isKindOf().
virtual PX_PHYSX_COMMON_API bool PxHeightField::modifySamples | ( | PxI32 | startCol, | |
PxI32 | startRow, | |||
const PxHeightFieldDesc & | subfieldDesc, | |||
bool | shrinkBounds = false | |||
) | [pure virtual] |
Replaces a rectangular subfield in the sample data array.
The user provides the description of a rectangular subfield in subfieldDesc. The data is formatted and arranged as PxHeightFieldDesc.samples.
[in] | startCol | First cell in the destination heightfield to be modified. Can be negative. |
[in] | startRow | First row in the destination heightfield to be modified. Can be negative. |
[in] | subfieldDesc | Description of the source subfield to read the samples from. |
[in] | shrinkBounds | 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. |
virtual PX_PHYSX_COMMON_API void PxHeightField::release | ( | ) | [pure virtual] |
Decrements the reference count of a height field and releases it if the new reference count is zero.
Implements PxBase.
virtual PX_PHYSX_COMMON_API PxU32 PxHeightField::saveCells | ( | void * | destBuffer, | |
PxU32 | destBufferSize | |||
) | const [pure virtual] |
Writes out the sample data array.
The user provides destBufferSize bytes storage at destBuffer. The data is formatted and arranged as PxHeightFieldDesc.samples.
[out] | destBuffer | The destination buffer for the sample data. |
[in] | destBufferSize | The size of the destination buffer. |