usdrt::PhysxSchemaPhysxAutoAttachmentAPI

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

class PhysxSchemaPhysxAutoAttachmentAPI : public usdrt::UsdAPISchemaBase 

Auto generates the attachment points and filtering ids based on the attributes defined in the API.

Public Functions

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

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

inline virtual ~PhysxSchemaPhysxAutoAttachmentAPI(): Destructor.

inline UsdAttribute GetEnableDeformableVertexAttachmentsAttr() const

Enables attaching deformable mesh vertices which overlap with the other actor’s volume.


Declaration	`bool physxAutoAttachment:enableDeformableVertexAttachments = 1`
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

inline UsdAttribute CreateEnableDeformableVertexAttachmentsAttr() const: See GetEnableDeformableVertexAttachmentsAttr(), 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 UsdAttribute GetDeformableVertexOverlapOffsetAttr() const

Deformable mesh vertices are attached if their distance to the other actor’s volume is smaller than the offset. Range: [0, inf) Units: distance.


Declaration	`float physxAutoAttachment:deformableVertexOverlapOffset = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateDeformableVertexOverlapOffsetAttr() const: See GetDeformableVertexOverlapOffsetAttr(), 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 UsdAttribute GetEnableRigidSurfaceAttachmentsAttr() const

Enables sampling attachment points on the rigid actor’s surface.


Declaration	`bool physxAutoAttachment:enableRigidSurfaceAttachments = 0`
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

inline UsdAttribute CreateEnableRigidSurfaceAttachmentsAttr() const: See GetEnableRigidSurfaceAttachmentsAttr(), 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 UsdAttribute GetRigidSurfaceSamplingDistanceAttr() const

Attachment points on the rigid surface are positioned such that their typical neighbor distance matches the sampling distance. Use heuristic by default. Range: [0, inf) Units: distance.


Declaration	`float physxAutoAttachment:rigidSurfaceSamplingDistance = -inf`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateRigidSurfaceSamplingDistanceAttr() const: See GetRigidSurfaceSamplingDistanceAttr(), 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 UsdAttribute GetEnableCollisionFilteringAttr() const

Enables adding collision filtering in the vicinity of the attachment points.


Declaration	`bool physxAutoAttachment:enableCollisionFiltering = 1`
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

inline UsdAttribute CreateEnableCollisionFilteringAttr() const: See GetEnableCollisionFilteringAttr(), 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 UsdAttribute GetCollisionFilteringOffsetAttr() const

Filtering ids are generated for deformable mesh vertices if their distance to the other actor’s volume is smaller than the offset. Use heuristic by default. Range: [0, inf) Units: distance.


Declaration	`float physxAutoAttachment:collisionFilteringOffset = -inf`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateCollisionFilteringOffsetAttr() const: See GetCollisionFilteringOffsetAttr(), 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 UsdAttribute GetEnableDeformableFilteringPairsAttr() const

Enables geometry pair based collision filtering for deformable-deformable attachments. By default a filtered geometry of one actor is filtered against all geometries of the other actor.


Declaration	`bool physxAutoAttachment:enableDeformableFilteringPairs = 0`
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

inline UsdAttribute CreateEnableDeformableFilteringPairsAttr() const: See GetEnableDeformableFilteringPairsAttr(), 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.

UsdPrim GetPrim() const: Return this schema object’s held prim.

SdfPath GetPath() const: Return the SdfPath to this schema object’s held prim.

inline explicit operator bool() const

Check if this schema object is compatible with it’s held prim and that the prim is valid.

A typed schema object is compatible if the held prim’s type is or is a subtype of the schema’s type. Based on prim.IsA().

An API schema object is compatible if the API is of type SingleApplyAPI or UsdSchemaType::MultipleApplyAPI, and the schema has been applied to the prim. Based on prim.HasAPI.

This method invokes polymorphic behaviour.

See also

UsdSchemaBase::_IsCompatible()

Returns: True if the help prim is valid, and the schema object is compatible with its held prim.

Public Static Functions

static inline PhysxSchemaPhysxAutoAttachmentAPI Apply(const UsdPrim &prim)

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

inline virtual bool _IsCompatible() const

Check whether this APISchema object is valid for the currently held prim.

If this is an applied API schema, this returns true if the held prim is valid and already has the API schema applied to it, along with the instanceName (in the case of multiple-apply). The instanceName should not be empty in the case of a multiple-apply API schema.

This check is performed when clients invoke the explicit bool conversion operator, implemented in UsdSchemaBase.

See also

UsdPrim::HasAPI()

inline const TfToken _GetType() const

Helper for subclasses to get this schema’s type token.

Note

This diverges from Usd and returns a TfToken, since we don’t implements TfType.

Returns: The token representing the schema’s TfType.