PxHeightFieldGeometry Class Reference

Height field geometry class. More...

#include <PxHeightFieldGeometry.h>

Inheritance diagram for PxHeightFieldGeometry:
Collaboration diagram for PxHeightFieldGeometry:

Public Member Functions

PX_INLINE PxHeightFieldGeometry ()
 
PX_INLINE PxHeightFieldGeometry (PxHeightField *hf, PxMeshGeometryFlags flags, PxReal heightScale_, PxReal rowScale_, PxReal columnScale_)
 
PX_INLINE bool isValid () const
 Returns true if the geometry is valid. More...
 
- Public Member Functions inherited from PxGeometry
PX_CUDA_CALLABLE PX_FORCE_INLINE PxGeometryType::Enum getType () const
 Returns the type of the geometry. More...
 

Public Attributes

PxHeightFieldheightField
 The height field data. More...
 
PxReal heightScale
 The scaling factor for the height field in vertical direction (y direction in local space). More...
 
PxReal rowScale
 The scaling factor for the height field in the row direction (x direction in local space). More...
 
PxReal columnScale
 The scaling factor for the height field in the column direction (z direction in local space). More...
 
PxMeshGeometryFlags heightFieldFlags
 Flags to specify some collision properties for the height field. More...
 
PxPadding< 3 > paddingFromFlags
 padding for mesh flags. More...
 

Additional Inherited Members

- Protected Member Functions inherited from PxGeometry
PX_CUDA_CALLABLE PX_FORCE_INLINE PxGeometry (PxGeometryType::Enum type)
 
- Protected Attributes inherited from PxGeometry
PxGeometryType::Enum mType
 

Detailed Description

Height field geometry class.

This class allows to create a scaled height field geometry instance.

There is a minimum allowed value for Y and XZ scaling - PX_MIN_HEIGHTFIELD_XZ_SCALE, heightfield creation will fail if XZ value is below this value.

Constructor & Destructor Documentation

◆ PxHeightFieldGeometry() [1/2]

PX_INLINE PxHeightFieldGeometry::PxHeightFieldGeometry ( )
inline

◆ PxHeightFieldGeometry() [2/2]

PX_INLINE PxHeightFieldGeometry::PxHeightFieldGeometry ( PxHeightField hf,
PxMeshGeometryFlags  flags,
PxReal  heightScale_,
PxReal  rowScale_,
PxReal  columnScale_ 
)
inline

Member Data Documentation

◆ columnScale

PxReal PxHeightFieldGeometry::columnScale

The scaling factor for the height field in the column direction (z direction in local space).

◆ heightField

PxHeightField* PxHeightFieldGeometry::heightField

The height field data.

◆ heightFieldFlags

PxMeshGeometryFlags PxHeightFieldGeometry::heightFieldFlags

Flags to specify some collision properties for the height field.

◆ heightScale

PxReal PxHeightFieldGeometry::heightScale

The scaling factor for the height field in vertical direction (y direction in local space).

◆ paddingFromFlags

PxPadding<3> PxHeightFieldGeometry::paddingFromFlags

padding for mesh flags.

◆ rowScale

PxReal PxHeightFieldGeometry::rowScale

The scaling factor for the height field in the row direction (x direction in local space).


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