usdrt::PhysxSchemaPhysxTriggerStateAPI

Defined in usdrt/scenegraph/usd/physxSchema/physxTriggerStateAPI.h

Functions

usdrt::PhysxSchemaPhysxTriggerStateAPI::Apply: Applies this single-apply API schema to the given prim . This information is stored by adding "PhysxTriggerStateAPI" to the token-valued, listOp metadata apiSchemas on the prim.
usdrt::PhysxSchemaPhysxTriggerStateAPI::CreateTriggeredCollisionsRel: See GetTriggeredCollisionsRel() , and also Create vs Get Property Methods for when to use Get vs Create.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::PhysxSchemaPhysxTriggerStateAPI::GetTriggeredCollisionsRel: List of collisions that are currently triggered.
usdrt::PhysxSchemaPhysxTriggerStateAPI::PhysxSchemaPhysxTriggerStateAPI: Construct a PhysxSchemaPhysxTriggerStateAPI on the prim held by schemaObj . Should be preferred over PhysxSchemaPhysxTriggerStateAPI (schemaObj.GetPrim()), as it preserves SchemaBase state.
usdrt::PhysxSchemaPhysxTriggerStateAPI::PhysxSchemaPhysxTriggerStateAPI: Construct a PhysxSchemaPhysxTriggerStateAPI on UsdPrim prim . Equivalent to PhysxSchemaPhysxTriggerStateAPI::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::PhysxSchemaPhysxTriggerStateAPI::operator bool: Boolean operator.
usdrt::PhysxSchemaPhysxTriggerStateAPI::~PhysxSchemaPhysxTriggerStateAPI: Destructor.

Variables

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

class PhysxSchemaPhysxTriggerStateAPI : public usdrt::UsdAPISchemaBase 

PhysX trigger state.

Public Functions

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

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

inline virtual ~PhysxSchemaPhysxTriggerStateAPI(): 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 UsdRelationship GetTriggeredCollisionsRel() const: List of collisions that are currently triggered.

inline UsdRelationship CreateTriggeredCollisionsRel() const: See GetTriggeredCollisionsRel(), 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 PhysxSchemaPhysxTriggerStateAPI Apply(const UsdPrim &prim)

Applies this single-apply API schema to the given prim. This information is stored by adding “PhysxTriggerStateAPI” 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 PhysxSchemaPhysxTriggerStateAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxTriggerStateAPI 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.