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

Inherits UsdAPISchemaBase.

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

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

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

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

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

PHYSXSCHEMA_API UsdAttribute	GetRestPointsAttr () const
	Deprecated: Will be replaced by a new deformable schema in a future release. 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	GetSpringIndicesAttr () const
	Deprecated: Will be replaced by a new deformable schema in a future release. More...

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

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

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

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

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

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

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

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

PHYSXSCHEMA_API UsdAttribute	CreatePressureAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetPressureAttr(), 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 PhysxSchemaPhysxParticleClothAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxParticleClothAPI 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 PhysxSchemaPhysxParticleClothAPI	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. The mesh is simulated as a particle-based cloth or inflatable, depending on the mesh geometry and the pressure attribute. See PhysxAutoParticleClothAPI for an auto-compute helper for cloth springs and dampings.

Definition at line 60 of file physxParticleClothAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxParticleClothAPI ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxParticleClothAPI on UsdPrim prim .

Equivalent to PhysxSchemaPhysxParticleClothAPI::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 physxParticleClothAPI.h.

PhysxSchemaPhysxParticleClothAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxParticleClothAPI on the prim held by schemaObj .

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

Definition at line 80 of file physxParticleClothAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxParticleClothAPI ( )

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

static

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

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

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

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

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

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

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

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

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

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

static

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

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

*

PHYSXSCHEMA_API UsdAttribute GetPressureAttr ( ) const

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

Pressure: If > 0, a particle cloth has an additional pressure constraint that provides inflatable (i.e. balloon-like) dynamics. The pressure times the rest volume defines the volume the inflatable tries to match. Pressure only works well for closed or approximately closed meshes. Range: [0, inf) Units: dimensionless


Declaration	`float physxParticle:pressure = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetRestPointsAttr ( ) const

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

Particle positions in cloth rest configuration.


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

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 GetSelfCollisionFilterAttr ( ) const

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

Whether the simulation should filter particle-particle collisions based on their rest position distances.


Declaration	`bool physxParticle:selfCollisionFilter = 1`
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

PHYSXSCHEMA_API UsdAttribute GetSpringDampingsAttr ( ) const

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

Coefficients for linear-distance dampers between a pair of particles as defined by index pairs in springIndices. Range: [0, inf) Units: force * second / distance = mass / second


Declaration	`float[] physxParticle:springDampings`
C++ Type	VtArray<float>
Usd Type	SdfValueTypeNames->FloatArray

PHYSXSCHEMA_API UsdAttribute GetSpringIndicesAttr ( ) const

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

List of index pairs describing which points are connected by spring constraints.


Declaration	`uniform int2[] physxParticle:springIndices`
C++ Type	VtArray<GfVec2i>
Usd Type	SdfValueTypeNames->Int2Array
Variability	SdfVariabilityUniform

PHYSXSCHEMA_API UsdAttribute GetSpringRestLengthsAttr ( ) const

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

Spring rest lengths corresponding to spring index pairs. Range: (-inf, inf) Units: distance


Declaration	`float[] physxParticle:springRestLengths`
C++ Type	VtArray<float>
Usd Type	SdfValueTypeNames->FloatArray

PHYSXSCHEMA_API UsdAttribute GetSpringStiffnessesAttr ( ) const

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

Stiffness values for linear-distance springs between a pair of particles as defined by index pairs in springIndices. Range: [0, inf) Units: force / distance = mass / second / second


Declaration	`float[] physxParticle:springStiffnesses`
C++ Type	VtArray<float>
Usd Type	SdfValueTypeNames->FloatArray

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

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

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