usdrt::PhysxSchemaPhysxVehicleWheelAPI

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

Functions

• usdrt::PhysxSchemaPhysxVehicleWheelAPI::Apply: Applies this single-apply API schema to the given prim . This information is stored by adding "PhysxVehicleWheelAPI" to the token-valued, listOp metadata apiSchemas on the prim.

• usdrt::PhysxSchemaPhysxVehicleWheelAPI::CreateDampingRateAttr: See GetDampingRateAttr() , 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 .

• usdrt::PhysxSchemaPhysxVehicleWheelAPI::CreateMassAttr: See GetMassAttr() , 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 .

• usdrt::PhysxSchemaPhysxVehicleWheelAPI::CreateMaxBrakeTorqueAttr: See GetMaxBrakeTorqueAttr() , 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 .

• usdrt::PhysxSchemaPhysxVehicleWheelAPI::CreateMaxHandBrakeTorqueAttr: See GetMaxHandBrakeTorqueAttr() , 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 .

• usdrt::PhysxSchemaPhysxVehicleWheelAPI::CreateMaxSteerAngleAttr: See GetMaxSteerAngleAttr() , 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 .

• usdrt::PhysxSchemaPhysxVehicleWheelAPI::CreateMoiAttr: See GetMoiAttr() , 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 .

• usdrt::PhysxSchemaPhysxVehicleWheelAPI::CreateRadiusAttr: See GetRadiusAttr() , 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 .

• usdrt::PhysxSchemaPhysxVehicleWheelAPI::CreateToeAngleAttr: See GetToeAngleAttr() , 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 .

• usdrt::PhysxSchemaPhysxVehicleWheelAPI::CreateWidthAttr: See GetWidthAttr() , 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 .

• usdrt::PhysxSchemaPhysxVehicleWheelAPI::GetDampingRateAttr: The damping rate applied to the wheel (units: torque * seconds = mass * distance * distance / seconds).

• usdrt::PhysxSchemaPhysxVehicleWheelAPI::GetMassAttr: The mass of the wheel (metal wheel plus tire).

• usdrt::PhysxSchemaPhysxVehicleWheelAPI::GetMaxBrakeTorqueAttr: Deprecated. Please use PhysxVehicleBrakesAPI instead.

• usdrt::PhysxSchemaPhysxVehicleWheelAPI::GetMaxHandBrakeTorqueAttr: Deprecated. Please use PhysxVehicleBrakesAPI instead.

• usdrt::PhysxSchemaPhysxVehicleWheelAPI::GetMaxSteerAngleAttr: Deprecated. Please use PhysxVehicleSteeringAPI instead.

• usdrt::PhysxSchemaPhysxVehicleWheelAPI::GetMoiAttr: The moment of inertia (metal wheel plus tire) about the rolling axis (units: mass * distance * distance).

• usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.

• usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.

• usdrt::PhysxSchemaPhysxVehicleWheelAPI::GetRadiusAttr: The radius of the wheel (metal wheel plus tire).

• usdrt::PhysxSchemaPhysxVehicleWheelAPI::GetToeAngleAttr: Deprecated. Please use PhysxVehicleSuspensionComplianceAPI instead.

• usdrt::PhysxSchemaPhysxVehicleWheelAPI::GetWidthAttr: The width of the wheel (metal wheel plus tire).

• usdrt::PhysxSchemaPhysxVehicleWheelAPI::PhysxSchemaPhysxVehicleWheelAPI: Construct a PhysxSchemaPhysxVehicleWheelAPI on UsdPrim prim . Equivalent to PhysxSchemaPhysxVehicleWheelAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim .

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

• usdrt::DestructionSchemaDestructibleBaseAPI::_GetInstanceName: Returns the instance name of the API schema object belonging to a multiple-apply API schema.

• usdrt::PhysxSchemaPhysxVehicleWheelAPI::operator bool: Boolean operator.

• usdrt::PhysxSchemaPhysxVehicleWheelAPI::~PhysxSchemaPhysxVehicleWheelAPI: Destructor.

Variables

• usdrt::PhysxSchemaPhysxVehicleWheelAPI::schemaType: Compile time constant representing what kind of schema this class is.

class PhysxSchemaPhysxVehicleWheelAPI : public usdrt::UsdAPISchemaBase

Properties of a PhysX vehicle wheel. If the wheel setup does not need to be shared among vehicle instances, it can be applied to the prim which has PhysxVehicleWheelAttachmentAPI applied. If the intent is to share the wheel setup, PhysxVehicleWheelAPI can be applied to a separate prim which can be linked to (see PhysxVehicleWheelAttachmentAPI).

Public Functions

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

Construct a PhysxSchemaPhysxVehicleWheelAPI on UsdPrim prim. Equivalent to PhysxSchemaPhysxVehicleWheelAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim.

inline explicit PhysxSchemaPhysxVehicleWheelAPI(const UsdSchemaBase &schemaObj)

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

inline virtual ~PhysxSchemaPhysxVehicleWheelAPI()

Destructor.

inline operator bool() const

Boolean operator.

Returns

Return true if the contained prim is has this api schema applied using HasAPI, and false otherwise.

inline UsdAttribute GetRadiusAttr() const

The radius of the wheel (metal wheel plus tire).

Note: this attribute has to be specified (there is no default).

Declaration	float physxVehicleWheel:radius
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateRadiusAttr() const

See GetRadiusAttr(), 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 GetWidthAttr() const

The width of the wheel (metal wheel plus tire).

Note: this attribute has to be specified (there is no default).

Declaration	float physxVehicleWheel:width
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateWidthAttr() const

See GetWidthAttr(), 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 GetMassAttr() const

The mass of the wheel (metal wheel plus tire).

Note: this attribute has to be specified (there is no default).

Declaration	float physxVehicleWheel:mass
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateMassAttr() const

See GetMassAttr(), 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 GetMoiAttr() const

The moment of inertia (metal wheel plus tire) about the rolling axis (units: mass * distance * distance).

Note: this attribute has to be specified (there is no default).

Declaration	float physxVehicleWheel:moi
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateMoiAttr() const

See GetMoiAttr(), 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 GetDampingRateAttr() const

The damping rate applied to the wheel (units: torque * seconds = mass * distance * distance / seconds).

Note: this attribute has to be specified (there is no default).

Declaration	float physxVehicleWheel:dampingRate
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateDampingRateAttr() const

See GetDampingRateAttr(), 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 GetMaxBrakeTorqueAttr() const

Deprecated. Please use PhysxVehicleBrakesAPI instead.

The maximum brake torque that can be applied to the wheel (units: mass * distance * distance / seconds / seconds).

Note: will be ignored if PhysxVehicleBrakesAPI is used.

Declaration	float physxVehicleWheel:maxBrakeTorque
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateMaxBrakeTorqueAttr() const

See GetMaxBrakeTorqueAttr(), 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 GetMaxHandBrakeTorqueAttr() const

Deprecated. Please use PhysxVehicleBrakesAPI instead.

The maximum hand brake torque that can be applied to the wheel (units: mass * distance * distance / seconds / seconds).

Note: will be ignored if PhysxVehicleBrakesAPI is used.

Declaration	float physxVehicleWheel:maxHandBrakeTorque
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateMaxHandBrakeTorqueAttr() const

See GetMaxHandBrakeTorqueAttr(), 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 GetMaxSteerAngleAttr() const

Deprecated. Please use PhysxVehicleSteeringAPI instead.

The maximum steer angle (in radians) that can be achieved by the wheel.

Note: will be ignored if PhysxVehicleSteeringAPI is used.

Declaration	float physxVehicleWheel:maxSteerAngle
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateMaxSteerAngleAttr() const

See GetMaxSteerAngleAttr(), 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 GetToeAngleAttr() const

Deprecated. Please use PhysxVehicleSuspensionComplianceAPI instead.

The wheel toe angle (in radians).

Note: currently, this attribute is only considered for vehicles using the PhysxVehicleDriveStandard drive type.

Note: will be ignored if PhysxVehicleSuspensionComplianceAPI is used.

Declaration	float physxVehicleWheel:toeAngle
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateToeAngleAttr() const

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

Public Static Functions

static inline PhysxSchemaPhysxVehicleWheelAPI Apply(const UsdPrim &prim)

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