Deprecated: Will be replaced by a new deformable schema in a future release. More...
Inherits UsdAPISchemaBase.
Public Member Functions | |
PhysxSchemaPhysxDeformableSurfaceMaterialAPI (const UsdPrim &prim=UsdPrim()) | |
Construct a PhysxSchemaPhysxDeformableSurfaceMaterialAPI on UsdPrim prim . More... | |
PhysxSchemaPhysxDeformableSurfaceMaterialAPI (const UsdSchemaBase &schemaObj) | |
Construct a PhysxSchemaPhysxDeformableSurfaceMaterialAPI on the prim held by schemaObj . More... | |
virtual PHYSXSCHEMA_API | ~PhysxSchemaPhysxDeformableSurfaceMaterialAPI () |
Destructor. More... | |
PHYSXSCHEMA_API UsdAttribute | GetDensityAttr () const |
Material density. More... | |
PHYSXSCHEMA_API UsdAttribute | CreateDensityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetDensityAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
PHYSXSCHEMA_API UsdAttribute | GetDynamicFrictionAttr () const |
Dynamic friction coefficient. More... | |
PHYSXSCHEMA_API UsdAttribute | CreateDynamicFrictionAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetDynamicFrictionAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
PHYSXSCHEMA_API UsdAttribute | GetYoungsModulusAttr () const |
Young's modulus, i.e. More... | |
PHYSXSCHEMA_API UsdAttribute | CreateYoungsModulusAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetYoungsModulusAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
PHYSXSCHEMA_API UsdAttribute | GetPoissonsRatioAttr () const |
Poissons's ratio which defines the material's volume preservation under stress. More... | |
PHYSXSCHEMA_API UsdAttribute | CreatePoissonsRatioAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetPoissonsRatioAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
PHYSXSCHEMA_API UsdAttribute | GetThicknessAttr () const |
Virtual thickness of cloth mesh. More... | |
PHYSXSCHEMA_API UsdAttribute | CreateThicknessAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetThicknessAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
Static Public Member Functions | |
static PHYSXSCHEMA_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More... | |
static PHYSXSCHEMA_API PhysxSchemaPhysxDeformableSurfaceMaterialAPI | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a PhysxSchemaPhysxDeformableSurfaceMaterialAPI holding the prim adhering to this schema at path on stage . More... | |
static PHYSXSCHEMA_API bool | CanApply (const UsdPrim &prim, std::string *whyNot=nullptr) |
Returns true if this single-apply API schema can be applied to the given prim . More... | |
static PHYSXSCHEMA_API PhysxSchemaPhysxDeformableSurfaceMaterialAPI | Apply (const UsdPrim &prim) |
Applies this single-apply API schema to the given prim . More... | |
Static Public Attributes | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::SingleApplyAPI |
Compile time constant representing what kind of schema this class is. More... | |
Protected Member Functions | |
PHYSXSCHEMA_API UsdSchemaKind | _GetSchemaKind () const override |
Returns the kind of schema this class belongs to. More... | |
Friends | |
class | UsdSchemaRegistry |
Deprecated: Will be replaced by a new deformable schema in a future release.
WARNING: This is a draft API; the design is not fixed and may change in the future. Applied to USD Material. Defines material properties for deformable surfaces.
Definition at line 59 of file physxDeformableSurfaceMaterialAPI.h.
|
inlineexplicit |
Construct a PhysxSchemaPhysxDeformableSurfaceMaterialAPI on UsdPrim prim
.
Equivalent to PhysxSchemaPhysxDeformableSurfaceMaterialAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim
, but will not immediately throw an error for an invalid prim
Definition at line 71 of file physxDeformableSurfaceMaterialAPI.h.
|
inlineexplicit |
Construct a PhysxSchemaPhysxDeformableSurfaceMaterialAPI on the prim held by schemaObj
.
Should be preferred over PhysxSchemaPhysxDeformableSurfaceMaterialAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.
Definition at line 79 of file physxDeformableSurfaceMaterialAPI.h.
|
virtual |
Destructor.
|
overrideprotected |
Returns the kind of schema this class belongs to.
|
static |
Applies this single-apply API schema to the given prim
.
This information is stored by adding "PhysxDeformableSurfaceMaterialAPI" to the token-valued, listOp metadata apiSchemas on the prim.
|
static |
Returns true if this single-apply API schema can be applied to the given prim
.
If this schema can not be a applied to the prim, this returns false and, if provided, populates whyNot
with the reason it can not be applied.
Note that if CanApply returns false, that does not necessarily imply that calling Apply will fail. Callers are expected to call CanApply before calling Apply if they want to ensure that it is valid to apply a schema.
PHYSXSCHEMA_API UsdAttribute CreateDensityAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetDensityAttr(), and also Usd_Create_Or_Get_Property 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
.
PHYSXSCHEMA_API UsdAttribute CreateDynamicFrictionAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetDynamicFrictionAttr(), and also Usd_Create_Or_Get_Property 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
.
PHYSXSCHEMA_API UsdAttribute CreatePoissonsRatioAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetPoissonsRatioAttr(), and also Usd_Create_Or_Get_Property 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
.
PHYSXSCHEMA_API UsdAttribute CreateThicknessAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetThicknessAttr(), and also Usd_Create_Or_Get_Property 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
.
PHYSXSCHEMA_API UsdAttribute CreateYoungsModulusAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetYoungsModulusAttr(), and also Usd_Create_Or_Get_Property 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
.
|
static |
Return a PhysxSchemaPhysxDeformableSurfaceMaterialAPI holding the prim adhering to this schema at path
on stage
.
If no prim exists at path
on stage
, or if the prim at that path does not adhere to this schema, return an invalid schema object. This is shorthand for the following:
PHYSXSCHEMA_API UsdAttribute GetDensityAttr | ( | ) | const |
Material density.
If set to 0.0, the simulation determines a default value. The mass of deformable surface is computed by density * area * thickness. A density or mass set with a PhysicsMassAPI overrides the material density. Range: [0, inf) Units: mass / distance / distance / distance
Declaration | float physxDeformableSurfaceMaterial:density = 0 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
PHYSXSCHEMA_API UsdAttribute GetDynamicFrictionAttr | ( | ) | const |
Dynamic friction coefficient.
Range: [0, inf) Units: dimensionless
Declaration | float physxDeformableSurfaceMaterial:dynamicFriction = 0.25 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
PHYSXSCHEMA_API UsdAttribute GetPoissonsRatioAttr | ( | ) | const |
Poissons's ratio which defines the material's volume preservation under stress.
Used to determine in-plane and bending stiffness. Range: [0, 0.5] Units: dimensionless
Declaration | float physxDeformableSurfaceMaterial:poissonsRatio = 0 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
|
static |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended methods of the schemas involved.
PHYSXSCHEMA_API UsdAttribute GetThicknessAttr | ( | ) | const |
Virtual thickness of cloth mesh.
Used to determine in-plane and bending stiffness, and mass from density. If set to 0.0, the simulation determines a default value. Range: [0.0, inf) Units: distance
Declaration | float physxDeformableSurfaceMaterial:thickness = 0 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
PHYSXSCHEMA_API UsdAttribute GetYoungsModulusAttr | ( | ) | const |
Young's modulus, i.e.
the tensile stiffness of the material. Used to determine in-plane and bending stiffness. If set to a negative value, the simulation determines a default value. Range: [0, inf) Units: force / area = mass/distance/seconds/seconds
Declaration | float physxDeformableSurfaceMaterial:youngsModulus = -inf |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
|
static |
Compile time constant representing what kind of schema this class is.
Definition at line 65 of file physxDeformableSurfaceMaterialAPI.h.