PhysxSchemaPhysxTriggerStateAPI Class Reference

PhysX trigger state. More...

Inherits UsdAPISchemaBase.

Public Member Functions
	PhysxSchemaPhysxTriggerStateAPI (const UsdPrim &prim=UsdPrim())
	Construct a PhysxSchemaPhysxTriggerStateAPI on UsdPrim prim . More...
	PhysxSchemaPhysxTriggerStateAPI (const UsdSchemaBase &schemaObj)
	Construct a PhysxSchemaPhysxTriggerStateAPI on the prim held by schemaObj . More...
virtual PHYSXSCHEMA_API	~PhysxSchemaPhysxTriggerStateAPI ()
	Destructor. More...
PHYSXSCHEMA_API UsdRelationship	GetTriggeredCollisionsRel () const
	List of collisions that are currently triggered. More...
PHYSXSCHEMA_API UsdRelationship	CreateTriggeredCollisionsRel () const
	See GetTriggeredCollisionsRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

Static Public Member Functions
static PHYSXSCHEMA_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 PHYSXSCHEMA_API PhysxSchemaPhysxTriggerStateAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxTriggerStateAPI holding the prim adhering to this schema at path on stage. More...
static PHYSXSCHEMA_API PhysxSchemaPhysxTriggerStateAPI	Apply (const UsdPrim &prim)
	Applies this single-apply API schema to the given prim. More...

Static Public Attributes
static const UsdSchemaType	schemaType = UsdSchemaType::SingleApplyAPI
	Compile time constant representing what kind of schema this class is. More...

Protected Member Functions
PHYSXSCHEMA_API UsdSchemaType	_GetSchemaType () const override
	Returns the type of schema this class belongs to. More...

Friends
class	UsdSchemaRegistry

Detailed Description

PhysX trigger state.

Definition at line 57 of file physxTriggerStateAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxTriggerStateAPI ( const UsdPrim &  prim = UsdPrim() )

inlineexplicit

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

Definition at line 69 of file physxTriggerStateAPI.h.

PhysxSchemaPhysxTriggerStateAPI ( const UsdSchemaBase &  schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxTriggerStateAPI on the prim held by schemaObj .

Should be preferred over PhysxSchemaPhysxTriggerStateAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 77 of file physxTriggerStateAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxTriggerStateAPI ( )

virtual

Destructor.

Member Function Documentation

PHYSXSCHEMA_API UsdSchemaType _GetSchemaType ( ) const

overrideprotected

Returns the type of schema this class belongs to.

See Also

UsdSchemaType

static PHYSXSCHEMA_API PhysxSchemaPhysxTriggerStateAPI Apply ( const UsdPrim &  prim )

static

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.

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.

See Also

UsdPrim::GetAppliedSchemas()

UsdPrim::HasAPI()

UsdPrim::ApplyAPI()

UsdPrim::RemoveAPI()

PHYSXSCHEMA_API UsdRelationship CreateTriggeredCollisionsRel

(

)

const

See GetTriggeredCollisionsRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.

static PHYSXSCHEMA_API PhysxSchemaPhysxTriggerStateAPI Get ( const UsdStagePtr &  stage, const SdfPath &  path  )

static

Return a PhysxSchemaPhysxTriggerStateAPI 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:

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

static PHYSXSCHEMA_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.

PHYSXSCHEMA_API UsdRelationship GetTriggeredCollisionsRel

(

)

const

List of collisions that are currently triggered.

Member Data Documentation

const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI

static

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

See Also

UsdSchemaType

Definition at line 63 of file physxTriggerStateAPI.h.

---

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

• W:/919a5455eee1e83c/src/physxSchema/physxTriggerStateAPI.h