UsdPhysicsMaterialAPI Class Reference

Adds simulation material properties to a Material. More...

+ Inheritance diagram for UsdPhysicsMaterialAPI:

Public Member Functions

 UsdPhysicsMaterialAPI (const UsdPrim &prim=UsdPrim())
 Construct a UsdPhysicsMaterialAPI on UsdPrim prim . More...
 
 UsdPhysicsMaterialAPI (const UsdSchemaBase &schemaObj)
 Construct a UsdPhysicsMaterialAPI on the prim held by schemaObj . More...
 
virtual USDPHYSICS_API ~UsdPhysicsMaterialAPI ()
 Destructor. More...
 
USDPHYSICS_API UsdAttribute GetDynamicFrictionAttr () const
 Dynamic friction coefficient. More...
 
USDPHYSICS_API UsdAttribute CreateDynamicFrictionAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetDynamicFrictionAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDPHYSICS_API UsdAttribute GetStaticFrictionAttr () const
 Static friction coefficient. More...
 
USDPHYSICS_API UsdAttribute CreateStaticFrictionAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetStaticFrictionAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDPHYSICS_API UsdAttribute GetRestitutionAttr () const
 Restitution coefficient. More...
 
USDPHYSICS_API UsdAttribute CreateRestitutionAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetRestitutionAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDPHYSICS_API UsdAttribute GetDensityAttr () const
 If non-zero, defines the density of the material. More...
 
USDPHYSICS_API UsdAttribute CreateDensityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetDensityAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
- Public Member Functions inherited from UsdAPISchemaBase
 UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())
 Construct a UsdAPISchemaBase on UsdPrim prim . More...
 
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj)
 Construct a UsdAPISchemaBase on the prim held by schemaObj . More...
 
virtual USD_API ~UsdAPISchemaBase ()=0
 Destructor. More...
 
- Public Member Functions inherited from UsdSchemaBase
bool IsConcrete () const
 Returns whether or not this class corresponds to a concrete instantiable prim type in scene description. More...
 
bool IsTyped () const
 Returns whether or not this class inherits from UsdTyped. More...
 
bool IsAPISchema () const
 Returns whether this is an API schema or not. More...
 
bool IsAppliedAPISchema () const
 Returns whether this is an applied API schema or not. More...
 
bool IsMultipleApplyAPISchema () const
 Returns whether this is an applied API schema or not. More...
 
UsdSchemaKind GetSchemaKind () const
 Returns the kind of schema this class is. More...
 
USD_API UsdSchemaBase (const UsdPrim &prim=UsdPrim())
 Construct and store prim as the held prim. More...
 
USD_API UsdSchemaBase (const UsdSchemaBase &otherSchema)
 Construct and store for the same prim held by otherSchema. More...
 
virtual USD_API ~UsdSchemaBase ()
 Destructor. More...
 
USD_API operator bool () const
 
UsdPrim GetPrim () const
 Return this schema object's held prim. More...
 
SdfPath GetPath () const
 Shorthand for GetPrim()->GetPath(). More...
 
USD_API const UsdPrimDefinitionGetSchemaClassPrimDefinition () const
 Return the prim definition associated with this schema instance if one exists, otherwise return null. More...
 

Static Public Member Functions

static USDPHYSICS_API const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More...
 
static USDPHYSICS_API UsdPhysicsMaterialAPI Get (const UsdStagePtr &stage, const SdfPath &path)
 Return a UsdPhysicsMaterialAPI holding the prim adhering to this schema at path on stage. More...
 
static USDPHYSICS_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 USDPHYSICS_API UsdPhysicsMaterialAPI Apply (const UsdPrim &prim)
 Applies this single-apply API schema to the given prim. More...
 
- Static Public Member Functions inherited from UsdAPISchemaBase
static USD_API const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More...
 
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI
 Compile time constant representing what kind of schema this class is. More...
 
- Static Public Attributes inherited from UsdAPISchemaBase
static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractBase
 Compile time constant representing what kind of schema this class is. More...
 
- Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractBase
 Compile time constant representing what kind of schema this class is. More...
 

Protected Member Functions

USDPHYSICS_API UsdSchemaKind _GetSchemaKind () const override
 Returns the kind of schema this class belongs to. More...
 
- Protected Member Functions inherited from UsdAPISchemaBase
 UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)
 Construct a multiple-apply UsdAPISchemaBase on UsdPrim prim with the specified instanceName. More...
 
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)
 Construct a multiple-apply UsdAPISchemaBase on the prim held by schemaObj with the given instanceName. More...
 
const TfToken_GetInstanceName () const
 Returns the instance name of the API schema object belonging to a multiple-apply API schema. More...
 
USD_API bool _IsCompatible () const override
 Check whether this APISchema object is valid for the currently held. More...
 
- Protected Member Functions inherited from UsdSchemaBase
virtual UsdSchemaKind _GetSchemaType () const
 
const TfType_GetType () const
 
USD_API UsdAttribute _CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const
 

Friends

class UsdSchemaRegistry
 

Detailed Description

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.

Definition at line 59 of file materialAPI.h.

Constructor & Destructor Documentation

◆ UsdPhysicsMaterialAPI() [1/2]

UsdPhysicsMaterialAPI ( const UsdPrim prim = UsdPrim())
inlineexplicit

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

Definition at line 71 of file materialAPI.h.

◆ UsdPhysicsMaterialAPI() [2/2]

UsdPhysicsMaterialAPI ( const UsdSchemaBase schemaObj)
inlineexplicit

Construct a UsdPhysicsMaterialAPI on the prim held by schemaObj .

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

Definition at line 79 of file materialAPI.h.

◆ ~UsdPhysicsMaterialAPI()

virtual USDPHYSICS_API ~UsdPhysicsMaterialAPI ( )
virtual

Destructor.

Member Function Documentation

◆ _GetSchemaKind()

USDPHYSICS_API UsdSchemaKind _GetSchemaKind ( ) const
overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See also
UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

◆ Apply()

static USDPHYSICS_API UsdPhysicsMaterialAPI Apply ( const UsdPrim prim)
static

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.

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.
See also
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()

◆ CanApply()

static USDPHYSICS_API bool CanApply ( const UsdPrim prim,
std::string *  whyNot = nullptr 
)
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.

See also
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()

◆ CreateDensityAttr()

USDPHYSICS_API UsdAttribute CreateDensityAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) 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.

◆ CreateDynamicFrictionAttr()

USDPHYSICS_API UsdAttribute CreateDynamicFrictionAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) 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.

◆ CreateRestitutionAttr()

USDPHYSICS_API UsdAttribute CreateRestitutionAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) 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.

◆ CreateStaticFrictionAttr()

USDPHYSICS_API UsdAttribute CreateStaticFrictionAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) 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.

◆ Get()

static USDPHYSICS_API UsdPhysicsMaterialAPI Get ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

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

UsdPhysicsMaterialAPI(stage->GetPrimAtPath(path));

◆ GetDensityAttr()

USDPHYSICS_API 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

◆ GetDynamicFrictionAttr()

USDPHYSICS_API UsdAttribute GetDynamicFrictionAttr ( ) const

Dynamic friction coefficient.

Unitless.

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

◆ GetRestitutionAttr()

USDPHYSICS_API UsdAttribute GetRestitutionAttr ( ) const

Restitution coefficient.

Unitless.

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

◆ GetSchemaAttributeNames()

static USDPHYSICS_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.

◆ GetStaticFrictionAttr()

USDPHYSICS_API UsdAttribute GetStaticFrictionAttr ( ) const

Static friction coefficient.

Unitless.

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

Member Data Documentation

◆ schemaKind

const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI
static

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

See also
UsdSchemaKind

Definition at line 65 of file materialAPI.h.


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