PhysxSchemaPhysxAutoParticleClothAPI Class Reference

WARNING: This is a draft API; the design is not fixed and may change in the future. More...

Inherits UsdAPISchemaBase.

Public Member Functions
	PhysxSchemaPhysxAutoParticleClothAPI (const UsdPrim &prim=UsdPrim())
	Construct a PhysxSchemaPhysxAutoParticleClothAPI on UsdPrim prim . More...
	PhysxSchemaPhysxAutoParticleClothAPI (const UsdSchemaBase &schemaObj)
	Construct a PhysxSchemaPhysxAutoParticleClothAPI on the prim held by schemaObj . More...
virtual PHYSXSCHEMA_API	~PhysxSchemaPhysxAutoParticleClothAPI ()
	Destructor. More...
PHYSXSCHEMA_API UsdAttribute	GetSpringStretchStiffnessAttr () const
	Stretch stiffness. More...
PHYSXSCHEMA_API UsdAttribute	CreateSpringStretchStiffnessAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSpringStretchStiffnessAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetSpringBendStiffnessAttr () const
	Bend stiffness. More...
PHYSXSCHEMA_API UsdAttribute	CreateSpringBendStiffnessAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSpringBendStiffnessAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetSpringShearStiffnessAttr () const
	Shear stiffness. More...
PHYSXSCHEMA_API UsdAttribute	CreateSpringShearStiffnessAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSpringShearStiffnessAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetSpringDampingAttr () const
	Damping on cloth spring constraints. More...
PHYSXSCHEMA_API UsdAttribute	CreateSpringDampingAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSpringDampingAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetDisableMeshWeldingAttr () const
	Disable welding of the UsdGeomMesh vertices for cloth simulation. More...
PHYSXSCHEMA_API UsdAttribute	CreateDisableMeshWeldingAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetDisableMeshWeldingAttr(), 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 PhysxSchemaPhysxAutoParticleClothAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxAutoParticleClothAPI holding the prim adhering to this schema at path on stage. More...
static PHYSXSCHEMA_API PhysxSchemaPhysxAutoParticleClothAPI	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...

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

Friends
class	UsdSchemaRegistry

Detailed Description

WARNING: This is a draft API; the design is not fixed and may change in the future.

Applied to a UsdGeomMesh with PhysxParticleClothAPI. Defines parameters to automatically compute spring constraints.

Definition at line 58 of file physxAutoParticleClothAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxAutoParticleClothAPI ( const UsdPrim &  prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxAutoParticleClothAPI on UsdPrim prim .

Equivalent to PhysxSchemaPhysxAutoParticleClothAPI::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 physxAutoParticleClothAPI.h.

PhysxSchemaPhysxAutoParticleClothAPI ( const UsdSchemaBase &  schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxAutoParticleClothAPI on the prim held by schemaObj .

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

Definition at line 78 of file physxAutoParticleClothAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxAutoParticleClothAPI ( )

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

static

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

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

Returns

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

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

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

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

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

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

static

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

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

PHYSXSCHEMA_API UsdAttribute GetDisableMeshWeldingAttr

(

)

const

Disable welding of the UsdGeomMesh vertices for cloth simulation.

Declaration	bool physxAutoParticleCloth:disableMeshWelding = 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 GetSpringBendStiffnessAttr

(

)

const

Bend stiffness.

Represents a stiffness for linear springs placed in a way to counteract bending. Range: [0, inf) Units: force / distance = mass / second / second

Declaration	float physxAutoParticleCloth:springBendStiffness = 1.5
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetSpringDampingAttr

(

)

const

Damping on cloth spring constraints.

Applies to all constraints parametrized by stiffness attributes. Range: [0, inf) Units: force * second / distance = mass / second

Declaration	float physxAutoParticleCloth:springDamping = 10
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetSpringShearStiffnessAttr

(

)

const

Shear stiffness.

Represents a stiffness for linear springs placed in a way to counteract shear. Range: [0, inf) Units: force / distance = mass / second / second

Declaration	float physxAutoParticleCloth:springShearStiffness = 1.5
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetSpringStretchStiffnessAttr

(

)

const

Stretch stiffness.

Represents a stiffness for linear springs placed between particles to counteract stretching. Range: [0, inf) Units: force / distance = mass / second / second

Declaration	float physxAutoParticleCloth:springStretchStiffness = 1.5
C++ Type	float
Usd Type	SdfValueTypeNames->Float

Member Data Documentation

const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI

static

Compile time constant representing what kind of schema this class is.

See Also

UsdSchemaType

Definition at line 64 of file physxAutoParticleClothAPI.h.

---

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

• W:/919a5455eee1e83c/src/physxSchema/physxAutoParticleClothAPI.h