usdrt::PhysxSchemaPhysxContactReportAPI

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

Functions

usdrt::PhysxSchemaPhysxContactReportAPI::Apply: Applies this single-apply API schema to the given prim . This information is stored by adding "PhysxContactReportAPI" to the token-valued, listOp metadata apiSchemas on the prim.
usdrt::PhysxSchemaPhysxContactReportAPI::CreateReportPairsRel: See GetReportPairsRel() , and also Create vs Get Property Methods for when to use Get vs Create.
usdrt::PhysxSchemaPhysxContactReportAPI::CreateThresholdAttr: See GetThresholdAttr() , 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::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::PhysxSchemaPhysxContactReportAPI::GetReportPairsRel: Relationship to objects. If in contact with these objects, contact reports will be sent. If relationship not set or list empty all contacts are reported.
usdrt::PhysxSchemaPhysxContactReportAPI::GetThresholdAttr: Sets the force threshold for contact reports. Range: [0, inf] Units: force = mass * distance / seconds^2.
usdrt::PhysxSchemaPhysxContactReportAPI::PhysxSchemaPhysxContactReportAPI: Construct a PhysxSchemaPhysxContactReportAPI on the prim held by schemaObj . Should be preferred over PhysxSchemaPhysxContactReportAPI (schemaObj.GetPrim()), as it preserves SchemaBase state.
usdrt::PhysxSchemaPhysxContactReportAPI::PhysxSchemaPhysxContactReportAPI: Construct a PhysxSchemaPhysxContactReportAPI on UsdPrim prim . Equivalent to PhysxSchemaPhysxContactReportAPI::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::PhysxSchemaPhysxContactReportAPI::operator bool: Boolean operator.
usdrt::PhysxSchemaPhysxContactReportAPI::~PhysxSchemaPhysxContactReportAPI: Destructor.

Variables

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

class PhysxSchemaPhysxContactReportAPI : public usdrt::UsdAPISchemaBase 

Enables contact reporting for a rigid body or articulation.

Public Functions

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

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

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

Sets the force threshold for contact reports. Range: [0, inf] Units: force = mass * distance / seconds^2.


Declaration	`float physxContactReport:threshold = 1`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateThresholdAttr() const: See GetThresholdAttr(), 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 GetReportPairsRel() const: Relationship to objects. If in contact with these objects, contact reports will be sent. If relationship not set or list empty all contacts are reported.

inline UsdRelationship CreateReportPairsRel() const: See GetReportPairsRel(), 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 PhysxSchemaPhysxContactReportAPI Apply(const UsdPrim &prim)

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