API to describe fine-grained filtering. More...

Inherits UsdAPISchemaBase.

Public Member Functions
	UsdPhysicsFilteredPairsAPI (const UsdPrim &prim=UsdPrim())
	Construct a UsdPhysicsFilteredPairsAPI on UsdPrim `prim` . More...

	UsdPhysicsFilteredPairsAPI (const UsdSchemaBase &schemaObj)
	Construct a UsdPhysicsFilteredPairsAPI on the prim held by `schemaObj` . More...

virtual USDPHYSICS_API	~UsdPhysicsFilteredPairsAPI ()
	Destructor. More...

USDPHYSICS_API UsdRelationship	GetFilteredPairsRel () const
	Relationship to objects that should be filtered. More...

USDPHYSICS_API UsdRelationship	CreateFilteredPairsRel () const
	See GetFilteredPairsRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

Static Public Member Functions
static USDPHYSICS_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
	Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More...

static USDPHYSICS_API UsdPhysicsFilteredPairsAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a UsdPhysicsFilteredPairsAPI holding the prim adhering to this schema at `path` on `stage`. More...

static USDPHYSICS_API UsdPhysicsFilteredPairsAPI	Apply (const UsdPrim &prim)
	Applies this single-apply API schema to the given `prim`. More...

Static Public Attributes
static const UsdSchemaType	schemaType = UsdSchemaType::SingleApplyAPI
	Compile time constant representing what kind of schema this class is. More...

Protected Member Functions
USDPHYSICS_API UsdSchemaType	_GetSchemaType () const override
	Returns the type of schema this class belongs to. More...

Friends
class	UsdSchemaRegistry

Detailed Description

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.

Definition at line 62 of file filteredPairsAPI.h.

Constructor & Destructor Documentation

UsdPhysicsFilteredPairsAPI ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

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

Definition at line 74 of file filteredPairsAPI.h.

UsdPhysicsFilteredPairsAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a UsdPhysicsFilteredPairsAPI on the prim held by schemaObj .

Should be preferred over UsdPhysicsFilteredPairsAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 82 of file filteredPairsAPI.h.

virtual USDPHYSICS_API ~UsdPhysicsFilteredPairsAPI ( )

virtual

Destructor.

Member Function Documentation

USDPHYSICS_API UsdSchemaType _GetSchemaType ( ) const

overrideprotected

Returns the type of schema this class belongs to.

See Also: UsdSchemaType

static USDPHYSICS_API UsdPhysicsFilteredPairsAPI Apply ( const UsdPrim & prim )

static

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.

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.

See Also: UsdPrim::GetAppliedSchemas(); UsdPrim::HasAPI(); UsdPrim::ApplyAPI(); UsdPrim::RemoveAPI()

USDPHYSICS_API UsdRelationship CreateFilteredPairsRel ( ) const

See GetFilteredPairsRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.

static USDPHYSICS_API UsdPhysicsFilteredPairsAPI Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

static

Return a UsdPhysicsFilteredPairsAPI holding the prim adhering to this schema at path on stage.

If no prim exists at path on stage, or if the prim at that path does not adhere to this schema, return an invalid schema object. This is shorthand for the following:

* UsdPhysicsFilteredPairsAPI(stage->GetPrimAtPath(path));

*

USDPHYSICS_API UsdRelationship GetFilteredPairsRel ( ) const

Relationship to objects that should be filtered.

static USDPHYSICS_API const TfTokenVector& GetSchemaAttributeNames ( bool includeInherited = true )

static

Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.

Does not include attributes that may be authored by custom/extended methods of the schemas involved.

Member Data Documentation

const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI

static

Compile time constant representing what kind of schema this class is.

See Also: UsdSchemaType

Definition at line 68 of file filteredPairsAPI.h.

The documentation for this class was generated from the following file:

W:/919a5455eee1e83c/src/usdPhysics/filteredPairsAPI.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation