Auto generates the attachment points and filtering ids based on the attributes defined in the API. More...
Inherits UsdAPISchemaBase.
Public Member Functions | |
PhysxSchemaPhysxAutoAttachmentAPI (const UsdPrim &prim=UsdPrim()) | |
Construct a PhysxSchemaPhysxAutoAttachmentAPI on UsdPrim prim . More... | |
PhysxSchemaPhysxAutoAttachmentAPI (const UsdSchemaBase &schemaObj) | |
Construct a PhysxSchemaPhysxAutoAttachmentAPI on the prim held by schemaObj . More... | |
virtual PHYSXSCHEMA_API | ~PhysxSchemaPhysxAutoAttachmentAPI () |
Destructor. More... | |
PHYSXSCHEMA_API UsdAttribute | GetEnableDeformableVertexAttachmentsAttr () const |
Enables attaching deformable mesh vertices which overlap with the other actor's volume. More... | |
PHYSXSCHEMA_API UsdAttribute | CreateEnableDeformableVertexAttachmentsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetEnableDeformableVertexAttachmentsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
PHYSXSCHEMA_API UsdAttribute | GetDeformableVertexOverlapOffsetAttr () const |
Deformable mesh vertices are attached if their distance to the other actor's volume is smaller than the offset. More... | |
PHYSXSCHEMA_API UsdAttribute | CreateDeformableVertexOverlapOffsetAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetDeformableVertexOverlapOffsetAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
PHYSXSCHEMA_API UsdAttribute | GetEnableRigidSurfaceAttachmentsAttr () const |
Enables sampling attachment points on the rigid actor's surface. More... | |
PHYSXSCHEMA_API UsdAttribute | CreateEnableRigidSurfaceAttachmentsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetEnableRigidSurfaceAttachmentsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
PHYSXSCHEMA_API UsdAttribute | GetRigidSurfaceSamplingDistanceAttr () const |
Attachment points on the rigid surface are positioned such that their typical neighbor distance matches the sampling distance. More... | |
PHYSXSCHEMA_API UsdAttribute | CreateRigidSurfaceSamplingDistanceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetRigidSurfaceSamplingDistanceAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
PHYSXSCHEMA_API UsdAttribute | GetEnableCollisionFilteringAttr () const |
Enables adding collision filtering in the vicinity of the attachment points. More... | |
PHYSXSCHEMA_API UsdAttribute | CreateEnableCollisionFilteringAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetEnableCollisionFilteringAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
PHYSXSCHEMA_API UsdAttribute | GetCollisionFilteringOffsetAttr () const |
Filering ids are generated for deformable mesh vertices if their distance to the other actor's volume is smaller than the offset. More... | |
PHYSXSCHEMA_API UsdAttribute | CreateCollisionFilteringOffsetAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetCollisionFilteringOffsetAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
PHYSXSCHEMA_API UsdAttribute | GetEnableDeformableFilteringPairsAttr () const |
Enables geometry pair based collision filtering for deformable-deformable attachments. More... | |
PHYSXSCHEMA_API UsdAttribute | CreateEnableDeformableFilteringPairsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetEnableDeformableFilteringPairsAttr(), 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 PhysxSchemaPhysxAutoAttachmentAPI | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a PhysxSchemaPhysxAutoAttachmentAPI holding the prim adhering to this schema at path on stage . More... | |
static PHYSXSCHEMA_API PhysxSchemaPhysxAutoAttachmentAPI | 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 |
Auto generates the attachment points and filtering ids based on the attributes defined in the API.
Definition at line 57 of file physxAutoAttachmentAPI.h.
|
inlineexplicit |
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
Definition at line 69 of file physxAutoAttachmentAPI.h.
|
inlineexplicit |
Construct a PhysxSchemaPhysxAutoAttachmentAPI on the prim held by schemaObj
.
Should be preferred over PhysxSchemaPhysxAutoAttachmentAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.
Definition at line 77 of file physxAutoAttachmentAPI.h.
|
virtual |
Destructor.
|
overrideprotected |
Returns the type of schema this class belongs to.
|
static |
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.
PHYSXSCHEMA_API UsdAttribute CreateCollisionFilteringOffsetAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetCollisionFilteringOffsetAttr(), 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 CreateDeformableVertexOverlapOffsetAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetDeformableVertexOverlapOffsetAttr(), 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 CreateEnableCollisionFilteringAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetEnableCollisionFilteringAttr(), 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 CreateEnableDeformableFilteringPairsAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetEnableDeformableFilteringPairsAttr(), 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 CreateEnableDeformableVertexAttachmentsAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetEnableDeformableVertexAttachmentsAttr(), 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 CreateEnableRigidSurfaceAttachmentsAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetEnableRigidSurfaceAttachmentsAttr(), 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 CreateRigidSurfaceSamplingDistanceAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetRigidSurfaceSamplingDistanceAttr(), 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 |
Return a PhysxSchemaPhysxAutoAttachmentAPI 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:
PHYSXSCHEMA_API UsdAttribute GetCollisionFilteringOffsetAttr | ( | ) | const |
Filering 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 |
PHYSXSCHEMA_API 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 |
PHYSXSCHEMA_API 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 |
PHYSXSCHEMA_API 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 |
PHYSXSCHEMA_API 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 |
PHYSXSCHEMA_API 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 |
PHYSXSCHEMA_API 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 |
|
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.
|
static |
Compile time constant representing what kind of schema this class is.
Definition at line 63 of file physxAutoAttachmentAPI.h.