|
HDK
|
#include <meshCollisionAPI.h>
Inheritance diagram for UsdPhysicsMeshCollisionAPI:Static Public Member Functions | |
| static USDPHYSICS_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
| static USDPHYSICS_API UsdPhysicsMeshCollisionAPI | Get (const UsdStagePtr &stage, const SdfPath &path) |
| static USDPHYSICS_API bool | CanApply (const UsdPrim &prim, std::string *whyNot=nullptr) |
| static USDPHYSICS_API UsdPhysicsMeshCollisionAPI | Apply (const UsdPrim &prim) |
| Static Public Member Functions inherited from UsdAPISchemaBase | |
| static USD_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
| Static Public Member Functions inherited from UsdSchemaBase | |
| static const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Static Public Attributes | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::SingleApplyAPI |
| Static Public Attributes inherited from UsdAPISchemaBase | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
| Static Public Attributes inherited from UsdSchemaBase | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
Protected Member Functions | |
| USDPHYSICS_API UsdSchemaKind | _GetSchemaKind () const override |
| Protected Member Functions inherited from UsdAPISchemaBase | |
| UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName) | |
| UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName) | |
| const TfToken & | _GetInstanceName () const |
| USD_API bool | _IsCompatible () const override |
| Protected Member Functions inherited from UsdSchemaBase | |
| virtual UsdSchemaKind | _GetSchemaType () const |
| const TfType & | _GetType () const |
| USD_API UsdAttribute | _CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const |
Friends | |
| class | UsdSchemaRegistry |
Additional Inherited Members | |
| Static Protected Member Functions inherited from UsdAPISchemaBase | |
| static USD_API TfTokenVector | _GetMultipleApplyInstanceNames (const UsdPrim &prim, const TfType &schemaType) |
Attributes to control how a Mesh is made into a collider. Can be applied to only a USDGeomMesh in addition to its PhysicsCollisionAPI.
For any described attribute Fallback Value or Allowed Values below that are text/tokens, the actual token is published and defined in UsdPhysicsTokens. So to set an attribute to the value "rightHanded", use UsdPhysicsTokens->rightHanded as the value.
Definition at line 64 of file meshCollisionAPI.h.
|
inlineexplicit |
Construct a UsdPhysicsMeshCollisionAPI on UsdPrim prim . Equivalent to UsdPhysicsMeshCollisionAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim
Definition at line 76 of file meshCollisionAPI.h.
|
inlineexplicit |
Construct a UsdPhysicsMeshCollisionAPI on the prim held by schemaObj . Should be preferred over UsdPhysicsMeshCollisionAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.
Definition at line 84 of file meshCollisionAPI.h.
|
virtual |
Destructor.
|
overrideprotectedvirtual |
Returns the kind of schema this class belongs to.
Reimplemented from UsdAPISchemaBase.
|
static |
Applies this single-apply API schema to the given prim. This information is stored by adding "PhysicsMeshCollisionAPI" to the token-valued, listOp metadata apiSchemas on the prim.
|
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.
| USDPHYSICS_API UsdAttribute UsdPhysicsMeshCollisionAPI::CreateApproximationAttr | ( | VtValue const & | defaultValue = VtValue(), |
| bool | writeSparsely = false |
||
| ) | const |
See GetApproximationAttr(), 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 UsdPhysicsMeshCollisionAPI 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:
| USDPHYSICS_API UsdAttribute UsdPhysicsMeshCollisionAPI::GetApproximationAttr | ( | ) | const |
Determines the mesh's collision approximation: "none" - The mesh geometry is used directly as a collider without any approximation. "convexDecomposition" - A convex mesh decomposition is performed. This results in a set of convex mesh colliders. "convexHull" - A convex hull of the mesh is generated and used as the collider. "boundingSphere" - A bounding sphere is computed around the mesh and used as a collider. "boundingCube" - An optimally fitting box collider is computed around the mesh. "meshSimplification" - A mesh simplification step is performed, resulting in a simplified triangle mesh collider.
| Declaration | uniform token physics:approximation = "none" |
| C++ Type | TfToken |
| Usd Type | SdfValueTypeNames->Token |
| Variability | SdfVariabilityUniform |
| Allowed Values | none, convexDecomposition, convexHull, boundingSphere, boundingCube, meshSimplification |
|
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.
|
friend |
Definition at line 162 of file meshCollisionAPI.h.
|
static |
Compile time constant representing what kind of schema this class is.
Definition at line 70 of file meshCollisionAPI.h.
1.8.6 
