Deprecated: Will be replaced by a new deformable schema in a future release. More...

Inherits UsdAPISchemaBase.

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
	Deprecated: Will be replaced by a new deformable schema in a future release. 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
	Deprecated: Will be replaced by a new deformable schema in a future release. 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
	Deprecated: Will be replaced by a new deformable schema in a future release. 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
	Deprecated: Will be replaced by a new deformable schema in a future release. 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
	Deprecated: Will be replaced by a new deformable schema in a future release. 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
	Deprecated: Will be replaced by a new deformable schema in a future release. 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...

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 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 PHYSXSCHEMA_API PhysxSchemaPhysxDeformableBodyAPI	Apply (const UsdPrim &prim)
	Applies this single-apply API schema to the given `prim`. More...

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::SingleApplyAPI
	Compile time constant representing what kind of schema this class is. More...

Protected Member Functions
PHYSXSCHEMA_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to. More...

Friends
class	UsdSchemaRegistry

Detailed Description

Deprecated: Will be replaced by a new deformable schema in a future release.

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 59 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 71 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 79 of file physxDeformableBodyAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxDeformableBodyAPI ( )

virtual

Destructor.

Member Function Documentation

PHYSXSCHEMA_API UsdSchemaKind _GetSchemaKind ( ) const

overrideprotected

Returns the kind of schema this class belongs to.

See Also: UsdSchemaKind

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::CanApplyAPI(); UsdPrim::ApplyAPI(); UsdPrim::RemoveAPI()

static PHYSXSCHEMA_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()

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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 PHYSXSCHEMA_API PhysxSchemaPhysxDeformableBodyAPI Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

static

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

* PhysxSchemaPhysxDeformableBodyAPI(stage->GetPrimAtPath(path));

*

PHYSXSCHEMA_API UsdAttribute GetCollisionIndicesAttr ( ) const

Deprecated: Will be replaced by a new deformable schema in a future release.

Mesh indices that define the collision tetrahedral mesh together with the collisionPoints attribute.


Declaration	`uniform int[] physxDeformable:collisionIndices`
C++ Type	VtArray<int>
Usd Type	SdfValueTypeNames->IntArray
Variability	SdfVariabilityUniform

PHYSXSCHEMA_API UsdAttribute GetCollisionPointsAttr ( ) const

Deprecated: Will be replaced by a new deformable schema in a future release.

Mesh points in local coordinates that define the collision tetrahedral mesh together with the collisionIndices attribute. This attribute is read-only and may be updated from simulation data to reflect the current simulation state.


Declaration	`point3f[] physxDeformable:collisionPoints`
C++ Type	VtArray<GfVec3f>
Usd Type	SdfValueTypeNames->Point3fArray

PHYSXSCHEMA_API UsdAttribute GetCollisionRestPointsAttr ( ) const

Deprecated: Will be replaced by a new deformable schema in a future release.

Mesh rest points in local coordinates that define the rest pose of the collision tetrahedral mesh together with the collisionIndices attribute.


Declaration	`point3f[] physxDeformable:collisionRestPoints`
C++ Type	VtArray<GfVec3f>
Usd Type	SdfValueTypeNames->Point3fArray

PHYSXSCHEMA_API UsdAttribute GetDisableGravityAttr ( ) const

Deprecated: Will be replaced by a new deformable schema in a future release.

Disable gravity for the actor.


Declaration	`bool physxDeformable:disableGravity = 0`
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

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

PHYSXSCHEMA_API UsdAttribute GetSimulationPointsAttr ( ) const

Deprecated: Will be replaced by a new deformable schema in a future release.

Simulation mesh points in local coordinates that define the simulation tetrahedral mesh together with the simulationIndices attribute. This attribute may be updated from simulation data to reflect the current simulation state.


Declaration	`point3f[] physxDeformable:simulationPoints`
C++ Type	VtArray<GfVec3f>
Usd Type	SdfValueTypeNames->Point3fArray

PHYSXSCHEMA_API UsdAttribute GetSimulationRestPointsAttr ( ) const

Deprecated: Will be replaced by a new deformable schema in a future release.

Mesh rest points in local coordinates that define the rest pose of the simulation tetrahedral mesh together with the simulationIndices attribute.


Declaration	`point3f[] physxDeformable:simulationRestPoints`
C++ Type	VtArray<GfVec3f>
Usd Type	SdfValueTypeNames->Point3fArray

Member Data Documentation

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 physxDeformableBodyAPI.h.

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

C:/g/19412595/omni/schema/source/physxSchema/physxDeformableBodyAPI.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation