usdrt::PhysxSchemaPhysxCollisionAPI

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

Functions

usdrt::PhysxSchemaPhysxCollisionAPI::Apply: Applies this single-apply API schema to the given prim . This information is stored by adding "PhysxCollisionAPI" to the token-valued, listOp metadata apiSchemas on the prim.
usdrt::PhysxSchemaPhysxCollisionAPI::CreateContactOffsetAttr: See GetContactOffsetAttr() , 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::PhysxSchemaPhysxCollisionAPI::CreateMinTorsionalPatchRadiusAttr: See GetMinTorsionalPatchRadiusAttr() , 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::PhysxSchemaPhysxCollisionAPI::CreateRestOffsetAttr: See GetRestOffsetAttr() , 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::PhysxSchemaPhysxCollisionAPI::CreateTorsionalPatchRadiusAttr: See GetTorsionalPatchRadiusAttr() , 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::PhysxSchemaPhysxCollisionAPI::GetContactOffsetAttr: Contact offset of a collision shape. Default value -inf means default is picked by the simulation based on the shape extent. Range: [maximum(0, restOffset), inf) Units: distance.
usdrt::PhysxSchemaPhysxCollisionAPI::GetMinTorsionalPatchRadiusAttr: Defines the minimum radius of the contact patch used to apply torsional friction. Range: [0, inf) Units: distance.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::PhysxSchemaPhysxCollisionAPI::GetRestOffsetAttr: Rest offset of a collision shape. Default value -inf means that the simulation sets a suitable value. For rigid bodies, this value is zero. Range: [0, contactOffset] Units: distance.
usdrt::PhysxSchemaPhysxCollisionAPI::GetTorsionalPatchRadiusAttr: Defines the radius of the contact patch used to apply torsional friction. Range: [0, inf) Units: distance.
usdrt::PhysxSchemaPhysxCollisionAPI::PhysxSchemaPhysxCollisionAPI: Construct a PhysxSchemaPhysxCollisionAPI on the prim held by schemaObj . Should be preferred over PhysxSchemaPhysxCollisionAPI (schemaObj.GetPrim()), as it preserves SchemaBase state.
usdrt::PhysxSchemaPhysxCollisionAPI::PhysxSchemaPhysxCollisionAPI: Construct a PhysxSchemaPhysxCollisionAPI on UsdPrim prim . Equivalent to PhysxSchemaPhysxCollisionAPI::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::PhysxSchemaPhysxCollisionAPI::operator bool: Boolean operator.
usdrt::PhysxSchemaPhysxCollisionAPI::~PhysxSchemaPhysxCollisionAPI: Destructor.

Variables

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

class PhysxSchemaPhysxCollisionAPI : public usdrt::UsdAPISchemaBase 

PhysX collision extended parameters.

Public Functions

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

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

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

Contact offset of a collision shape. Default value -inf means default is picked by the simulation based on the shape extent. Range: [maximum(0, restOffset), inf) Units: distance.


Declaration	`float physxCollision:contactOffset = -inf`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateContactOffsetAttr() const: See GetContactOffsetAttr(), 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 GetRestOffsetAttr() const

Rest offset of a collision shape. Default value -inf means that the simulation sets a suitable value. For rigid bodies, this value is zero. Range: [0, contactOffset] Units: distance.


Declaration	`float physxCollision:restOffset = -inf`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateRestOffsetAttr() const: See GetRestOffsetAttr(), 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 GetTorsionalPatchRadiusAttr() const

Defines the radius of the contact patch used to apply torsional friction. Range: [0, inf) Units: distance.


Declaration	`float physxCollision:torsionalPatchRadius = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateTorsionalPatchRadiusAttr() const: See GetTorsionalPatchRadiusAttr(), 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 GetMinTorsionalPatchRadiusAttr() const

Defines the minimum radius of the contact patch used to apply torsional friction. Range: [0, inf) Units: distance.


Declaration	`float physxCollision:minTorsionalPatchRadius = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateMinTorsionalPatchRadiusAttr() const: See GetMinTorsionalPatchRadiusAttr(), 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 PhysxSchemaPhysxCollisionAPI Apply(const UsdPrim &prim)

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