|
Adds simulation material properties to a Material. More...
#include <materialAPI.h>
Public Member Functions | |
UsdPhysicsMaterialAPI (const UsdPrim &prim=UsdPrim()) | |
Construct a UsdPhysicsMaterialAPI on UsdPrim prim . | |
UsdPhysicsMaterialAPI (const UsdSchemaBase &schemaObj) | |
Construct a UsdPhysicsMaterialAPI on the prim held by schemaObj . | |
virtual USDPHYSICS_API | ~UsdPhysicsMaterialAPI () |
Destructor. | |
USDPHYSICS_API UsdAttribute | GetDynamicFrictionAttr () const |
Dynamic friction coefficient. | |
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. | |
USDPHYSICS_API UsdAttribute | GetStaticFrictionAttr () const |
Static friction coefficient. | |
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. | |
USDPHYSICS_API UsdAttribute | GetRestitutionAttr () const |
Restitution coefficient. | |
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. | |
USDPHYSICS_API UsdAttribute | GetDensityAttr () const |
If non-zero, defines the density of the material. | |
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. | |
Public Member Functions inherited from UsdAPISchemaBase | |
UsdAPISchemaBase (const UsdPrim &prim=UsdPrim()) | |
Construct a UsdAPISchemaBase on UsdPrim prim . | |
UsdAPISchemaBase (const UsdSchemaBase &schemaObj) | |
Construct a UsdAPISchemaBase on the prim held by schemaObj . | |
virtual USD_API | ~UsdAPISchemaBase ()=0 |
Destructor. | |
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. | |
bool | IsTyped () const |
Returns whether or not this class inherits from UsdTyped. | |
bool | IsAPISchema () const |
Returns whether this is an API schema or not. | |
bool | IsAppliedAPISchema () const |
Returns whether this is an applied API schema or not. | |
bool | IsMultipleApplyAPISchema () const |
Returns whether this is an applied API schema or not. | |
UsdSchemaKind | GetSchemaKind () const |
Returns the kind of schema this class is. | |
USD_API | UsdSchemaBase (const UsdPrim &prim=UsdPrim()) |
Construct and store prim as the held prim. | |
USD_API | UsdSchemaBase (const UsdSchemaBase &otherSchema) |
Construct and store for the same prim held by otherSchema . | |
virtual USD_API | ~UsdSchemaBase () |
Destructor. | |
UsdPrim | GetPrim () const |
Return this schema object's held prim. | |
SdfPath | GetPath () const |
Shorthand for GetPrim()->GetPath(). | |
USD_API const UsdPrimDefinition * | GetSchemaClassPrimDefinition () const |
Return the prim definition associated with this schema instance if one exists, otherwise return null. | |
USD_API | operator bool () const |
Return true if this schema object is compatible with its held prim, false otherwise. | |
Static Public Member Functions | |
static USDPHYSICS_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. | |
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 . | |
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 . | |
static USDPHYSICS_API UsdPhysicsMaterialAPI | Apply (const UsdPrim &prim) |
Applies this single-apply API schema to the given prim . | |
Static Public Member Functions inherited from UsdAPISchemaBase | |
static USD_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. | |
Static Public Member Functions inherited from UsdSchemaBase | |
static const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Static Public Attributes | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::SingleApplyAPI |
Compile time constant representing what kind of schema this class is. | |
Static Public Attributes inherited from UsdAPISchemaBase | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
Compile time constant representing what kind of schema this class is. | |
Static Public Attributes inherited from UsdSchemaBase | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
Compile time constant representing what kind of schema this class is. | |
Protected Member Functions | |
USDPHYSICS_API UsdSchemaKind | _GetSchemaKind () const override |
Returns the kind of schema this class belongs to. | |
Protected Member Functions inherited from UsdAPISchemaBase | |
USD_API UsdSchemaKind | _GetSchemaKind () const override |
Returns the kind of schema this class belongs to. | |
UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName) | |
Construct a multiple-apply UsdAPISchemaBase on UsdPrim prim with the specified instanceName . | |
UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName) | |
Construct a multiple-apply UsdAPISchemaBase on the prim held by schemaObj with the given instanceName . | |
const TfToken & | _GetInstanceName () const |
Returns the instance name of the API schema object belonging to a multiple-apply API schema. | |
USD_API bool | _IsCompatible () const override |
Check whether this APISchema object is valid for the currently held prim. | |
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 |
Additional Inherited Members | |
Static Protected Member Functions inherited from UsdAPISchemaBase | |
static USD_API TfTokenVector | _GetMultipleApplyInstanceNames (const UsdPrim &prim, const TfType &schemaType) |
Returns a vector of names of API schema objects belonging to a multiple-apply API schema applied to a given prim. | |
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 42 of file materialAPI.h.
|
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 54 of file materialAPI.h.
|
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 62 of file materialAPI.h.
|
virtual |
Destructor.
|
overrideprotectedvirtual |
Returns the kind of schema this class belongs to.
Reimplemented from UsdAPISchemaBase.
|
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.
|
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.
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
.
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
.
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
.
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
.
|
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:
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 |
USDPHYSICS_API UsdAttribute GetDynamicFrictionAttr | ( | ) | const |
Dynamic friction coefficient.
Unitless.
Declaration | float physics:dynamicFriction = 0 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDPHYSICS_API UsdAttribute GetRestitutionAttr | ( | ) | const |
Restitution coefficient.
Unitless.
Declaration | float physics:restitution = 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.
USDPHYSICS_API UsdAttribute GetStaticFrictionAttr | ( | ) | const |
Static friction coefficient.
Unitless.
Declaration | float physics:staticFriction = 0 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
|
friend |
Definition at line 140 of file materialAPI.h.
|
static |
Compile time constant representing what kind of schema this class is.
Definition at line 48 of file materialAPI.h.