PhysX SDK 3.2 API Reference: Geomutils

PhysX SDK 3.2 API

Geomutils


Classes

class  PxBoxGeometry
 Class representing the geometry of a box. More...
class  PxCapsuleGeometry
 Class representing the geometry of a capsule. More...
struct  PxHullPolygon
 Polygon data. More...
class  PxConvexMesh
 A convex mesh. More...
class  PxConvexMeshGeometry
 Convex mesh geometry class. More...
struct  PxGeometryType
 A geometry type. More...
class  PxGeometry
 A geometry object. More...
class  PxGeometryHolder
 Geometry holder class. More...
class  PxGeometryQuery
 Collection of geometry object queries (sweeps, raycasts, overlaps, ...). More...
class  PxHeightField
 A height field class. More...
class  PxHeightFieldDesc
 Descriptor class for PxHeightField. More...
struct  PxHeightFieldFormat
 Describes the format of height field samples. More...
struct  PxHeightFieldTessFlag
 Determines the tessellation of height field cells. More...
struct  PxHeightFieldFlag
 Enum with flag values to be used in PxHeightFieldDesc.flags. More...
class  PxHeightFieldGeometry
 Height field geometry class. More...
struct  PxHeightFieldMaterial
 Special material index values for height field samples. More...
struct  PxHeightFieldSample
 Heightfield sample format. More...
class  PxMeshQuery
class  PxMeshScale
 A class expressing a nonuniform scaling transformation. More...
class  PxPlaneGeometry
 Class describing a plane geometry. More...
struct  PxMeshFlag
 Enum with flag values to be used in PxSimpleTriangleMesh::flags. More...
class  PxSimpleTriangleMesh
 A structure describing a triangle mesh. More...
class  PxSphereGeometry
 A class representing the geometry of a sphere. More...
class  PxTriangle
 Triangle class. More...
class  PxTriangleMesh
 A triangle mesh, also called a 'polygon soup'. More...
struct  PxMeshGeometryFlag
 Some flags to control the simulated behavior of the mesh geometry. More...
class  PxTriangleMeshGeometry
 Triangle mesh geometry class. More...

Defines

#define PX_MIN_HEIGHTFIELD_XZ_SCALE   1e-8f
#define PX_MIN_HEIGHTFIELD_Y_SCALE   (0.0001f / PxReal(0xFFFF))

Typedefs

typedef PxFlags
< PxHeightFieldFlag::Enum,
PxU16
PxHeightFieldFlags
 collection of set bits defined in PxHeightFieldFlag.
typedef PxU32 PxTriangleID
 Index of triangle in cooked mesh.
typedef PxU16 PxMaterialTableIndex
 Index type into material table.
typedef PxFlags
< PxMeshFlag::Enum, PxU16
PxMeshFlags
 collection of set bits defined in PxMeshFlag.
typedef PxFlags
< PxMeshGeometryFlag::Enum,
PxU8
PxMeshGeometryFlags
 collection of set bits defined in PxMeshGeometryFlag.

Functions

PX_FOUNDATION_API PxTransform PxTransformFromSegment (const PxVec3 &p0, const PxVec3 &p1, PxReal *halfHeight=NULL)
 PX_FLAGS_OPERATORS (PxHeightFieldFlag::Enum, PxU16)
PX_FOUNDATION_API PxTransform PxTransformFromPlaneEquation (const PxPlane &plane)
PX_INLINE PxPlane PxPlaneEquationFromTransform (const PxTransform &transform)
 PX_FLAGS_OPERATORS (PxMeshFlag::Enum, PxU16)
 PX_FLAGS_OPERATORS (PxMeshGeometryFlag::Enum, PxU8)
PX_INLINE bool PxBoxGeometry::isValid () const
 Returns true if the geometry is valid.
PX_INLINE bool PxCapsuleGeometry::isValid () const
 Returns true if the geometry is valid.
PX_INLINE bool PxConvexMeshGeometry::isValid () const
 Returns true if the geometry is valid.
PX_INLINE PxHeightFieldDesc::PxHeightFieldDesc ()
 Constructor sets to default.
PX_INLINE void PxHeightFieldDesc::setToDefault ()
 (re)sets the structure to the default.
PX_INLINE bool PxHeightFieldDesc::isValid () const
 Returns true if the descriptor is valid.
PX_INLINE bool PxHeightFieldGeometry::isValid () const
 Returns true if the geometry is valid.
PX_INLINE bool PxPlaneGeometry::isValid () const
 Returns true if the geometry is valid.
PX_INLINE PxSimpleTriangleMesh::PxSimpleTriangleMesh ()
 constructor sets to default.
PX_INLINE void PxSimpleTriangleMesh::setToDefault ()
 (re)sets the structure to the default.
PX_INLINE bool PxSimpleTriangleMesh::isValid () const
 returns true if the current settings are valid
PX_INLINE bool PxSphereGeometry::isValid () const
 Returns true if the geometry is valid.
PX_INLINE bool PxTriangleMeshGeometry::isValid () const
 Returns true if the geometry is valid.

Variables

class PxGeometryHolder PX_ALIGN_SUFFIX
 Geometry holder class.

Define Documentation

#define PX_MIN_HEIGHTFIELD_XZ_SCALE   1e-8f

#define PX_MIN_HEIGHTFIELD_Y_SCALE   (0.0001f / PxReal(0xFFFF))


Typedef Documentation

collection of set bits defined in PxHeightFieldFlag.

See also:
PxHeightFieldFlag

Index type into material table.

collection of set bits defined in PxMeshFlag.

See also:
PxMeshFlag

collection of set bits defined in PxMeshGeometryFlag.

See also:
PxMeshGeometryFlag

Index of triangle in cooked mesh.


Function Documentation

PX_INLINE bool PxTriangleMeshGeometry::isValid (  )  const [inherited]

PX_INLINE bool PxSphereGeometry::isValid (  )  const [inherited]

Returns true if the geometry is valid.

Returns:
True if the current settings are valid

References PxGeometryType::eSPHERE, PxGeometry::mType, PxIsFinite(), and PxSphereGeometry::radius.

PX_INLINE bool PxSimpleTriangleMesh::isValid (  )  const [inherited]

PX_INLINE bool PxPlaneGeometry::isValid (  )  const [inherited]

Returns true if the geometry is valid.

Returns:
True if the current settings are valid

References PxGeometryType::ePLANE, and PxGeometry::mType.

PX_INLINE bool PxHeightFieldGeometry::isValid (  )  const [inherited]

PX_INLINE bool PxHeightFieldDesc::isValid (  )  const [inherited]

PX_INLINE bool PxConvexMeshGeometry::isValid (  )  const [inherited]

Returns true if the geometry is valid.

Returns:
True if the current settings are valid for shape creation.

References PxConvexMeshGeometry::convexMesh, PxGeometryType::eCONVEXMESH, PxVec3::isFinite(), PxQuat::isUnit(), PxGeometry::mType, PxMeshScale::rotation, PxMeshScale::scale, PxConvexMeshGeometry::scale, PxVec3::x, PxVec3::y, and PxVec3::z.

PX_INLINE bool PxCapsuleGeometry::isValid (  )  const [inherited]

Returns true if the geometry is valid.

Returns:
True if the current settings are valid.

References PxGeometryType::eCAPSULE, PxCapsuleGeometry::halfHeight, PxGeometry::mType, PxIsFinite(), and PxCapsuleGeometry::radius.

PX_INLINE bool PxBoxGeometry::isValid (  )  const [inherited]

Returns true if the geometry is valid.

Returns:
True if the current settings are valid

References PxGeometryType::eBOX, PxBoxGeometry::halfExtents, PxVec3::isFinite(), PxGeometry::mType, PxVec3::x, PxVec3::y, and PxVec3::z.

PX_FLAGS_OPERATORS ( PxMeshGeometryFlag::Enum  ,
PxU8   
)

PX_FLAGS_OPERATORS ( PxMeshFlag::Enum  ,
PxU16   
)

PX_FLAGS_OPERATORS ( PxHeightFieldFlag::Enum  ,
PxU16   
)

PX_INLINE PxPlane PxPlaneEquationFromTransform ( const PxTransform transform  ) 

PX_INLINE PxSimpleTriangleMesh::PxSimpleTriangleMesh (  )  [inherited]

constructor sets to default.

Referenced by PxSimpleTriangleMesh::setToDefault().

PX_FOUNDATION_API PxTransform PxTransformFromPlaneEquation ( const PxPlane plane  ) 

PX_FOUNDATION_API PxTransform PxTransformFromSegment ( const PxVec3 p0,
const PxVec3 p1,
PxReal halfHeight = NULL 
)

PX_INLINE void PxSimpleTriangleMesh::setToDefault (  )  [inherited]

(re)sets the structure to the default.

Reimplemented in PxClothMeshDesc, and PxTriangleMeshDesc.

References PxSimpleTriangleMesh::PxSimpleTriangleMesh().

PX_INLINE void PxHeightFieldDesc::setToDefault (  )  [inherited]

(re)sets the structure to the default.

References PxHeightFieldDesc::PxHeightFieldDesc().


Variable Documentation

Geometry holder class.

This class contains enough space to hold a value of any PxGeometry subtype.

Its principal use is as a convenience class to allow geometries to be returned polymorphically from functions. See PxShape::getGeometry();



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