#include <materialAPI.h>

Inheritance diagram for UsdPhysicsMaterialAPI:

Public Member Functions
	UsdPhysicsMaterialAPI (const UsdPrim &prim=UsdPrim())

	UsdPhysicsMaterialAPI (const UsdSchemaBase &schemaObj)

virtual USDPHYSICS_API	~UsdPhysicsMaterialAPI ()
	Destructor. More...

USDPHYSICS_API UsdAttribute	GetDynamicFrictionAttr () const

USDPHYSICS_API UsdAttribute	CreateDynamicFrictionAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const

USDPHYSICS_API UsdAttribute	GetStaticFrictionAttr () const

USDPHYSICS_API UsdAttribute	CreateStaticFrictionAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const

USDPHYSICS_API UsdAttribute	GetRestitutionAttr () const

USDPHYSICS_API UsdAttribute	CreateRestitutionAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const

USDPHYSICS_API UsdAttribute	GetDensityAttr () const

USDPHYSICS_API UsdAttribute	CreateDensityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const

Public Member Functions inherited from UsdAPISchemaBase
	UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())

	UsdAPISchemaBase (const UsdSchemaBase &schemaObj)

virtual USD_API	~UsdAPISchemaBase ()=0
	Destructor. More...

Public Member Functions inherited from UsdSchemaBase
bool	IsConcrete () const

bool	IsTyped () const

bool	IsAPISchema () const
	Returns whether this is an API schema or not. More...

bool	IsAppliedAPISchema () const

bool	IsMultipleApplyAPISchema () const

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 UsdPrimDefinition *	GetSchemaClassPrimDefinition () const

Static Public Member Functions
static USDPHYSICS_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

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

static USDPHYSICS_API bool	CanApply (const UsdPrim &prim, std::string *whyNot=nullptr)

static USDPHYSICS_API UsdPhysicsMaterialAPI	Apply (const UsdPrim &prim)

Static Public Member Functions inherited from UsdAPISchemaBase
static USD_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::SingleApplyAPI

Static Public Attributes inherited from UsdAPISchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase

Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase

Protected Member Functions
USDPHYSICS_API UsdSchemaKind	_GetSchemaKind () const override

Protected Member Functions inherited from UsdAPISchemaBase
	UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)

	UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)

const TfToken &	_GetInstanceName () const

USD_API bool	_IsCompatible () const override

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)

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::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::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.

virtual USDPHYSICS_API UsdPhysicsMaterialAPI::~UsdPhysicsMaterialAPI ( )

virtual

Destructor.

Member Function Documentation

USDPHYSICS_API UsdSchemaKind UsdPhysicsMaterialAPI::_GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also: UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

static USDPHYSICS_API UsdPhysicsMaterialAPI 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()

static USDPHYSICS_API bool UsdPhysicsMaterialAPI::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()

USDPHYSICS_API UsdAttribute UsdPhysicsMaterialAPI::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.

USDPHYSICS_API UsdAttribute UsdPhysicsMaterialAPI::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.

USDPHYSICS_API UsdAttribute UsdPhysicsMaterialAPI::CreateRestitutionAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetRestitutionAttr(), 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.

USDPHYSICS_API UsdAttribute UsdPhysicsMaterialAPI::CreateStaticFrictionAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetStaticFrictionAttr(), 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 USDPHYSICS_API UsdPhysicsMaterialAPI 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));

USDPHYSICS_API UsdAttribute UsdPhysicsMaterialAPI::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 UsdPhysicsMaterialAPI::GetDynamicFrictionAttr ( ) const

Dynamic friction coefficient. Unitless.


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

USDPHYSICS_API UsdAttribute UsdPhysicsMaterialAPI::GetRestitutionAttr ( ) const

Restitution coefficient. Unitless.


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

static USDPHYSICS_API const TfTokenVector& UsdPhysicsMaterialAPI::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.

USDPHYSICS_API UsdAttribute UsdPhysicsMaterialAPI::GetStaticFrictionAttr ( ) const

Static friction coefficient. Unitless.


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

Friends And Related Function Documentation

friend class UsdSchemaRegistry

friend

Definition at line 157 of file materialAPI.h.

Member Data Documentation

const UsdSchemaKind UsdPhysicsMaterialAPI::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:

pxr/usd/usdPhysics/materialAPI.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation