WARNING: This is a draft API; the design is not fixed and may change in the future. More...
Public Member Functions | |
PhysxSchemaPhysxParticleSetAPI (const UsdPrim &prim=UsdPrim()) | |
Construct a PhysxSchemaPhysxParticleSetAPI on UsdPrim prim . More... | |
PhysxSchemaPhysxParticleSetAPI (const UsdSchemaBase &schemaObj) | |
Construct a PhysxSchemaPhysxParticleSetAPI on the prim held by schemaObj . More... | |
virtual PHYSXSCHEMA_API | ~PhysxSchemaPhysxParticleSetAPI () |
Destructor. More... | |
PHYSXSCHEMA_API UsdAttribute | GetFluidAttr () const |
Flag to toggle simulation as fluid (True) or solid (False). More... | |
PHYSXSCHEMA_API UsdAttribute | CreateFluidAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetFluidAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
PHYSXSCHEMA_API UsdAttribute | GetSimulationPointsAttr () const |
This attribute is read-only and is updated from simulation to capture particle-simulation state while smoothed position data is written to the render position/points attribute of the UsdGeomPointInstancer/UsdGeomPoints. 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... | |
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 PhysxSchemaPhysxParticleSetAPI | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a PhysxSchemaPhysxParticleSetAPI holding the prim adhering to this schema at path on stage . More... | |
static PHYSXSCHEMA_API PhysxSchemaPhysxParticleSetAPI | 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 UsdGeomPointInstancer or a UsdGeomPointBased. Creates a set of particles for granular (i.e. solid-particle) material or fluid simulation with PhysX.
Definition at line 58 of file physxParticleSetAPI.h.
|
inlineexplicit |
Construct a PhysxSchemaPhysxParticleSetAPI on UsdPrim prim
.
Equivalent to PhysxSchemaPhysxParticleSetAPI::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 physxParticleSetAPI.h.
|
inlineexplicit |
Construct a PhysxSchemaPhysxParticleSetAPI on the prim held by schemaObj
.
Should be preferred over PhysxSchemaPhysxParticleSetAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.
Definition at line 78 of file physxParticleSetAPI.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 "PhysxParticleSetAPI" to the token-valued, listOp metadata apiSchemas on the prim.
PHYSXSCHEMA_API UsdAttribute CreateFluidAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetFluidAttr(), 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
.
|
static |
Return a PhysxSchemaPhysxParticleSetAPI 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 GetFluidAttr | ( | ) | const |
Flag to toggle simulation as fluid (True) or solid (False).
Declaration | bool physxParticle:fluid = 1 |
C++ Type | bool |
Usd Type | SdfValueTypeNames->Bool |
|
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 |
This attribute is read-only and is updated from simulation to capture particle-simulation state while smoothed position data is written to the render position/points attribute of the UsdGeomPointInstancer/UsdGeomPoints.
Declaration | point3f[] physxParticle:simulationPoints |
C++ Type | VtArray<GfVec3f> |
Usd Type | SdfValueTypeNames->Point3fArray |
|
static |
Compile time constant representing what kind of schema this class is.
Definition at line 64 of file physxParticleSetAPI.h.