 |
Table defining the friction values of a tire against a given set of ground materials. More...
Inherits UsdTyped.
Public Member Functions | |
| PhysxSchemaPhysxVehicleTireFrictionTable (const UsdPrim &prim=UsdPrim()) | |
Construct a PhysxSchemaPhysxVehicleTireFrictionTable on UsdPrim prim . More... | |
| PhysxSchemaPhysxVehicleTireFrictionTable (const UsdSchemaBase &schemaObj) | |
Construct a PhysxSchemaPhysxVehicleTireFrictionTable on the prim held by schemaObj . More... | |
| virtual PHYSXSCHEMA_API | ~PhysxSchemaPhysxVehicleTireFrictionTable () |
| Destructor. More... | |
| PHYSXSCHEMA_API UsdAttribute | GetFrictionValuesAttr () const |
| The friction values to use for the tire against the ground materials listed under groundMaterials. More... | |
| PHYSXSCHEMA_API UsdAttribute | CreateFrictionValuesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
| See GetFrictionValuesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
| PHYSXSCHEMA_API UsdAttribute | GetDefaultFrictionValueAttr () const |
| The friction value to use for the tire against the ground if the material of the ground surface is not among the materials listed in groundMaterials. More... | |
| PHYSXSCHEMA_API UsdAttribute | CreateDefaultFrictionValueAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
| See GetDefaultFrictionValueAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
| PHYSXSCHEMA_API UsdRelationship | GetGroundMaterialsRel () const |
| Relationships to Material instances that have PhysicsMaterialAPI applied. More... | |
| PHYSXSCHEMA_API UsdRelationship | CreateGroundMaterialsRel () const |
| See GetGroundMaterialsRel(), 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 PhysxSchemaPhysxVehicleTireFrictionTable | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a PhysxSchemaPhysxVehicleTireFrictionTable holding the prim adhering to this schema at path on stage. More... | |
| static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleTireFrictionTable | Define (const UsdStagePtr &stage, const SdfPath &path) |
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage. More... | |
Static Public Attributes | |
| static const UsdSchemaType | schemaType = UsdSchemaType::ConcreteTyped |
| 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 |
Table defining the friction values of a tire against a given set of ground materials.
Definition at line 57 of file physxVehicleTireFrictionTable.h.
|
inlineexplicit |
Construct a PhysxSchemaPhysxVehicleTireFrictionTable on UsdPrim prim .
Equivalent to PhysxSchemaPhysxVehicleTireFrictionTable::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 physxVehicleTireFrictionTable.h.
|
inlineexplicit |
Construct a PhysxSchemaPhysxVehicleTireFrictionTable on the prim held by schemaObj .
Should be preferred over PhysxSchemaPhysxVehicleTireFrictionTable(schemaObj.GetPrim()), as it preserves SchemaBase state.
Definition at line 77 of file physxVehicleTireFrictionTable.h.
|
virtual |
Destructor.
|
overrideprotected |
Returns the type of schema this class belongs to.
| PHYSXSCHEMA_API UsdAttribute CreateDefaultFrictionValueAttr | ( | VtValue const & | defaultValue = VtValue(), |
| bool | writeSparsely = false |
||
| ) | const |
See GetDefaultFrictionValueAttr(), 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 CreateFrictionValuesAttr | ( | VtValue const & | defaultValue = VtValue(), |
| bool | writeSparsely = false |
||
| ) | const |
See GetFrictionValuesAttr(), 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 UsdRelationship CreateGroundMaterialsRel | ( | ) | const |
See GetGroundMaterialsRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.
|
static |
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.
If a prim adhering to this schema at path is already defined on this stage, return that prim. Otherwise author an SdfPrimSpec with specifier == SdfSpecifierDef and this schema's prim type name for the prim at path at the current EditTarget. Author SdfPrimSpec s with specifier == SdfSpecifierDef and empty typeName at the current EditTarget for any nonexistent, or existing but not Defined ancestors.
The given path must be an absolute prim path that does not contain any variant selections.
If it is impossible to author any of the necessary PrimSpecs, (for example, in case path cannot map to the current UsdEditTarget's namespace) issue an error and return an invalid UsdPrim.
Note that this method may return a defined prim whose typeName does not specify this schema class, in case a stronger typeName opinion overrides the opinion at the current EditTarget.
|
static |
Return a PhysxSchemaPhysxVehicleTireFrictionTable 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 GetDefaultFrictionValueAttr | ( | ) | const |
The friction value to use for the tire against the ground if the material of the ground surface is not among the materials listed in groundMaterials.
The value has to be greater or equal 0.
| Declaration | float defaultFrictionValue = 1 |
| C++ Type | float |
| Usd Type | SdfValueTypeNames->Float |
| PHYSXSCHEMA_API UsdAttribute GetFrictionValuesAttr | ( | ) | const |
The friction values to use for the tire against the ground materials listed under groundMaterials.
The array needs to have the same size as the list of materials specified in groundMaterials.
| Declaration | float[] frictionValues |
| C++ Type | VtArray<float> |
| Usd Type | SdfValueTypeNames->FloatArray |
| PHYSXSCHEMA_API UsdRelationship GetGroundMaterialsRel | ( | ) | const |
Relationships to Material instances that have PhysicsMaterialAPI applied.
For each material, a friction value has to be specified in the frictionValues attribute. If a material is encountered that has not been listed, the value declared in defaultFrictionValue will be used.
|
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 physxVehicleTireFrictionTable.h.
1.8.5 
