usdrt::UsdPhysicsMaterialAPI

Defined in usdrt/scenegraph/usd/usdPhysics/materialAPI.h

Functions

usdrt::UsdPhysicsMaterialAPI::Apply: Applies this single-apply API schema to the given prim . This information is stored by adding "PhysicsMaterialAPI" to the token-valued, listOp metadata apiSchemas on the prim.
usdrt::UsdPhysicsMaterialAPI::CreateDensityAttr: 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 .
usdrt::UsdPhysicsMaterialAPI::CreateDynamicFrictionAttr: 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 .
usdrt::UsdPhysicsMaterialAPI::CreateRestitutionAttr: See GetRestitutionAttr() , 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 .
usdrt::UsdPhysicsMaterialAPI::CreateStaticFrictionAttr: See GetStaticFrictionAttr() , 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 .
usdrt::UsdPhysicsMaterialAPI::GetDensityAttr: If non-zero, defines the density of the material. This can be used for body mass computation, see PhysicsMassAPI. Note that if the density is 0.0 it is ignored. Units: mass/distance/distance/distance.
usdrt::UsdPhysicsMaterialAPI::GetDynamicFrictionAttr: Dynamic friction coefficient. Unitless.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::UsdPhysicsMaterialAPI::GetRestitutionAttr: Restitution coefficient. Unitless.
usdrt::UsdPhysicsMaterialAPI::GetStaticFrictionAttr: Static friction coefficient. Unitless.
usdrt::UsdPhysicsMaterialAPI::UsdPhysicsMaterialAPI: Construct a UsdPhysicsMaterialAPI on UsdPrim prim . Equivalent to UsdPhysicsMaterialAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim .
usdrt::UsdPhysicsMaterialAPI::UsdPhysicsMaterialAPI: Construct a UsdPhysicsMaterialAPI on the prim held by schemaObj . Should be preferred over UsdPhysicsMaterialAPI (schemaObj.GetPrim()), as it preserves SchemaBase state.
usdrt::DestructionSchemaDestructibleBaseAPI::_GetInstanceName: Returns the instance name of the API schema object belonging to a multiple-apply API schema.
usdrt::UsdPhysicsMaterialAPI::operator bool: Boolean operator.
usdrt::UsdPhysicsMaterialAPI::~UsdPhysicsMaterialAPI: Destructor.

Variables

usdrt::UsdPhysicsMaterialAPI::schemaType: Compile time constant representing what kind of schema this class is.

class UsdPhysicsMaterialAPI : public usdrt::UsdAPISchemaBase 

Adds simulation material properties to a Material. All collisions that have a relationship to this material will have their collision response defined through this material.

Public Functions

inline explicit UsdPhysicsMaterialAPI(const UsdPrim &prim = UsdPrim()): Construct a UsdPhysicsMaterialAPI on UsdPrim prim. Equivalent to UsdPhysicsMaterialAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim.

inline explicit UsdPhysicsMaterialAPI(const UsdSchemaBase &schemaObj): Construct a UsdPhysicsMaterialAPI on the prim held by schemaObj . Should be preferred over UsdPhysicsMaterialAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

inline virtual ~UsdPhysicsMaterialAPI(): 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 GetDynamicFrictionAttr() const

Dynamic friction coefficient. Unitless.


Declaration	`float physics:dynamicFriction = 0`
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 GetStaticFrictionAttr() const

Static friction coefficient. Unitless.


Declaration	`float physics:staticFriction = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateStaticFrictionAttr() const: See GetStaticFrictionAttr(), 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 GetRestitutionAttr() const

Restitution coefficient. Unitless.


Declaration	`float physics:restitution = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateRestitutionAttr() const: See GetRestitutionAttr(), 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 GetDensityAttr() const

If non-zero, defines the density of the material. This can be used for body mass computation, see PhysicsMassAPI. Note that if the density is 0.0 it is ignored. Units: mass/distance/distance/distance.


Declaration	`float physics: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.

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 UsdPhysicsMaterialAPI Apply(const UsdPrim &prim)

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