usdrt::UsdPhysicsCollisionAPI

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

Functions

usdrt::UsdPhysicsCollisionAPI::Apply: Applies this single-apply API schema to the given prim . This information is stored by adding "PhysicsCollisionAPI" to the token-valued, listOp metadata apiSchemas on the prim.
usdrt::UsdPhysicsCollisionAPI::CreateCollisionEnabledAttr: See GetCollisionEnabledAttr() , 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::UsdPhysicsCollisionAPI::CreateSimulationOwnerRel: See GetSimulationOwnerRel() , and also Create vs Get Property Methods for when to use Get vs Create.
usdrt::UsdPhysicsCollisionAPI::GetCollisionEnabledAttr: Determines if the PhysicsCollisionAPI is enabled.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::UsdPhysicsCollisionAPI::GetSimulationOwnerRel: Single PhysicsScene that will simulate this collider. By default this object belongs to the first PhysicsScene. Note that if a RigidBodyAPI in the hierarchy above has a different simulationOwner then it has a precedence over this relationship.
usdrt::UsdPhysicsCollisionAPI::UsdPhysicsCollisionAPI: Construct a UsdPhysicsCollisionAPI on the prim held by schemaObj . Should be preferred over UsdPhysicsCollisionAPI (schemaObj.GetPrim()), as it preserves SchemaBase state.
usdrt::UsdPhysicsCollisionAPI::UsdPhysicsCollisionAPI: Construct a UsdPhysicsCollisionAPI on UsdPrim prim . Equivalent to UsdPhysicsCollisionAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim .
usdrt::DestructionSchemaDestructibleBaseAPI::_GetInstanceName: Returns the instance name of the API schema object belonging to a multiple-apply API schema.
usdrt::UsdPhysicsCollisionAPI::operator bool: Boolean operator.
usdrt::UsdPhysicsCollisionAPI::~UsdPhysicsCollisionAPI: Destructor.

Variables

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

class UsdPhysicsCollisionAPI : public usdrt::UsdAPISchemaBase 

Applies collision attributes to a UsdGeomXformable prim. If a simulation is running, this geometry will collide with other geometries that have PhysicsCollisionAPI applied. If a prim in the parent hierarchy has the RigidBodyAPI applied, this collider is a part of that body. If there is no body in the parent hierarchy, this collider is considered to be static.

Public Functions

inline explicit UsdPhysicsCollisionAPI(const UsdPrim &prim = UsdPrim()): Construct a UsdPhysicsCollisionAPI on UsdPrim prim. Equivalent to UsdPhysicsCollisionAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim.

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

inline virtual ~UsdPhysicsCollisionAPI(): Destructor.

inline operator bool() const

Boolean operator.

Returns: Return true if the contained prim is has this api schema applied using HasAPI, and false otherwise.

inline UsdAttribute GetCollisionEnabledAttr() const

Determines if the PhysicsCollisionAPI is enabled.


Declaration	`bool physics:collisionEnabled = 1`
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

inline UsdAttribute CreateCollisionEnabledAttr() const: See GetCollisionEnabledAttr(), 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 GetSimulationOwnerRel() const: Single PhysicsScene that will simulate this collider. By default this object belongs to the first PhysicsScene. Note that if a RigidBodyAPI in the hierarchy above has a different simulationOwner then it has a precedence over this relationship.

inline UsdRelationship CreateSimulationOwnerRel() const: See GetSimulationOwnerRel(), 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 UsdPhysicsCollisionAPI Apply(const UsdPrim &prim)

Applies this single-apply API schema to the given prim. This information is stored by adding “PhysicsCollisionAPI” to the token-valued, listOp metadata apiSchemas on the prim.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

Returns: A valid UsdPhysicsCollisionAPI object is returned upon success. An invalid (or empty) UsdPhysicsCollisionAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.

Public Static Attributes

static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI 

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

See also

UsdSchemaType

Protected Functions

inline const TfToken &_GetInstanceName() const

Returns the instance name of the API schema object belonging to a multiple-apply API schema.

The returned instance name will be empty for non-applied and single-apply API schemas.