usdrt::PhysxSchemaPhysxParticleSmoothingAPI

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

Functions

Variables

class PhysxSchemaPhysxParticleSmoothingAPI : public usdrt::UsdAPISchemaBase

WARNING: This is a draft API; the design is not fixed and may change in the future. Applied to a PhysxParticleSystem. Controls smoothing of simulated particle positions in a post-processing step. The smoothing post-processing only affects the rendering output including isosurface generation, and not the particle dynamics. Affects point based primitives with PhysxParticleSetAPI, which are defined as fluid.

Public Functions

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

Construct a PhysxSchemaPhysxParticleSmoothingAPI on UsdPrim prim. Equivalent to PhysxSchemaPhysxParticleSmoothingAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim.

inline explicit PhysxSchemaPhysxParticleSmoothingAPI(const UsdSchemaBase &schemaObj)

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

inline virtual ~PhysxSchemaPhysxParticleSmoothingAPI()

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

Enable or disable smoothingStrength of particle positions.

Declaration

bool physxParticleSmoothing:particleSmoothingEnabled = 1

C++ Type

bool

Usd Type

SdfValueTypeNames->Bool

inline UsdAttribute CreateParticleSmoothingEnabledAttr() const

See GetParticleSmoothingEnabledAttr(), 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 GetStrengthAttr() const

Smoothing coefficient for particle positions. Range: [0, 1] Units: dimensionless.

Declaration

float physxParticleSmoothing:strength = 0.8

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateStrengthAttr() const

See GetStrengthAttr(), 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 PhysxSchemaPhysxParticleSmoothingAPI Apply(const UsdPrim &prim)

Applies this single-apply API schema to the given prim. This information is stored by adding “PhysxParticleSmoothingAPI” 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 PhysxSchemaPhysxParticleSmoothingAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxParticleSmoothingAPI 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.