WARNING: This is a draft API; the design is not fixed and may change in the future. More...
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 |
Whether the simulation should filter particle-particle collisions based on their rest position distances. 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 |
Particle positions in cloth rest configuration. 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 |
List of index pairs describing which points are connected by spring constraints. 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 |
Stiffness values for linear-distance springs between a pair of particles as defined by index pairs in springIndices. 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 |
Coefficients for linear-distance dampers between a pair of particles as defined by index pairs in springIndices. 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 |
Spring rest lengths corresponding to spring index pairs. 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 |
Pressure: If > 0, a particle cloth has an additional pressure constraint that provides inflatable (i.e. 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... | |
Public Member Functions inherited from PhysxSchemaPhysxParticleAPI | |
PhysxSchemaPhysxParticleAPI (const UsdPrim &prim=UsdPrim()) | |
Construct a PhysxSchemaPhysxParticleAPI on UsdPrim prim . More... | |
PhysxSchemaPhysxParticleAPI (const UsdSchemaBase &schemaObj) | |
Construct a PhysxSchemaPhysxParticleAPI on the prim held by schemaObj . More... | |
virtual PHYSXSCHEMA_API | ~PhysxSchemaPhysxParticleAPI () |
Destructor. More... | |
PHYSXSCHEMA_API UsdAttribute | GetParticleEnabledAttr () const |
Enable or disable the particle object. More... | |
PHYSXSCHEMA_API UsdAttribute | CreateParticleEnabledAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetParticleEnabledAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
PHYSXSCHEMA_API UsdAttribute | GetSelfCollisionAttr () const |
Enables self-collision of the particles or of the particle object. 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 | GetParticleGroupAttr () const |
Group Id of the particles. More... | |
PHYSXSCHEMA_API UsdAttribute | CreateParticleGroupAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetParticleGroupAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
PHYSXSCHEMA_API UsdRelationship | GetParticleSystemRel () const |
Single particle system that the particle-based object belongs to. More... | |
PHYSXSCHEMA_API UsdRelationship | CreateParticleSystemRel () const |
See GetParticleSystemRel(), 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 PhysxSchemaPhysxParticleClothAPI | Apply (const UsdPrim &prim) |
Applies this single-apply API schema to the given prim . More... | |
Static Public Member Functions inherited from PhysxSchemaPhysxParticleAPI | |
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 PhysxSchemaPhysxParticleAPI | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a PhysxSchemaPhysxParticleAPI holding the prim adhering to this schema at path on stage . More... | |
static PHYSXSCHEMA_API PhysxSchemaPhysxParticleAPI | 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 PhysxSchemaPhysxParticleAPI | |
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 PhysxSchemaPhysxParticleAPI | |
PHYSXSCHEMA_API UsdSchemaType | _GetSchemaType () const override |
Returns the type of schema this class belongs to. More... | |
Friends | |
class | UsdSchemaRegistry |
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 59 of file physxParticleClothAPI.h.
|
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 71 of file physxParticleClothAPI.h.
|
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 79 of file physxParticleClothAPI.h.
|
virtual |
Destructor.
|
overrideprotected |
Returns the type of schema this class belongs to.
|
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.
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 |
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:
PHYSXSCHEMA_API UsdAttribute GetPressureAttr | ( | ) | const |
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 |
Particle positions in cloth rest configuration.
Declaration | point3f[] physxParticle:restPoints |
C++ Type | VtArray<GfVec3f> |
Usd Type | SdfValueTypeNames->Point3fArray |
|
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 |
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 |
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 |
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 |
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 |
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 |
|
static |
Compile time constant representing what kind of schema this class is.
Definition at line 65 of file physxParticleClothAPI.h.