nv::cloth::ClothFabricCooker Class Reference
[Extensions]

Use NvClothCreateFabricCooker() to create an implemented instance. More...

#include <ClothFabricCooker.h>

List of all members.

Public Member Functions

virtual bool cook (const ClothMeshDesc &desc, physx::PxVec3 gravity, bool useGeodesicTether=true)=0
 Cooks a triangle mesh to a ClothFabricDesc.
virtual CookedData getCookedData () const =0
 Returns fabric cooked data for creating fabrics.
virtual ClothFabricDesc getDescriptor () const =0
 Returns the fabric descriptor to create the fabric.
virtual void save (physx::PxOutputStream &stream, bool platformMismatch) const =0
 Saves the fabric data to a platform and version dependent stream.
virtual ~ClothFabricCooker ()


Detailed Description

Use NvClothCreateFabricCooker() to create an implemented instance.

Constructor & Destructor Documentation

virtual nv::cloth::ClothFabricCooker::~ClothFabricCooker (  )  [inline, virtual]


Member Function Documentation

virtual bool nv::cloth::ClothFabricCooker::cook ( const ClothMeshDesc desc,
physx::PxVec3  gravity,
bool  useGeodesicTether = true 
) [pure virtual]

Cooks a triangle mesh to a ClothFabricDesc.

Parameters:
desc The cloth mesh descriptor on which the generation of the cooked mesh depends.
gravity A normalized vector which specifies the direction of gravity. This information allows the cooker to generate a fabric with higher quality simulation behavior. The gravity vector should point in the direction gravity will be pulling towards in the most common situation/at rest. e.g. For flags it might be beneficial to set the gravity horizontal if they are cooked in landscape orientation, as a flag will hang in portrait orientation at rest.
useGeodesicTether A flag to indicate whether to compute geodesic distance for tether constraints.
Note:
The geodesic option for tether only works for manifold input. For non-manifold input, a simple Euclidean distance will be used. For more detailed cooker status for such cases, try running ClothGeodesicTetherCooker directly.

virtual CookedData nv::cloth::ClothFabricCooker::getCookedData (  )  const [pure virtual]

Returns fabric cooked data for creating fabrics.

virtual ClothFabricDesc nv::cloth::ClothFabricCooker::getDescriptor (  )  const [pure virtual]

Returns the fabric descriptor to create the fabric.

virtual void nv::cloth::ClothFabricCooker::save ( physx::PxOutputStream &  stream,
bool  platformMismatch 
) const [pure virtual]

Saves the fabric data to a platform and version dependent stream.


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