Defines a collision group for coarse filtering. More...

Inheritance diagram for UsdPhysicsCollisionGroup:

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 Create vs Get Property Methods 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...

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

	UsdTyped (const UsdSchemaBase &schemaObj)
	Construct a UsdTyped on the prim wrapped by `schemaObj` . More...

Public Member Functions inherited from UsdSchemaBase
bool	IsConcrete () const
	Returns whether or not this class corresponds to a concrete instantiable prim type in scene description. More...

bool	IsTyped () const
	Returns whether or not this class inherits from UsdTyped. More...

bool	IsAPISchema () const
	Returns whether this is an API schema or not. More...

bool	IsAppliedAPISchema () const
	Returns whether this is an applied API schema or not. More...

bool	IsMultipleApplyAPISchema () const
	Returns whether this is an applied API schema or not. More...

UsdSchemaKind	GetSchemaKind () const
	Returns the kind of schema this class is. More...

USD_API	UsdSchemaBase (const UsdPrim &prim=UsdPrim())
	Construct and store `prim` as the held prim. More...

USD_API	UsdSchemaBase (const UsdSchemaBase &otherSchema)
	Construct and store for the same prim held by `otherSchema`. More...

virtual USD_API	~UsdSchemaBase ()
	Destructor. More...

USD_API	operator bool () const

UsdPrim	GetPrim () const
	Return this schema object's held prim. More...

SdfPath	GetPath () const
	Shorthand for GetPrim()->GetPath(). More...

USD_API const UsdPrimDefinition *	GetSchemaClassPrimDefinition () const
	Return the prim definition associated with this schema instance if one exists, otherwise return null. 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 Member Functions inherited from UsdTyped
static 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 USD_API UsdTyped	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a UsdTyped holding the prim adhering to this schema at `path` on `stage`. More...

Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::ConcreteTyped
	Compile time constant representing what kind of schema this class is. More...

Static Public Attributes inherited from UsdTyped
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
	Compile time constant representing what kind of schema this class is. More...

Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
	Compile time constant representing what kind of schema this class is. More...

Protected Member Functions
USDPHYSICS_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to. More...

Protected Member Functions inherited from UsdTyped
USD_API bool	_IsCompatible () const override
	Subclasses may override _IsCompatible to do specific compatibility checking with the given prim, such as type compatibility or value compatibility. More...

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

Detailed Description

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.

Definition at line 66 of file collisionGroup.h.

Constructor & Destructor Documentation

UsdPhysicsCollisionGroup ( const UsdPrim & prim = UsdPrim() )

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 78 of file collisionGroup.h.

UsdPhysicsCollisionGroup ( const UsdSchemaBase & schemaObj )

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 86 of file collisionGroup.h.

virtual USDPHYSICS_API ~UsdPhysicsCollisionGroup ( )

virtual

Destructor.

Member Function Documentation

USDPHYSICS_API UsdSchemaKind _GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also: UsdSchemaKind

Reimplemented from UsdSchemaBase.

USDPHYSICS_API UsdRelationship CreateFilteredGroupsRel ( ) const

See GetFilteredGroupsRel(), and also Create vs Get Property Methods for when to use Get vs Create.

static USDPHYSICS_API UsdPhysicsCollisionGroup Define	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

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 USDPHYSICS_API UsdPhysicsCollisionGroup Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

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:

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

*

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 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 UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped

static

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

See Also: UsdSchemaKind

Definition at line 72 of file collisionGroup.h.

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

pxr/usd/usdPhysics/collisionGroup.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