All Classes Files Functions Variables Pages
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Friends | List of all members
PhysxSchemaPhysxDeformableBodyMaterialAPI Class Reference

Applied to USD Material. More...

Inherits UsdAPISchemaBase.

Public Member Functions

 PhysxSchemaPhysxDeformableBodyMaterialAPI (const UsdPrim &prim=UsdPrim())
 Construct a PhysxSchemaPhysxDeformableBodyMaterialAPI on UsdPrim prim . More...
 
 PhysxSchemaPhysxDeformableBodyMaterialAPI (const UsdSchemaBase &schemaObj)
 Construct a PhysxSchemaPhysxDeformableBodyMaterialAPI on the prim held by schemaObj . More...
 
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxDeformableBodyMaterialAPI ()
 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 GetElasticityDampingAttr () const
 Material damping parameter. More...
 
PHYSXSCHEMA_API UsdAttribute CreateElasticityDampingAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetElasticityDampingAttr(), 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 GetDampingScaleAttr () const
 Experimental parameter. More...
 
PHYSXSCHEMA_API UsdAttribute CreateDampingScaleAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetDampingScaleAttr(), 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
PhysxSchemaPhysxDeformableBodyMaterialAPI 		Get (const UsdStagePtr &stage, const SdfPath &path)
 Return a PhysxSchemaPhysxDeformableBodyMaterialAPI holding the prim adhering to this schema at path on stage. More...
 
static PHYSXSCHEMA_API
PhysxSchemaPhysxDeformableBodyMaterialAPI 		Apply (const UsdPrim &prim)
 Applies this single-apply API schema to the given prim. More...
 

Static Public Attributes

static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI
 Compile time constant representing what kind of schema this class is. More...
 

Protected Member Functions

PHYSXSCHEMA_API UsdSchemaType _GetSchemaType () const override
 Returns the type of schema this class belongs to. More...
 

Friends

class UsdSchemaRegistry
 

Detailed Description

Applied to USD Material.

Defines material properties for deformable bodies.

Definition at line 57 of file physxDeformableBodyMaterialAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxDeformableBodyMaterialAPI ( const UsdPrim &  prim = UsdPrim())
inlineexplicit

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

Definition at line 69 of file physxDeformableBodyMaterialAPI.h.

PhysxSchemaPhysxDeformableBodyMaterialAPI ( const UsdSchemaBase &  schemaObj)
inlineexplicit

Construct a PhysxSchemaPhysxDeformableBodyMaterialAPI on the prim held by schemaObj .

Should be preferred over PhysxSchemaPhysxDeformableBodyMaterialAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 77 of file physxDeformableBodyMaterialAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxDeformableBodyMaterialAPI ( )
virtual

Destructor.

Member Function Documentation

PHYSXSCHEMA_API UsdSchemaType _GetSchemaType ( ) const
overrideprotected

Returns the type of schema this class belongs to.

See Also
UsdSchemaType
static PHYSXSCHEMA_API PhysxSchemaPhysxDeformableBodyMaterialAPI Apply ( const UsdPrim &  prim)
static

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.

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.
See Also
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()
PHYSXSCHEMA_API UsdAttribute CreateDampingScaleAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetDampingScaleAttr(), 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 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 CreateElasticityDampingAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetElasticityDampingAttr(), 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 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 PHYSXSCHEMA_API PhysxSchemaPhysxDeformableBodyMaterialAPI Get ( const UsdStagePtr &  stage,
const SdfPath &  path 
)
static

Return a PhysxSchemaPhysxDeformableBodyMaterialAPI 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:

* PhysxSchemaPhysxDeformableBodyMaterialAPI(stage->GetPrimAtPath(path));
*
PHYSXSCHEMA_API 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
PHYSXSCHEMA_API 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
PHYSXSCHEMA_API UsdAttribute GetDynamicFrictionAttr ( ) const

Dynamic friction coefficient.

Range: [0, inf) Units: dimensionless

Declaration float physxDeformableBodyMaterial:dynamicFriction = 0.25
C++ Type float
Usd Type SdfValueTypeNames->Float
PHYSXSCHEMA_API 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
PHYSXSCHEMA_API 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
static PHYSXSCHEMA_API const TfTokenVector& GetSchemaAttributeNames ( bool  includeInherited = true)
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 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

Member Data Documentation

const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI
static

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

See Also
UsdSchemaType

Definition at line 63 of file physxDeformableBodyMaterialAPI.h.

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