PhysX SDK 3.2 API Reference: PxHeightFieldGeometry Class Reference

PhysX SDK 3.2 API

PxHeightFieldGeometry Class Reference
[Geomutils]

Height field geometry class. More...

#include <PxHeightFieldGeometry.h>

Inheritance diagram for PxHeightFieldGeometry:
Collaboration diagram for PxHeightFieldGeometry:

List of all members.


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.

Public Attributes

PxHeightFieldheightField
 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

Detailed Description

Height field geometry class.

This class unifies a height field object with a scaling, and lets the combined object be used anywhere a PxGeometry is needed.

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

PX_INLINE PxHeightFieldGeometry::PxHeightFieldGeometry (  )  [inline]

PX_INLINE PxHeightFieldGeometry::PxHeightFieldGeometry ( PxHeightField hf,
PxMeshGeometryFlags  flags,
PxReal  heightscale,
PxReal  rowscale,
PxReal  columnscale 
) [inline]


Member Data Documentation

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

Referenced by isValid().

The height field data.

Referenced by isValid().

Flags to specify some collision properties for the height field.

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

Referenced by isValid().

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

Referenced by isValid().


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



Copyright © 2008-2012 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com