usdrt::PhysxSchemaPhysxParticleClothAPI

Defined in usdrt/scenegraph/usd/physxSchema/physxParticleClothAPI.h

Functions

Variables

class PhysxSchemaPhysxParticleClothAPI : public usdrt::UsdAPISchemaBase

WARNING: This is a draft API; the design is not fixed and may change in the future. Applied to a UsdGeomMesh. The mesh is simulated as a particle-based cloth or inflatable, depending on the mesh geometry and the pressure attribute. See PhysxAutoParticleClothAPI for an auto-compute helper for cloth springs and dampings.

Public Functions

inline explicit PhysxSchemaPhysxParticleClothAPI(const UsdPrim &prim = UsdPrim())

Construct a PhysxSchemaPhysxParticleClothAPI on UsdPrim prim. Equivalent to PhysxSchemaPhysxParticleClothAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim.

inline explicit PhysxSchemaPhysxParticleClothAPI(const UsdSchemaBase &schemaObj)

Construct a PhysxSchemaPhysxParticleClothAPI on the prim held by schemaObj . Should be preferred over PhysxSchemaPhysxParticleClothAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

inline virtual ~PhysxSchemaPhysxParticleClothAPI()

Destructor.

inline operator bool() const

Boolean operator.

Returns

Return true if the contained prim is has this api schema applied using HasAPI, and false otherwise.

inline UsdAttribute GetSelfCollisionFilterAttr() const

Whether the simulation should filter particle-particle collisions based on their rest position distances.

Declaration

bool physxParticle:selfCollisionFilter = 1

C++ Type

bool

Usd Type

SdfValueTypeNames->Bool

inline UsdAttribute CreateSelfCollisionFilterAttr() const

See GetSelfCollisionFilterAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetRestPointsAttr() const

Particle positions in cloth rest configuration.

Declaration

point3f[] physxParticle:restPoints

C++ Type

VtArray<GfVec3f>

Usd Type

SdfValueTypeNames->Point3fArray

inline UsdAttribute CreateRestPointsAttr() const

See GetRestPointsAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetSpringIndicesAttr() const

List of index pairs describing which points are connected by spring constraints.

Declaration

uniform int2[] physxParticle:springIndices

C++ Type

VtArray<GfVec2i>

Usd Type

SdfValueTypeNames->Int2Array

Variability

SdfVariabilityUniform

inline UsdAttribute CreateSpringIndicesAttr() const

See GetSpringIndicesAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetSpringStiffnessesAttr() const

Stiffness values for linear-distance springs between a pair of particles as defined by index pairs in springIndices. Range: [0, inf) Units: force / distance = mass / second / second.

Declaration

float[] physxParticle:springStiffnesses

C++ Type

VtArray<float>

Usd Type

SdfValueTypeNames->FloatArray

inline UsdAttribute CreateSpringStiffnessesAttr() const

See GetSpringStiffnessesAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetSpringDampingsAttr() const

Coefficients for linear-distance dampers between a pair of particles as defined by index pairs in springIndices. Range: [0, inf) Units: force * second / distance = mass / second.

Declaration

float[] physxParticle:springDampings

C++ Type

VtArray<float>

Usd Type

SdfValueTypeNames->FloatArray

inline UsdAttribute CreateSpringDampingsAttr() const

See GetSpringDampingsAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetSpringRestLengthsAttr() const

Spring rest lengths corresponding to spring index pairs. Range: (-inf, inf) Units: distance.

Declaration

float[] physxParticle:springRestLengths

C++ Type

VtArray<float>

Usd Type

SdfValueTypeNames->FloatArray

inline UsdAttribute CreateSpringRestLengthsAttr() const

See GetSpringRestLengthsAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetPressureAttr() const

Pressure: If > 0, a particle cloth has an additional pressure constraint that provides inflatable (i.e. balloon-like) dynamics. The pressure times the rest volume defines the volume the inflatable tries to match. Pressure only works well for closed or approximately closed meshes. Range: [0, inf) Units: dimensionless.

Declaration

float physxParticle:pressure = 0

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreatePressureAttr() const

See GetPressureAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

UsdPrim GetPrim() const

Return this schema object’s held prim.

SdfPath GetPath() const

Return the SdfPath to this schema object’s held prim.

Public Static Functions

static inline PhysxSchemaPhysxParticleClothAPI Apply(const UsdPrim &prim)

Applies this single-apply API schema to the given prim. This information is stored by adding “PhysxParticleClothAPI” to the token-valued, listOp metadata apiSchemas on the prim.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

Returns

A valid PhysxSchemaPhysxParticleClothAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxParticleClothAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.

Public Static Attributes

static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI

Compile time constant representing what kind of schema this class is.

See also

UsdSchemaType

Protected Functions

inline const TfToken &_GetInstanceName() const

Returns the instance name of the API schema object belonging to a multiple-apply API schema.

The returned instance name will be empty for non-applied and single-apply API schemas.