usdrt::PhysxSchemaPhysxDeformableBodyAPI

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

Functions

Variables

class PhysxSchemaPhysxDeformableBodyAPI : public usdrt::UsdAPISchemaBase

Applied to a UsdGeomMesh that is to be driven by a deformable body simulation. See PhysxDeformableAPI for information on how to define the deformable body’s material properties.

Public Functions

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

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

inline explicit PhysxSchemaPhysxDeformableBodyAPI(const UsdSchemaBase &schemaObj)

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

inline virtual ~PhysxSchemaPhysxDeformableBodyAPI()

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

Disable gravity for the actor.

Declaration

bool physxDeformable:disableGravity = 0

C++ Type

bool

Usd Type

SdfValueTypeNames->Bool

inline UsdAttribute CreateDisableGravityAttr() const

See GetDisableGravityAttr(), 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 GetCollisionIndicesAttr() const

Mesh indices that define the collision tetrahedral mesh together with the collisionPoints attribute.

Declaration

uniform int[] physxDeformable:collisionIndices

C++ Type

VtArray<int>

Usd Type

SdfValueTypeNames->IntArray

Variability

SdfVariabilityUniform

inline UsdAttribute CreateCollisionIndicesAttr() const

See GetCollisionIndicesAttr(), 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 GetCollisionPointsAttr() const

Mesh points in local coordinates that define the collision tetrahedral mesh together with the collisionIndices attribute. This attribute is read-only and may be updated from simulation data to reflect the current simulation state.

Declaration

point3f[] physxDeformable:collisionPoints

C++ Type

VtArray<GfVec3f>

Usd Type

SdfValueTypeNames->Point3fArray

inline UsdAttribute CreateCollisionPointsAttr() const

See GetCollisionPointsAttr(), 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 GetCollisionRestPointsAttr() const

Mesh rest points in local coordinates that define the rest pose of the collision tetrahedral mesh together with the collisionIndices attribute.

Declaration

point3f[] physxDeformable:collisionRestPoints

C++ Type

VtArray<GfVec3f>

Usd Type

SdfValueTypeNames->Point3fArray

inline UsdAttribute CreateCollisionRestPointsAttr() const

See GetCollisionRestPointsAttr(), 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

Simulation mesh points in local coordinates that define the simulation tetrahedral mesh together with the simulationIndices attribute. This attribute may be updated from simulation data to reflect the current simulation state.

Declaration

point3f[] physxDeformable: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.

inline UsdAttribute GetSimulationRestPointsAttr() const

Mesh rest points in local coordinates that define the rest pose of the simulation tetrahedral mesh together with the simulationIndices attribute.

Declaration

point3f[] physxDeformable:simulationRestPoints

C++ Type

VtArray<GfVec3f>

Usd Type

SdfValueTypeNames->Point3fArray

inline UsdAttribute CreateSimulationRestPointsAttr() const

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

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