usdrt::PhysxSchemaPhysxAutoParticleClothAPI

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

Functions

Variables

class PhysxSchemaPhysxAutoParticleClothAPI : public usdrt::UsdAPISchemaBase

WARNING: This is a draft API; the design is not fixed and may change in the future. Applied to a UsdGeomMesh with PhysxParticleClothAPI. Defines parameters to automatically compute spring constraints.

Public Functions

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

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

inline explicit PhysxSchemaPhysxAutoParticleClothAPI(const UsdSchemaBase &schemaObj)

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

inline virtual ~PhysxSchemaPhysxAutoParticleClothAPI()

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 GetSpringStretchStiffnessAttr() const

Stretch stiffness. Represents a stiffness for linear springs placed between particles to counteract stretching. Range: [0, inf) Units: force / distance = mass / second / second.

Declaration

float physxAutoParticleCloth:springStretchStiffness = 1.5

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateSpringStretchStiffnessAttr() const

See GetSpringStretchStiffnessAttr(), 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 GetSpringBendStiffnessAttr() const

Bend stiffness. Represents a stiffness for linear springs placed in a way to counteract bending. Range: [0, inf) Units: force / distance = mass / second / second.

Declaration

float physxAutoParticleCloth:springBendStiffness = 1.5

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateSpringBendStiffnessAttr() const

See GetSpringBendStiffnessAttr(), 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 GetSpringShearStiffnessAttr() const

Shear stiffness. Represents a stiffness for linear springs placed in a way to counteract shear. Range: [0, inf) Units: force / distance = mass / second / second.

Declaration

float physxAutoParticleCloth:springShearStiffness = 1.5

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateSpringShearStiffnessAttr() const

See GetSpringShearStiffnessAttr(), 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 GetSpringDampingAttr() const

Damping on cloth spring constraints. Applies to all constraints parametrized by stiffness attributes. Range: [0, inf) Units: force * second / distance = mass / second.

Declaration

float physxAutoParticleCloth:springDamping = 10

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateSpringDampingAttr() const

See GetSpringDampingAttr(), 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 GetDisableMeshWeldingAttr() const

Disable welding of the UsdGeomMesh vertices for cloth simulation.

Declaration

bool physxAutoParticleCloth:disableMeshWelding = 0

C++ Type

bool

Usd Type

SdfValueTypeNames->Bool

inline UsdAttribute CreateDisableMeshWeldingAttr() const

See GetDisableMeshWeldingAttr(), 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 PhysxSchemaPhysxAutoParticleClothAPI Apply(const UsdPrim &prim)

Applies this single-apply API schema to the given prim. This information is stored by adding “PhysxAutoParticleClothAPI” 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 PhysxSchemaPhysxAutoParticleClothAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxAutoParticleClothAPI 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.