HDK
|
#include <filteredPairsAPI.h>
Static Public Member Functions | |
static USDPHYSICS_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
static USDPHYSICS_API UsdPhysicsFilteredPairsAPI | Get (const UsdStagePtr &stage, const SdfPath &path) |
static USDPHYSICS_API bool | CanApply (const UsdPrim &prim, std::string *whyNot=nullptr) |
static USDPHYSICS_API UsdPhysicsFilteredPairsAPI | Apply (const UsdPrim &prim) |
Static Public Member Functions inherited from UsdAPISchemaBase | |
static USD_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Static Public Member Functions inherited from UsdSchemaBase | |
static const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Static Public Attributes | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::SingleApplyAPI |
Static Public Attributes inherited from UsdAPISchemaBase | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
Static Public Attributes inherited from UsdSchemaBase | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
Protected Member Functions | |
USDPHYSICS_API UsdSchemaKind | _GetSchemaKind () const override |
Protected Member Functions inherited from UsdAPISchemaBase | |
UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName) | |
UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName) | |
const TfToken & | _GetInstanceName () const |
USD_API bool | _IsCompatible () const override |
Protected Member Functions inherited from UsdSchemaBase | |
virtual UsdSchemaKind | _GetSchemaType () const |
const TfType & | _GetType () const |
USD_API UsdAttribute | _CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const |
Friends | |
class | UsdSchemaRegistry |
Additional Inherited Members | |
Static Protected Member Functions inherited from UsdAPISchemaBase | |
static USD_API TfTokenVector | _GetMultipleApplyInstanceNames (const UsdPrim &prim, const TfType &schemaType) |
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.
|
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.
|
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 |
Destructor.
|
overrideprotectedvirtual |
Returns the kind of schema this class belongs to.
Reimplemented from UsdAPISchemaBase.
|
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.
|
static |
Returns true if this single-apply API schema can be applied to the given prim
. If this schema can not be a applied to the prim, this returns false and, if provided, populates whyNot
with the reason it can not be applied.
Note that if CanApply returns false, that does not necessarily imply that calling Apply will fail. Callers are expected to call CanApply before calling Apply if they want to ensure that it is valid to apply a schema.
USDPHYSICS_API UsdRelationship UsdPhysicsFilteredPairsAPI::CreateFilteredPairsRel | ( | ) | const |
See GetFilteredPairsRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create
|
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:
USDPHYSICS_API UsdRelationship UsdPhysicsFilteredPairsAPI::GetFilteredPairsRel | ( | ) | const |
Relationship to objects that should be filtered.
|
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.
|
friend |
Definition at line 160 of file filteredPairsAPI.h.
|
static |
Compile time constant representing what kind of schema this class is.
Definition at line 68 of file filteredPairsAPI.h.