usdrt::PhysxSchemaPhysxDeformableSurfaceAPI

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

Functions

usdrt::PhysxSchemaPhysxDeformableSurfaceAPI::Apply: Applies this single-apply API schema to the given prim . This information is stored by adding "PhysxDeformableSurfaceAPI" to the token-valued, listOp metadata apiSchemas on the prim.
usdrt::PhysxSchemaPhysxDeformableSurfaceAPI::CreateBendingStiffnessScaleAttr: See GetBendingStiffnessScaleAttr() , 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 .
usdrt::PhysxSchemaPhysxDeformableSurfaceAPI::CreateCollisionIterationMultiplierAttr: See GetCollisionIterationMultiplierAttr() , 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 .
usdrt::PhysxSchemaPhysxDeformableSurfaceAPI::CreateCollisionPairUpdateFrequencyAttr: See GetCollisionPairUpdateFrequencyAttr() , 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 .
usdrt::PhysxSchemaPhysxDeformableSurfaceAPI::CreateFlatteningEnabledAttr: See GetFlatteningEnabledAttr() , 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 .
usdrt::PhysxSchemaPhysxDeformableSurfaceAPI::CreateMaxVelocityAttr: See GetMaxVelocityAttr() , 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 .
usdrt::PhysxSchemaPhysxDeformableSurfaceAPI::GetBendingStiffnessScaleAttr: Scales bending stiffness computed from Young's modulus, Poisson's ratio, and the cloth thickness. Range: [0, inf) Units: dimensionless.
usdrt::PhysxSchemaPhysxDeformableSurfaceAPI::GetCollisionIterationMultiplierAttr: Determines how many collision subiterations are used in each solver iteration. By defualt, collision constraints are applied once in each solver iteration, and increasing this value will apply collision constraints more frequently in each solver iteration, e.g., 2 means collision constraints are applied twice in each solver iteration (thus, the collision constraints are applied 2 x solverPositionIterationCount times in each time step). Increasing this value does not update collision pairs more frequently, see collisionPairUpdateFrequency. Range [1, solverPositionIterationCount/2].
usdrt::PhysxSchemaPhysxDeformableSurfaceAPI::GetCollisionPairUpdateFrequencyAttr: Determines how often collision pairs are updated in each time step. By default, the pairs of contact points are computed only at the beginning of each time step, and the pairs are kept during the time step. Increasing this value will update the contact pairs more frequently providing better contact points, e.g., 2 means collision pairs are updated twice in each time step: at the beginning of the time step, and in the middle of the time step (i.e., at the middle solver iteration). Range [1, solverPositionIterationCount/2].
usdrt::PhysxSchemaPhysxDeformableSurfaceAPI::GetFlatteningEnabledAttr: If enabled, bending forces are applied such that the surface flattens, i.e., neighboring triangles become coplanar. If disabled, the forces drive toward the bend at the rest state.
usdrt::PhysxSchemaPhysxDeformableSurfaceAPI::GetMaxVelocityAttr: Maximum velocity. The velocity of each vertex is clamped by the max velocity. Range: [0, inf) Units: distance / seconds.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::PhysxSchemaPhysxDeformableSurfaceAPI::PhysxSchemaPhysxDeformableSurfaceAPI: Construct a PhysxSchemaPhysxDeformableSurfaceAPI on the prim held by schemaObj . Should be preferred over PhysxSchemaPhysxDeformableSurfaceAPI (schemaObj.GetPrim()), as it preserves SchemaBase state.
usdrt::PhysxSchemaPhysxDeformableSurfaceAPI::PhysxSchemaPhysxDeformableSurfaceAPI: Construct a PhysxSchemaPhysxDeformableSurfaceAPI on UsdPrim prim . Equivalent to PhysxSchemaPhysxDeformableSurfaceAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim .
usdrt::DestructionSchemaDestructibleBaseAPI::_GetInstanceName: Returns the instance name of the API schema object belonging to a multiple-apply API schema.
usdrt::PhysxSchemaPhysxDeformableSurfaceAPI::operator bool: Boolean operator.
usdrt::PhysxSchemaPhysxDeformableSurfaceAPI::~PhysxSchemaPhysxDeformableSurfaceAPI: Destructor.

Variables

usdrt::PhysxSchemaPhysxDeformableSurfaceAPI::schemaType: Compile time constant representing what kind of schema this class is.

class PhysxSchemaPhysxDeformableSurfaceAPI : public usdrt::UsdAPISchemaBase 

WARNING: This is a draft API; the design is not fixed and may change in the future. Applied to a UsdGeomMesh that is to be simulated as a deformable surface. See PhysxDeformableAPI for information on how to define the deformable surface’s material properties.

Public Functions

inline explicit PhysxSchemaPhysxDeformableSurfaceAPI(const UsdPrim &prim = UsdPrim()): Construct a PhysxSchemaPhysxDeformableSurfaceAPI on UsdPrim prim. Equivalent to PhysxSchemaPhysxDeformableSurfaceAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim.

inline explicit PhysxSchemaPhysxDeformableSurfaceAPI(const UsdSchemaBase &schemaObj): Construct a PhysxSchemaPhysxDeformableSurfaceAPI on the prim held by schemaObj . Should be preferred over PhysxSchemaPhysxDeformableSurfaceAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

inline virtual ~PhysxSchemaPhysxDeformableSurfaceAPI(): 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 GetFlatteningEnabledAttr() const

If enabled, bending forces are applied such that the surface flattens, i.e., neighboring triangles become coplanar. If disabled, the forces drive toward the bend at the rest state.


Declaration	`bool physxDeformableSurface:flatteningEnabled = 0`
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

inline UsdAttribute CreateFlatteningEnabledAttr() const: See GetFlatteningEnabledAttr(), 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 GetBendingStiffnessScaleAttr() const

Scales bending stiffness computed from Young’s modulus, Poisson’s ratio, and the cloth thickness. Range: [0, inf) Units: dimensionless.


Declaration	`float physxDeformableSurface:bendingStiffnessScale = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateBendingStiffnessScaleAttr() const: See GetBendingStiffnessScaleAttr(), 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 GetCollisionPairUpdateFrequencyAttr() const

Determines how often collision pairs are updated in each time step. By default, the pairs of contact points are computed only at the beginning of each time step, and the pairs are kept during the time step. Increasing this value will update the contact pairs more frequently providing better contact points, e.g., 2 means collision pairs are updated twice in each time step: at the beginning of the time step, and in the middle of the time step (i.e., at the middle solver iteration). Range [1, solverPositionIterationCount/2].


Declaration	`uint physxDeformableSurface:collisionPairUpdateFrequency = 1`
C++ Type	unsigned int
Usd Type	SdfValueTypeNames->UInt

inline UsdAttribute CreateCollisionPairUpdateFrequencyAttr() const: See GetCollisionPairUpdateFrequencyAttr(), 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 GetCollisionIterationMultiplierAttr() const

Determines how many collision subiterations are used in each solver iteration. By defualt, collision constraints are applied once in each solver iteration, and increasing this value will apply collision constraints more frequently in each solver iteration, e.g., 2 means collision constraints are applied twice in each solver iteration (thus, the collision constraints are applied 2 x solverPositionIterationCount times in each time step). Increasing this value does not update collision pairs more frequently, see collisionPairUpdateFrequency. Range [1, solverPositionIterationCount/2].


Declaration	`uint physxDeformableSurface:collisionIterationMultiplier = 1`
C++ Type	unsigned int
Usd Type	SdfValueTypeNames->UInt

inline UsdAttribute CreateCollisionIterationMultiplierAttr() const: See GetCollisionIterationMultiplierAttr(), 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 GetMaxVelocityAttr() const

Maximum velocity. The velocity of each vertex is clamped by the max velocity. Range: [0, inf) Units: distance / seconds.


Declaration	`float physxDeformableSurface:maxVelocity = inf`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateMaxVelocityAttr() const: See GetMaxVelocityAttr(), 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 PhysxSchemaPhysxDeformableSurfaceAPI Apply(const UsdPrim &prim)

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