Applied to a UsdGeomMesh that is to be driven by a deformable body simulation. More...

Inheritance diagram for PhysxSchemaPhysxDeformableBodyAPI:

Public Member Functions
	PhysxSchemaPhysxDeformableBodyAPI (const UsdPrim &prim=UsdPrim())
	Construct a PhysxSchemaPhysxDeformableBodyAPI on UsdPrim `prim` . More...

	PhysxSchemaPhysxDeformableBodyAPI (const UsdSchemaBase &schemaObj)
	Construct a PhysxSchemaPhysxDeformableBodyAPI on the prim held by `schemaObj` . More...

virtual PHYSXSCHEMA_API	~PhysxSchemaPhysxDeformableBodyAPI ()
	Destructor. More...

PHYSXSCHEMA_API UsdAttribute	GetDisableGravityAttr () const
	Disable gravity for the actor. More...

PHYSXSCHEMA_API UsdAttribute	CreateDisableGravityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetDisableGravityAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetCollisionIndicesAttr () const
	Mesh indices that define the collision tetrahedral mesh together with the collisionPoints attribute. More...

PHYSXSCHEMA_API UsdAttribute	CreateCollisionIndicesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetCollisionIndicesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetCollisionPointsAttr () const
	Mesh points in local coordinates that define the collision tetrahedral mesh together with the collisionIndices attribute. More...

PHYSXSCHEMA_API UsdAttribute	CreateCollisionPointsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetCollisionPointsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetCollisionRestPointsAttr () const
	Mesh rest points in local coordinates that define the rest pose of the collision tetrahedral mesh together with the collisionIndices attribute. More...

PHYSXSCHEMA_API UsdAttribute	CreateCollisionRestPointsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetCollisionRestPointsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetSimulationPointsAttr () const
	Simulation mesh points in local coordinates that define the simulation tetrahedral mesh together with the simulationIndices attribute. More...

PHYSXSCHEMA_API UsdAttribute	CreateSimulationPointsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSimulationPointsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetSimulationRestPointsAttr () const
	Mesh rest points in local coordinates that define the rest pose of the simulation tetrahedral mesh together with the simulationIndices attribute. More...

PHYSXSCHEMA_API UsdAttribute	CreateSimulationRestPointsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSimulationRestPointsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

Public Member Functions inherited from PhysxSchemaPhysxDeformableAPI
	PhysxSchemaPhysxDeformableAPI (const UsdPrim &prim=UsdPrim())
	Construct a PhysxSchemaPhysxDeformableAPI on UsdPrim `prim` . More...

	PhysxSchemaPhysxDeformableAPI (const UsdSchemaBase &schemaObj)
	Construct a PhysxSchemaPhysxDeformableAPI on the prim held by `schemaObj` . More...

virtual PHYSXSCHEMA_API	~PhysxSchemaPhysxDeformableAPI ()
	Destructor. More...

PHYSXSCHEMA_API UsdAttribute	GetDeformableEnabledAttr () const
	Enable or disable the deformable object. More...

PHYSXSCHEMA_API UsdAttribute	CreateDeformableEnabledAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetDeformableEnabledAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetSolverPositionIterationCountAttr () const
	Number of solver position iterations per time step. More...

PHYSXSCHEMA_API UsdAttribute	CreateSolverPositionIterationCountAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSolverPositionIterationCountAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetVertexVelocityDampingAttr () const
	Artificial damping on the vertex velocity, which may approximate aerodynamic drag. More...

PHYSXSCHEMA_API UsdAttribute	CreateVertexVelocityDampingAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetVertexVelocityDampingAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetSleepDampingAttr () const
	Additional damping term if vertex velocity drops below settlingThreshold. More...

PHYSXSCHEMA_API UsdAttribute	CreateSleepDampingAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSleepDampingAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetSleepThresholdAttr () const
	Velocity threshold under which the vertex becomes a candidate for sleeping. More...

PHYSXSCHEMA_API UsdAttribute	CreateSleepThresholdAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSleepThresholdAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetSettlingThresholdAttr () const
	Threshold vertex velocity under which sleep damping is applied in addition to velocity damping. More...

PHYSXSCHEMA_API UsdAttribute	CreateSettlingThresholdAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSettlingThresholdAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetSelfCollisionAttr () const
	Enables self collisions on the deformable, preventing self intersections. More...

PHYSXSCHEMA_API UsdAttribute	CreateSelfCollisionAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSelfCollisionAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetSelfCollisionFilterDistanceAttr () const
	Distance under which self-collisions are disabled. More...

PHYSXSCHEMA_API UsdAttribute	CreateSelfCollisionFilterDistanceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSelfCollisionFilterDistanceAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetEnableCCDAttr () const
	Distance based CCD. More...

PHYSXSCHEMA_API UsdAttribute	CreateEnableCCDAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetEnableCCDAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetRestPointsAttr () const
	Rest points of the UsdGeomMesh in local coordinates. More...

PHYSXSCHEMA_API UsdAttribute	CreateRestPointsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetRestPointsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetSimulationVelocitiesAttr () const
	Simulation mesh vertex velocities in local coordinates. More...

PHYSXSCHEMA_API UsdAttribute	CreateSimulationVelocitiesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSimulationVelocitiesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetSimulationIndicesAttr () const
	Simulation mesh indices. More...

PHYSXSCHEMA_API UsdAttribute	CreateSimulationIndicesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSimulationIndicesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdRelationship	GetSimulationOwnerRel () const
	Single PhysicsScene that simulates this deformable. More...

PHYSXSCHEMA_API UsdRelationship	CreateSimulationOwnerRel () const
	See GetSimulationOwnerRel(), 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 PhysxSchemaPhysxDeformableBodyAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxDeformableBodyAPI holding the prim adhering to this schema at `path` on `stage`. More...

static PHYSXSCHEMA_API PhysxSchemaPhysxDeformableBodyAPI	Apply (const UsdPrim &prim)
	Applies this single-apply API schema to the given `prim`. More...

Static Public Member Functions inherited from PhysxSchemaPhysxDeformableAPI
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 PhysxSchemaPhysxDeformableAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxDeformableAPI holding the prim adhering to this schema at `path` on `stage`. More...

static PHYSXSCHEMA_API PhysxSchemaPhysxDeformableAPI	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...

Static Public Attributes inherited from PhysxSchemaPhysxDeformableAPI
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...

Protected Member Functions inherited from PhysxSchemaPhysxDeformableAPI
PHYSXSCHEMA_API UsdSchemaType	_GetSchemaType () const override
	Returns the type of schema this class belongs to. More...

Friends
class	UsdSchemaRegistry

Detailed Description

Applied to a UsdGeomMesh that is to be driven by a deformable body simulation.

See PhysxDeformableAPI for information on how to define the deformable body's material properties.

Definition at line 58 of file physxDeformableBodyAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxDeformableBodyAPI ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxDeformableBodyAPI on UsdPrim prim .

Equivalent to PhysxSchemaPhysxDeformableBodyAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim

Definition at line 70 of file physxDeformableBodyAPI.h.

PhysxSchemaPhysxDeformableBodyAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxDeformableBodyAPI on the prim held by schemaObj .

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

Definition at line 78 of file physxDeformableBodyAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxDeformableBodyAPI ( )

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

static

Applies this single-apply API schema to the given prim.

This information is stored by adding "PhysxDeformableBodyAPI" to the token-valued, listOp metadata apiSchemas on the prim.

Returns: A valid PhysxSchemaPhysxDeformableBodyAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxDeformableBodyAPI 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 CreateCollisionIndicesAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetCollisionIndicesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.