usdrt::PhysxSchemaPhysxDeformableBodyMaterialAPI

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

Functions

Variables

class PhysxSchemaPhysxDeformableBodyMaterialAPI : public usdrt::UsdAPISchemaBase

Applied to USD Material. Defines material properties for deformable bodies.

Public Functions

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

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

inline explicit PhysxSchemaPhysxDeformableBodyMaterialAPI(const UsdSchemaBase &schemaObj)

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

inline virtual ~PhysxSchemaPhysxDeformableBodyMaterialAPI()

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

Material density. If set to 0.0, the simulation determines a default density. A density or mass set with a PhysicsMassAPI overrides the material density. Range: [0, inf) Units: mass / distance / distance / distance.

Declaration

float physxDeformableBodyMaterial:density = 0

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateDensityAttr() const

See GetDensityAttr(), 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 GetElasticityDampingAttr() const

Material damping parameter. Use values much smaller than one for good results. Range: [0, inf) Units: dimensionless.

Declaration

float physxDeformableBodyMaterial:elasticityDamping = 0.005

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateElasticityDampingAttr() const

See GetElasticityDampingAttr(), 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 GetDynamicFrictionAttr() const

Dynamic friction coefficient. Range: [0, inf) Units: dimensionless.

Declaration

float physxDeformableBodyMaterial:dynamicFriction = 0.25

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateDynamicFrictionAttr() const

See GetDynamicFrictionAttr(), 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 GetYoungsModulusAttr() const

Young’s modulus, i.e. the tensile stiffness of the material. Range: [0, inf) Units: force / area = mass/distance/seconds/seconds.

Declaration

float physxDeformableBodyMaterial:youngsModulus = 50000000

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateYoungsModulusAttr() const

See GetYoungsModulusAttr(), 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 GetPoissonsRatioAttr() const

Poissons’s ratio which defines the material’s volume preservation under stress. Range: [0, 0.5] Units: dimensionless.

Declaration

float physxDeformableBodyMaterial:poissonsRatio = 0.45

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreatePoissonsRatioAttr() const

See GetPoissonsRatioAttr(), 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 GetDampingScaleAttr() const

Experimental parameter. Try a high damping together with a scale of zero for a water-bed like effect. Range: [0, 1] Units: dimensionless.

Declaration

float physxDeformableBodyMaterial:dampingScale = 1

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateDampingScaleAttr() const

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

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