physx::PxHeightFieldGeometry Class Reference

Height field geometry class. More...

#include <PxHeightFieldGeometry.h>

Inheritance diagram for physx::PxHeightFieldGeometry:

Collaboration diagram for physx::PxHeightFieldGeometry:

Public Member Functions
PX_INLINE	PxHeightFieldGeometry (PxHeightField *hf=NULL, PxMeshGeometryFlags flags=PxMeshGeometryFlag::Enum(0), PxReal heightScale_=1.0f, PxReal rowScale_=1.0f, PxReal columnScale_=1.0f)
	Constructor.
PX_INLINE	PxHeightFieldGeometry (const PxHeightFieldGeometry &that)
	Copy constructor.
PX_INLINE void	operator= (const PxHeightFieldGeometry &that)
	Assignment operator.
PX_INLINE bool	isValid () const
	Returns true if the geometry is valid.
Public Member Functions inherited from physx::PxGeometry
PX_CUDA_CALLABLE PX_FORCE_INLINE PxGeometryType::Enum	getType () const
	Returns the type of the geometry.
PX_INLINE void	operator= (const PxGeometry &that)
	Assignment operator.

Public Attributes
PxHeightField *	heightField
	The height field data.
PxReal	heightScale
	The scaling factor for the height field in vertical direction (y direction in local space).
PxReal	rowScale
	The scaling factor for the height field in the row direction (x direction in local space).
PxReal	columnScale
	The scaling factor for the height field in the column direction (z direction in local space).
PxMeshGeometryFlags	heightFieldFlags
	Flags to specify some collision properties for the height field.
PxPadding< 3 >	paddingFromFlags
	padding for mesh flags.
Public Attributes inherited from physx::PxGeometry
float	mTypePadding

Additional Inherited Members
Protected Member Functions inherited from physx::PxGeometry
PX_CUDA_CALLABLE PX_FORCE_INLINE	PxGeometry (PxGeometryType::Enum type)
PX_CUDA_CALLABLE PX_FORCE_INLINE	PxGeometry (const PxGeometry &that)
Protected Attributes inherited from physx::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()

PX_INLINE physx::PxHeightFieldGeometry::PxHeightFieldGeometry ( const PxHeightFieldGeometry &  that )

inline

Copy constructor.

Parameters

[in]

that

Other object

Member Function Documentation

isValid()

PX_INLINE bool physx::PxHeightFieldGeometry::isValid

(

)

const

Returns true if the geometry is valid.

Returns

True if the current settings are valid

Note

A valid height field has a positive scale value in each direction (heightScale > 0, rowScale > 0, columnScale > 0). It is illegal to call PxRigidActor::createShape and PxPhysics::createShape with a height field that has zero extents in any direction.

See also

PxRigidActor::createShape, PxPhysics::createShape

---

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

• RavEngine/deps/physx/physx/include/geometry/PxHeightFieldGeometry.h