PhysxSchemaPhysxContactReportAPI Class Reference

Enables contact reporting for a rigid body or articulation. More...

Inherits UsdAPISchemaBase.

Public Member Functions
	PhysxSchemaPhysxContactReportAPI (const UsdPrim &prim=UsdPrim())
	Construct a PhysxSchemaPhysxContactReportAPI on UsdPrim prim . More...
	PhysxSchemaPhysxContactReportAPI (const UsdSchemaBase &schemaObj)
	Construct a PhysxSchemaPhysxContactReportAPI on the prim held by schemaObj . More...
virtual PHYSXSCHEMA_API	~PhysxSchemaPhysxContactReportAPI ()
	Destructor. More...
PHYSXSCHEMA_API UsdAttribute	GetThresholdAttr () const
	Sets the force threshold for contact reports. More...
PHYSXSCHEMA_API UsdAttribute	CreateThresholdAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetThresholdAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdRelationship	GetReportPairsRel () const
	Relationship to objects. More...
PHYSXSCHEMA_API UsdRelationship	CreateReportPairsRel () const
	See GetReportPairsRel(), 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 PhysxSchemaPhysxContactReportAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxContactReportAPI holding the prim adhering to this schema at path on stage. More...
static PHYSXSCHEMA_API PhysxSchemaPhysxContactReportAPI	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

Enables contact reporting for a rigid body or articulation.

Definition at line 57 of file physxContactReportAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxContactReportAPI ( const UsdPrim &  prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxContactReportAPI on UsdPrim prim .

Equivalent to PhysxSchemaPhysxContactReportAPI::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 physxContactReportAPI.h.

PhysxSchemaPhysxContactReportAPI ( const UsdSchemaBase &  schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxContactReportAPI on the prim held by schemaObj .

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

Definition at line 77 of file physxContactReportAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxContactReportAPI ( )

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 PhysxSchemaPhysxContactReportAPI Apply ( const UsdPrim &  prim )

static

Applies this single-apply API schema to the given prim.

This information is stored by adding "PhysxContactReportAPI" to the token-valued, listOp metadata apiSchemas on the prim.

Returns

A valid PhysxSchemaPhysxContactReportAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxContactReportAPI 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 CreateReportPairsRel

(

)

const

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

PHYSXSCHEMA_API UsdAttribute CreateThresholdAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetThresholdAttr(), and also Usd_Create_Or_Get_Property 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.

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

static

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

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

PHYSXSCHEMA_API UsdRelationship GetReportPairsRel

(

)

const

Relationship to objects.

If in contact with these objects, contact reports will be sent. If relationship not set or list empty all contacts are reported.

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 UsdAttribute GetThresholdAttr

(

)

const

Sets the force threshold for contact reports.

Range: [0, inf] Units: force = mass * distance / seconds^2

Declaration	float physxContactReport:threshold = 1
C++ Type	float
Usd Type	SdfValueTypeNames->Float

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 physxContactReportAPI.h.

---

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

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