 |
Defines a collision group for coarse filtering. More...
Inherits UsdTyped.
Public Member Functions | |
| UsdPhysicsCollisionGroup (const UsdPrim &prim=UsdPrim()) | |
Construct a UsdPhysicsCollisionGroup on UsdPrim prim . More... | |
| UsdPhysicsCollisionGroup (const UsdSchemaBase &schemaObj) | |
Construct a UsdPhysicsCollisionGroup on the prim held by schemaObj . More... | |
| virtual USDPHYSICS_API | ~UsdPhysicsCollisionGroup () |
| Destructor. More... | |
| USDPHYSICS_API UsdRelationship | GetFilteredGroupsRel () const |
| References a list of PhysicsCollisionGroups with which collisions should be ignored. More... | |
| USDPHYSICS_API UsdRelationship | CreateFilteredGroupsRel () const |
| See GetFilteredGroupsRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
| USDPHYSICS_API UsdCollectionAPI | GetCollidersCollectionAPI () const |
| Return the UsdCollectionAPI interface used for defining what colliders belong to the CollisionGroup. 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 UsdPhysicsCollisionGroup | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a UsdPhysicsCollisionGroup holding the prim adhering to this schema at path on stage. More... | |
| static USDPHYSICS_API UsdPhysicsCollisionGroup | Define (const UsdStagePtr &stage, const SdfPath &path) |
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage. More... | |
Static Public Attributes | |
| static const UsdSchemaType | schemaType = UsdSchemaType::ConcreteTyped |
| 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 |
Defines a collision group for coarse filtering.
When a collision occurs between two objects that have a PhysicsCollisionGroup assigned, they will collide with each other unless this PhysicsCollisionGroup pair is filtered. See filteredGroups attribute.
The user should apply a CollectionAPI:colliders to an instance of this class which maintains a list of PhysicsCollisionAPI rel-s that defines the members of this Collisiongroup.
Definition at line 67 of file collisionGroup.h.
|
inlineexplicit |
Construct a UsdPhysicsCollisionGroup on UsdPrim prim .
Equivalent to UsdPhysicsCollisionGroup::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim
Definition at line 79 of file collisionGroup.h.
|
inlineexplicit |
Construct a UsdPhysicsCollisionGroup on the prim held by schemaObj .
Should be preferred over UsdPhysicsCollisionGroup(schemaObj.GetPrim()), as it preserves SchemaBase state.
Definition at line 87 of file collisionGroup.h.
|
virtual |
Destructor.
|
overrideprotected |
Returns the type of schema this class belongs to.
| USDPHYSICS_API UsdRelationship CreateFilteredGroupsRel | ( | ) | const |
See GetFilteredGroupsRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.
|
static |
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.
If a prim adhering to this schema at path is already defined on this stage, return that prim. Otherwise author an SdfPrimSpec with specifier == SdfSpecifierDef and this schema's prim type name for the prim at path at the current EditTarget. Author SdfPrimSpec s with specifier == SdfSpecifierDef and empty typeName at the current EditTarget for any nonexistent, or existing but not Defined ancestors.
The given path must be an absolute prim path that does not contain any variant selections.
If it is impossible to author any of the necessary PrimSpecs, (for example, in case path cannot map to the current UsdEditTarget's namespace) issue an error and return an invalid UsdPrim.
Note that this method may return a defined prim whose typeName does not specify this schema class, in case a stronger typeName opinion overrides the opinion at the current EditTarget.
|
static |
Return a UsdPhysicsCollisionGroup 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 UsdCollectionAPI GetCollidersCollectionAPI | ( | ) | const |
Return the UsdCollectionAPI interface used for defining what colliders belong to the CollisionGroup.
| USDPHYSICS_API UsdRelationship GetFilteredGroupsRel | ( | ) | const |
References a list of PhysicsCollisionGroups with which collisions should be ignored.
|
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.
|
static |
Compile time constant representing what kind of schema this class is.
Definition at line 73 of file collisionGroup.h.
1.8.5 
