PhysX collision extended parameters. More...

Inherits UsdAPISchemaBase.

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

	PhysxSchemaPhysxCollisionAPI (const UsdSchemaBase &schemaObj)
	Construct a PhysxSchemaPhysxCollisionAPI on the prim held by `schemaObj` . More...

virtual PHYSXSCHEMA_API	~PhysxSchemaPhysxCollisionAPI ()
	Destructor. More...

PHYSXSCHEMA_API UsdAttribute	GetContactOffsetAttr () const
	Contact offset of a collision shape. More...

PHYSXSCHEMA_API UsdAttribute	CreateContactOffsetAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetContactOffsetAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetRestOffsetAttr () const
	Rest offset of a collision shape. More...

PHYSXSCHEMA_API UsdAttribute	CreateRestOffsetAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetRestOffsetAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetTorsionalPatchRadiusAttr () const
	Defines the radius of the contact patch used to apply torsional friction. More...

PHYSXSCHEMA_API UsdAttribute	CreateTorsionalPatchRadiusAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetTorsionalPatchRadiusAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetMinTorsionalPatchRadiusAttr () const
	Defines the minimum radius of the contact patch used to apply torsional friction. More...

PHYSXSCHEMA_API UsdAttribute	CreateMinTorsionalPatchRadiusAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetMinTorsionalPatchRadiusAttr(), 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 PhysxSchemaPhysxCollisionAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxCollisionAPI holding the prim adhering to this schema at `path` on `stage`. More...

static PHYSXSCHEMA_API bool	CanApply (const UsdPrim &prim, std::string *whyNot=nullptr)
	Returns true if this single-apply API schema can be applied to the given `prim`. More...

static PHYSXSCHEMA_API PhysxSchemaPhysxCollisionAPI	Apply (const UsdPrim &prim)
	Applies this single-apply API schema to the given `prim`. More...

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

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

Friends
class	UsdSchemaRegistry

Detailed Description

PhysX collision extended parameters.

Definition at line 57 of file physxCollisionAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxCollisionAPI ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxCollisionAPI on UsdPrim prim .

Equivalent to PhysxSchemaPhysxCollisionAPI::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 physxCollisionAPI.h.

PhysxSchemaPhysxCollisionAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxCollisionAPI on the prim held by schemaObj .

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

Definition at line 77 of file physxCollisionAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxCollisionAPI ( )

virtual

Destructor.

Member Function Documentation

PHYSXSCHEMA_API UsdSchemaKind _GetSchemaKind ( ) const

overrideprotected

Returns the kind of schema this class belongs to.

See Also: UsdSchemaKind

static PHYSXSCHEMA_API PhysxSchemaPhysxCollisionAPI Apply ( const UsdPrim & prim )

static

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

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

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

See Also: UsdPrim::GetAppliedSchemas(); UsdPrim::HasAPI(); UsdPrim::CanApplyAPI(); UsdPrim::ApplyAPI(); UsdPrim::RemoveAPI()

static PHYSXSCHEMA_API bool CanApply	(	const UsdPrim &	prim,
		std::string *	whyNot = `nullptr`
	)

static

Returns true if this single-apply API schema can be applied to the given prim.

If this schema can not be a applied to the prim, this returns false and, if provided, populates whyNot with the reason it can not be applied.

Note that if CanApply returns false, that does not necessarily imply that calling Apply will fail. Callers are expected to call CanApply before calling Apply if they want to ensure that it is valid to apply a schema.

See Also: UsdPrim::GetAppliedSchemas(); UsdPrim::HasAPI(); UsdPrim::CanApplyAPI(); UsdPrim::ApplyAPI(); UsdPrim::RemoveAPI()

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

See GetContactOffsetAttr(), 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.

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

See GetMinTorsionalPatchRadiusAttr(), 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.

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

See GetRestOffsetAttr(), 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.

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

See GetTorsionalPatchRadiusAttr(), 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 PhysxSchemaPhysxCollisionAPI Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

static

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

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

*

PHYSXSCHEMA_API UsdAttribute GetContactOffsetAttr ( ) const

Contact offset of a collision shape.

Default value -inf means default is picked by the simulation based on the shape extent. Range: [maximum(0, restOffset), inf) Units: distance


Declaration	`float physxCollision:contactOffset = -inf`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetMinTorsionalPatchRadiusAttr ( ) const

Defines the minimum radius of the contact patch used to apply torsional friction.

Range: [0, inf) Units: distance


Declaration	`float physxCollision:minTorsionalPatchRadius = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetRestOffsetAttr ( ) const

Rest offset of a collision shape.

Default value -inf means that the simulation sets a suitable value. For rigid bodies, this value is zero. Range: [0, contactOffset] Units: distance


Declaration	`float physxCollision:restOffset = -inf`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

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 GetTorsionalPatchRadiusAttr ( ) const

Defines the radius of the contact patch used to apply torsional friction.

Range: [0, inf) Units: distance


Declaration	`float physxCollision:torsionalPatchRadius = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

Member Data Documentation

const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI

static

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

See Also: UsdSchemaKind

Definition at line 63 of file physxCollisionAPI.h.

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

C:/g/19412595/omni/schema/source/physxSchema/physxCollisionAPI.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