PhysX SDK 3.2 API Reference: Cooking

PhysX SDK 3.2 API

Cooking


Classes

struct  PxConverterReportMode
class  PxBinaryConverter
 Binary converter for serialized streams. More...
struct  PxClothMeshEdgeFlag
 Flags which describe how cooking should treat a cloth mesh edge. More...
struct  PxClothMeshVertFlag
 Flags which describe how cooking should treat a cloth mesh vertex. More...
class  PxClothMeshDesc
 Descriptor class for a cloth mesh. More...
struct  PxConvexFlag
 Flags which describe the format and behavior of a convex mesh. More...
class  PxConvexMeshDesc
 Descriptor class for PxConvexMesh. More...
struct  PxPlatform
struct  PxCookingParams
 Structure describing parameters affecting mesh cooking. More...
class  PxCooking
class  PxTriangleMeshDesc
 Descriptor class for PxTriangleMesh. More...

Typedefs

typedef PxFlags
< PxClothMeshEdgeFlag::Enum,
PxU32
PxClothMeshEdgeFlags
typedef PxFlags
< PxClothMeshVertFlag::Enum,
PxU32
PxClothMeshVertFlags
typedef PxFlags
< PxConvexFlag::Enum, PxU16
PxConvexFlags
 collection of set bits defined in PxConvexFlag.
typedef PxVec3 PxPoint

Functions

 PX_FLAGS_OPERATORS (PxClothMeshEdgeFlag::Enum, PxU32)
 PX_FLAGS_OPERATORS (PxClothMeshVertFlag::Enum, PxU32)
 PX_FLAGS_OPERATORS (PxConvexFlag::Enum, PxU16)
PX_C_EXPORT
PX_PHYSX_COOKING_API
physx::PxCooking *PX_CALL_CONV 
PxCreateCooking (physx::PxU32 version, physx::PxFoundation &foundation, const physx::PxCookingParams &params)
 Create an instance of the cooking interface.
PX_INLINE PxClothMeshDesc::PxClothMeshDesc ()
 constructor sets to default.
PX_INLINE void PxClothMeshDesc::setToDefault ()
 (re)sets the structure to the default.
PX_INLINE bool PxClothMeshDesc::isValid () const
 Returns true if the descriptor is valid.
PX_INLINE PxConvexMeshDesc::PxConvexMeshDesc ()
 constructor sets to default.
PX_INLINE void PxConvexMeshDesc::setToDefault ()
 (re)sets the structure to the default.
PX_INLINE bool PxConvexMeshDesc::isValid () const
 Returns true if the descriptor is valid.
PX_INLINE PxTriangleMeshDesc::PxTriangleMeshDesc ()
 Constructor sets to default.
PX_INLINE void PxTriangleMeshDesc::setToDefault ()
 (re)sets the structure to the default.
PX_INLINE bool PxTriangleMeshDesc::isValid () const
 Returns true if the descriptor is valid.

Typedef Documentation

collection of set bits defined in PxConvexFlag.

See also:
PxConvexFlag

typedef PxVec3 PxPoint


Function Documentation

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

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

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

Returns true if the descriptor is valid.

Returns:
True if the current settings are valid

Reimplemented from PxSimpleTriangleMesh.

References PxBoundedData::count, PxStridedData::data, PxSimpleTriangleMesh::points, and PxSimpleTriangleMesh::triangles.

PX_FLAGS_OPERATORS ( PxConvexFlag::Enum  ,
PxU16   
)

PX_FLAGS_OPERATORS ( PxClothMeshVertFlag::Enum  ,
PxU32   
)

PX_FLAGS_OPERATORS ( PxClothMeshEdgeFlag::Enum  ,
PxU32   
)

PX_INLINE PxClothMeshDesc::PxClothMeshDesc (  )  [inherited]

PX_INLINE PxConvexMeshDesc::PxConvexMeshDesc (  )  [inherited]

constructor sets to default.

Referenced by PxConvexMeshDesc::setToDefault().

PX_C_EXPORT PX_PHYSX_COOKING_API physx::PxCooking* PX_CALL_CONV PxCreateCooking ( physx::PxU32  version,
physx::PxFoundation &  foundation,
const physx::PxCookingParams &  params 
)

Create an instance of the cooking interface.

Note that the foundation object is handled as an application-wide singleton in statically linked executables and a DLL-wide singleton in dynamically linked executables. Therefore, if you are using the runtime SDK in the same executable as cooking, you should pass the Physics's copy of foundation (acquired with PxPhysics::getFoundation()) to the cooker. This will also ensure correct handling of memory for objects passed from the cooker to the SDK.

To use cooking in standalone mode, create an instance of the Foundation object with PxCreateCookingFoundation. You should pass the same foundation object to all instances of the cooking interface.

Parameters:
[in] version the SDK version number
[in] foundation the foundation object associated with this instance of the cooking interface.
[in] params the parameters for this instance of the cooking interface
Returns:
true on success.

PX_INLINE PxTriangleMeshDesc::PxTriangleMeshDesc (  )  [inherited]

PX_INLINE void PxTriangleMeshDesc::setToDefault (  )  [inherited]

(re)sets the structure to the default.

Reimplemented from PxSimpleTriangleMesh.

References PxTriangleMeshDesc::PxTriangleMeshDesc().

Referenced by PxTriangleMeshDesc::PxTriangleMeshDesc().

PX_INLINE void PxConvexMeshDesc::setToDefault (  )  [inherited]

(re)sets the structure to the default.

References PxConvexMeshDesc::PxConvexMeshDesc().

PX_INLINE void PxClothMeshDesc::setToDefault (  )  [inherited]

(re)sets the structure to the default.

Reimplemented from PxSimpleTriangleMesh.

References PxClothMeshDesc::PxClothMeshDesc().

Referenced by PxClothMeshDesc::PxClothMeshDesc().



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