usdrt::UsdPhysicsCollisionGroup

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

Functions

usdrt::UsdPhysicsCollisionGroup::CreateFilteredGroupsRel: See GetFilteredGroupsRel() , and also Create vs Get Property Methods for when to use Get vs Create.
usdrt::UsdPhysicsCollisionGroup::CreateInvertFilteredGroupsAttr: See GetInvertFilteredGroupsAttr() , 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::UsdPhysicsCollisionGroup::CreateMergeGroupNameAttr: See GetMergeGroupNameAttr() , 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::UsdPhysicsCollisionGroup::Define: Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.
usdrt::UsdPhysicsCollisionGroup::GetFilteredGroupsRel: References a list of PhysicsCollisionGroups with which collisions should be ignored.
usdrt::UsdPhysicsCollisionGroup::GetInvertFilteredGroupsAttr: Normally, the filter will disable collisions against the selected filter groups. However, if this option is set, the filter will disable collisions against all colliders except for those in the selected filter groups.
usdrt::UsdPhysicsCollisionGroup::GetMergeGroupNameAttr: If non-empty, any collision groups in a stage with a matching mergeGroup should be considered to refer to the same collection. Matching collision groups should behave as if there were a single group containing referenced colliders and filter groups from both collections.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::UsdPhysicsCollisionGroup::UsdPhysicsCollisionGroup: 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 .
usdrt::UsdPhysicsCollisionGroup::UsdPhysicsCollisionGroup: Construct a UsdPhysicsCollisionGroup on the prim held by schemaObj . Should be preferred over UsdPhysicsCollisionGroup (schemaObj.GetPrim()), as it preserves SchemaBase state.
usdrt::UsdPhysicsCollisionGroup::operator bool: Boolean operator.
usdrt::UsdPhysicsCollisionGroup::~UsdPhysicsCollisionGroup: Destructor.

Variables

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

class UsdPhysicsCollisionGroup : public usdrt::UsdTyped 

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.

A CollectionAPI:colliders maintains a list of PhysicsCollisionAPI rel-s that defines the members of this Collisiongroup.

Public Functions

inline explicit UsdPhysicsCollisionGroup(const UsdPrim &prim = UsdPrim()): 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.

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

inline virtual ~UsdPhysicsCollisionGroup(): Destructor.

inline operator bool() const

Boolean operator.

Returns: Return true if the contained prim is an instance of this schema using IsA, and false otherwise.

inline UsdAttribute GetMergeGroupNameAttr() const

If non-empty, any collision groups in a stage with a matching mergeGroup should be considered to refer to the same collection. Matching collision groups should behave as if there were a single group containing referenced colliders and filter groups from both collections.


Declaration	`string physics:mergeGroup`
C++ Type	std::string
Usd Type	SdfValueTypeNames->String

inline UsdAttribute CreateMergeGroupNameAttr() const: See GetMergeGroupNameAttr(), 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 UsdAttribute GetInvertFilteredGroupsAttr() const

Normally, the filter will disable collisions against the selected filter groups. However, if this option is set, the filter will disable collisions against all colliders except for those in the selected filter groups.


Declaration	`bool physics:invertFilteredGroups`
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

inline UsdAttribute CreateInvertFilteredGroupsAttr() const: See GetInvertFilteredGroupsAttr(), 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 GetFilteredGroupsRel() const: References a list of PhysicsCollisionGroups with which collisions should be ignored.

inline UsdRelationship CreateFilteredGroupsRel() const: See GetFilteredGroupsRel(), 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 UsdPhysicsCollisionGroup Define(const UsdStageRefPtr &stage, const SdfPath &path): Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.

Public Static Attributes

static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped 

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