usdrt::UsdPhysicsFilteredPairsAPI

Defined in usdrt/scenegraph/usd/usdPhysics/filteredPairsAPI.h

Functions

usdrt::UsdPhysicsFilteredPairsAPI::Apply: Applies this single-apply API schema to the given prim . This information is stored by adding "PhysicsFilteredPairsAPI" to the token-valued, listOp metadata apiSchemas on the prim.
usdrt::UsdPhysicsFilteredPairsAPI::CreateFilteredPairsRel: See GetFilteredPairsRel() , and also Create vs Get Property Methods for when to use Get vs Create.
usdrt::UsdPhysicsFilteredPairsAPI::GetFilteredPairsRel: Relationship to objects that should be filtered.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::UsdPhysicsFilteredPairsAPI::UsdPhysicsFilteredPairsAPI: Construct a UsdPhysicsFilteredPairsAPI on UsdPrim prim . Equivalent to UsdPhysicsFilteredPairsAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim .
usdrt::UsdPhysicsFilteredPairsAPI::UsdPhysicsFilteredPairsAPI: Construct a UsdPhysicsFilteredPairsAPI on the prim held by schemaObj . Should be preferred over UsdPhysicsFilteredPairsAPI (schemaObj.GetPrim()), as it preserves SchemaBase state.
usdrt::DestructionSchemaDestructibleBaseAPI::_GetInstanceName: Returns the instance name of the API schema object belonging to a multiple-apply API schema.
usdrt::UsdPhysicsFilteredPairsAPI::operator bool: Boolean operator.
usdrt::UsdPhysicsFilteredPairsAPI::~UsdPhysicsFilteredPairsAPI: Destructor.

Variables

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

class UsdPhysicsFilteredPairsAPI : public usdrt::UsdAPISchemaBase 

API to describe fine-grained filtering. If a collision between two objects occurs, this pair might be filtered if the pair is defined through this API. This API can be applied either to a body or collision or even articulation. The “filteredPairs” defines what objects it should not collide against. Note that FilteredPairsAPI filtering has precedence over CollisionGroup filtering.

Public Functions

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

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

inline virtual ~UsdPhysicsFilteredPairsAPI(): 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 UsdRelationship GetFilteredPairsRel() const: Relationship to objects that should be filtered.

inline UsdRelationship CreateFilteredPairsRel() const: See GetFilteredPairsRel(), 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 UsdPhysicsFilteredPairsAPI Apply(const UsdPrim &prim)

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