usdrt::PhysxSchemaPhysxParticleSetAPI

Defined in usdrt/scenegraph/usd/physxSchema/physxParticleSetAPI.h

Functions

Variables

class PhysxSchemaPhysxParticleSetAPI : public usdrt::UsdAPISchemaBase

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.

Public Functions

inline explicit PhysxSchemaPhysxParticleSetAPI(const UsdPrim &prim = UsdPrim())

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.

inline explicit PhysxSchemaPhysxParticleSetAPI(const UsdSchemaBase &schemaObj)

Construct a PhysxSchemaPhysxParticleSetAPI on the prim held by schemaObj . Should be preferred over PhysxSchemaPhysxParticleSetAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

inline virtual ~PhysxSchemaPhysxParticleSetAPI()

Destructor.

inline operator bool() const

Boolean operator.

Returns

Return true if the contained prim is has this api schema applied using HasAPI, and false otherwise.

inline 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

inline UsdAttribute CreateFluidAttr() const

See GetFluidAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateSimulationPointsAttr() const

See GetSimulationPointsAttr(), and also Create vs Get Property Methods 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.

UsdPrim GetPrim() const

Return this schema object’s held prim.

SdfPath GetPath() const

Return the SdfPath to this schema object’s held prim.

Public Static Functions

static inline PhysxSchemaPhysxParticleSetAPI Apply(const UsdPrim &prim)

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.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

Returns

A valid PhysxSchemaPhysxParticleSetAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxParticleSetAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.

Public Static Attributes

static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI

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

See also

UsdSchemaType

Protected Functions

inline const TfToken &_GetInstanceName() const

Returns the instance name of the API schema object belonging to a multiple-apply API schema.

The returned instance name will be empty for non-applied and single-apply API schemas.