usdrt::PhysxSchemaPhysxDeformableAPI

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

Functions

Variables

class PhysxSchemaPhysxDeformableAPI : public usdrt::UsdAPISchemaBase

Do not apply. Base API that provides attributes common to both deformable bodies and surfaces. Derived APIs are applied to UsdGeomMesh in order to create a deformable physics object. Note that the UsdGeomMesh points attribute becomes a read-only attribute for a deformable as the mesh is driven by the simulation.

Public Functions

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

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

inline explicit PhysxSchemaPhysxDeformableAPI(const UsdSchemaBase &schemaObj)

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

inline virtual ~PhysxSchemaPhysxDeformableAPI()

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

Enable or disable the deformable object.

Declaration

bool physxDeformable:deformableEnabled = 1

C++ Type

bool

Usd Type

SdfValueTypeNames->Bool

inline UsdAttribute CreateDeformableEnabledAttr() const

See GetDeformableEnabledAttr(), 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 GetSolverPositionIterationCountAttr() const

Number of solver position iterations per time step. Range: [1, 255].

Declaration

uint physxDeformable:solverPositionIterationCount = 16

C++ Type

unsigned int

Usd Type

SdfValueTypeNames->UInt

inline UsdAttribute CreateSolverPositionIterationCountAttr() const

See GetSolverPositionIterationCountAttr(), 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 GetVertexVelocityDampingAttr() const

Artificial damping on the vertex velocity, which may approximate aerodynamic drag. Range: [0, inf) Units: 1/seconds.

Declaration

float physxDeformable:vertexVelocityDamping = 0.005

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateVertexVelocityDampingAttr() const

See GetVertexVelocityDampingAttr(), 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 GetSleepDampingAttr() const

Additional damping term if vertex velocity drops below settlingThreshold. Range: [0, inf) Units: 1/seconds.

Declaration

float physxDeformable:sleepDamping = 10

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateSleepDampingAttr() const

See GetSleepDampingAttr(), 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 GetSleepThresholdAttr() const

Velocity threshold under which the vertex becomes a candidate for sleeping. Range: [0, inf) Units: distance/seconds.

Declaration

float physxDeformable:sleepThreshold = 0.05

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateSleepThresholdAttr() const

See GetSleepThresholdAttr(), 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 GetSettlingThresholdAttr() const

Threshold vertex velocity under which sleep damping is applied in addition to velocity damping. Range: [0, inf] Units: distance/seconds.

Declaration

float physxDeformable:settlingThreshold = 0.1

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateSettlingThresholdAttr() const

See GetSettlingThresholdAttr(), 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 GetMaxDepenetrationVelocityAttr() const

The maximum velocity permitted to be introduced by the solver to depenetrate intersections. Range: [0, inf) Units: distance / seconds.

Declaration

float physxDeformable:maxDepenetrationVelocity = inf

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateMaxDepenetrationVelocityAttr() const

See GetMaxDepenetrationVelocityAttr(), 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 GetSelfCollisionAttr() const

Enables self collisions on the deformable, preventing self intersections.

Declaration

bool physxDeformable:selfCollision = 0

C++ Type

bool

Usd Type

SdfValueTypeNames->Bool

inline UsdAttribute CreateSelfCollisionAttr() const

See GetSelfCollisionAttr(), 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 GetSelfCollisionFilterDistanceAttr() const

Distance under which self-collisions are disabled. Default value -inf means default is picked by the simulation. Range: [2*physxCollision:contactOffset, max_float] Units: distance.

Declaration

float physxDeformable:selfCollisionFilterDistance = -inf

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateSelfCollisionFilterDistanceAttr() const

See GetSelfCollisionFilterDistanceAttr(), 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 GetEnableCCDAttr() const

Distance based CCD.

Declaration

bool physxDeformable:enableCCD = 0

C++ Type

bool

Usd Type

SdfValueTypeNames->Bool

inline UsdAttribute CreateEnableCCDAttr() const

See GetEnableCCDAttr(), 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 GetRestPointsAttr() const

Rest points of the UsdGeomMesh in local coordinates. Units: distance.

Declaration

point3f[] physxDeformable:restPoints

C++ Type

VtArray<GfVec3f>

Usd Type

SdfValueTypeNames->Point3fArray

inline UsdAttribute CreateRestPointsAttr() const

See GetRestPointsAttr(), 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 GetSimulationVelocitiesAttr() const

Simulation mesh vertex velocities in local coordinates. Units: distance / seconds.

Declaration

point3f[] physxDeformable:simulationVelocities

C++ Type

VtArray<GfVec3f>

Usd Type

SdfValueTypeNames->Point3fArray

inline UsdAttribute CreateSimulationVelocitiesAttr() const

See GetSimulationVelocitiesAttr(), 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 GetSimulationIndicesAttr() const

Simulation mesh indices.

Declaration

uniform int[] physxDeformable:simulationIndices

C++ Type

VtArray<int>

Usd Type

SdfValueTypeNames->IntArray

Variability

SdfVariabilityUniform

inline UsdAttribute CreateSimulationIndicesAttr() const

See GetSimulationIndicesAttr(), 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 UsdRelationship GetSimulationOwnerRel() const

Single PhysicsScene that simulates this deformable. By default, this is the first PhysicsScene found in the stage using UsdStage::Traverse().

inline UsdRelationship CreateSimulationOwnerRel() const

See GetSimulationOwnerRel(), and also Create vs Get Property Methods for when to use Get vs Create.

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

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