usdrt::PhysxSchemaPhysxVehicleTireFrictionTable

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

Functions

Variables

class PhysxSchemaPhysxVehicleTireFrictionTable : public usdrt::UsdTyped

Table defining the friction values of a tire against a given set of ground materials.

Public Functions

inline explicit PhysxSchemaPhysxVehicleTireFrictionTable(const UsdPrim &prim = UsdPrim())

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.

inline explicit PhysxSchemaPhysxVehicleTireFrictionTable(const UsdSchemaBase &schemaObj)

Construct a PhysxSchemaPhysxVehicleTireFrictionTable on the prim held by schemaObj . Should be preferred over PhysxSchemaPhysxVehicleTireFrictionTable(schemaObj.GetPrim()), as it preserves SchemaBase state.

inline virtual ~PhysxSchemaPhysxVehicleTireFrictionTable()

Destructor.

inline operator bool() const

Boolean operator.

Returns

Return true if the contained prim is an instance of this schema using IsA, and false otherwise.

inline 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

inline UsdAttribute CreateFrictionValuesAttr() const

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

inline UsdAttribute CreateDefaultFrictionValueAttr() const

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

inline UsdRelationship CreateGroundMaterialsRel() const

See GetGroundMaterialsRel(), and also Create vs Get Property Methods for when to use Get vs Create.

UsdPrim GetPrim() const

Return this schema object’s held prim.

SdfPath GetPath() const

Return the SdfPath to this schema object’s held prim.

Public Static Functions

static inline PhysxSchemaPhysxVehicleTireFrictionTable Define(const UsdStageRefPtr &stage, const SdfPath &path)

Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.

Public Static Attributes

static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped

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

See also

UsdSchemaType