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

Inherits UsdAPISchemaBase.

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

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

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

PHYSXSCHEMA_API UsdAttribute	GetFlatteningEnabledAttr () const
	Deprecated: Will be replaced by a new deformable schema in a future release. More...

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

PHYSXSCHEMA_API UsdAttribute	GetBendingStiffnessScaleAttr () const
	Deprecated: Will be replaced by a new deformable schema in a future release. More...

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

PHYSXSCHEMA_API UsdAttribute	GetCollisionPairUpdateFrequencyAttr () const
	Deprecated: Will be replaced by a new deformable schema in a future release. More...

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

PHYSXSCHEMA_API UsdAttribute	GetCollisionIterationMultiplierAttr () const
	Deprecated: Will be replaced by a new deformable schema in a future release. More...

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

PHYSXSCHEMA_API UsdAttribute	GetMaxVelocityAttr () const
	Deprecated: Will be replaced by a new deformable schema in a future release. More...

PHYSXSCHEMA_API UsdAttribute	CreateMaxVelocityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetMaxVelocityAttr(), 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 PhysxSchemaPhysxDeformableSurfaceAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxDeformableSurfaceAPI 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 PhysxSchemaPhysxDeformableSurfaceAPI	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.

WARNING: This is a draft API; the design is not fixed and may change in the future. Applied to a UsdGeomMesh that is to be simulated as a deformable surface. See PhysxDeformableAPI for information on how to define the deformable surface's material properties.

Definition at line 60 of file physxDeformableSurfaceAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxDeformableSurfaceAPI ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxDeformableSurfaceAPI on UsdPrim prim .

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

Definition at line 72 of file physxDeformableSurfaceAPI.h.

PhysxSchemaPhysxDeformableSurfaceAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxDeformableSurfaceAPI on the prim held by schemaObj .

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

Definition at line 80 of file physxDeformableSurfaceAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxDeformableSurfaceAPI ( )

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

static

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

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

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

See GetBendingStiffnessScaleAttr(), 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 CreateCollisionIterationMultiplierAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetCollisionIterationMultiplierAttr(), 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 CreateCollisionPairUpdateFrequencyAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetCollisionPairUpdateFrequencyAttr(), 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 CreateFlatteningEnabledAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetFlatteningEnabledAttr(), 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 CreateMaxVelocityAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetMaxVelocityAttr(), 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 PhysxSchemaPhysxDeformableSurfaceAPI Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

static

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

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

*

PHYSXSCHEMA_API UsdAttribute GetBendingStiffnessScaleAttr ( ) const

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

Scales bending stiffness computed from Young's modulus, Poisson's ratio, and the cloth thickness. Range: [0, inf) Units: dimensionless


Declaration	`float physxDeformableSurface:bendingStiffnessScale = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetCollisionIterationMultiplierAttr ( ) const

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

Determines how many collision subiterations are used in each solver iteration. By defualt, collision constraints are applied once in each solver iteration, and increasing this value will apply collision constraints more frequently in each solver iteration, e.g., 2 means collision constraints are applied twice in each solver iteration (thus, the collision constraints are applied 2 x solverPositionIterationCount times in each time step). Increasing this value does not update collision pairs more frequently, see collisionPairUpdateFrequency. Range [1, solverPositionIterationCount/2]


Declaration	`uint physxDeformableSurface:collisionIterationMultiplier = 1`
C++ Type	unsigned int
Usd Type	SdfValueTypeNames->UInt

PHYSXSCHEMA_API UsdAttribute GetCollisionPairUpdateFrequencyAttr ( ) const

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

Determines how often collision pairs are updated in each time step. By default, the pairs of contact points are computed only at the beginning of each time step, and the pairs are kept during the time step. Increasing this value will update the contact pairs more frequently providing better contact points, e.g., 2 means collision pairs are updated twice in each time step: at the beginning of the time step, and in the middle of the time step (i.e., at the middle solver iteration). Range [1, solverPositionIterationCount/2]


Declaration	`uint physxDeformableSurface:collisionPairUpdateFrequency = 1`
C++ Type	unsigned int
Usd Type	SdfValueTypeNames->UInt

PHYSXSCHEMA_API UsdAttribute GetFlatteningEnabledAttr ( ) const

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

If enabled, bending forces are applied such that the surface flattens, i.e., neighboring triangles become coplanar. If disabled, the forces drive toward the bend at the rest state.


Declaration	`bool physxDeformableSurface:flatteningEnabled = 0`
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

PHYSXSCHEMA_API UsdAttribute GetMaxVelocityAttr ( ) const

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

Maximum velocity. The velocity of each vertex is clamped by the max velocity. Range: [0, inf) Units: distance / seconds


Declaration	`float physxDeformableSurface:maxVelocity = inf`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

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.

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 66 of file physxDeformableSurfaceAPI.h.

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

C:/g/19412595/omni/schema/source/physxSchema/physxDeformableSurfaceAPI.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