usdrt::PhysxSchemaPhysxVehicleSuspensionComplianceAPI

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

Functions

Variables

class PhysxSchemaPhysxVehicleSuspensionComplianceAPI : public usdrt::UsdAPISchemaBase

Compliance describes how toe and camber angle and force application points are affected by suspension compression. Each compliance term is in the form of a graph with up to 3 points. The points in the graph consist of a normalized jounce value (with 0 meaning fully elongated and 1 fully compressed suspension) and a corresponding compliance value (which can be an angle or point etc. depending on the specific compliance term). The sequence of points must respresent monotonically increasing values of normalized jounce. The actual compliance value will be computed by linear interpolation based on the current normalized jounce. If any graph has zero points in it, a value of 0.0 is used for the compliance value. If any graph has 1 point in it, the compliance value of that point is used directly. This API schema has to be applied to a prim with PhysxVehicleWheelAttachmentAPI applied. If defined, then this setup takes precedence over the deprecated attributes suspensionForceAppPointOffset and tireForceAppPointOffset of the PhysxVehicleWheelAttachmentAPI API schema, the deprecated attributes camberAtRest, camberAtMaxCompression, camberAtMaxDroop of the PhysxVehicleSuspensionAPI API schema as well as the deprecated attribute toeAngle of the PhysxVehicleWheelAPI API schema.

Public Functions

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

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

inline explicit PhysxSchemaPhysxVehicleSuspensionComplianceAPI(const UsdSchemaBase &schemaObj)

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

inline virtual ~PhysxSchemaPhysxVehicleSuspensionComplianceAPI()

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 GetWheelToeAngleAttr() const

A graph of toe angle against normalized jounce with the toe angle expressed in radians in the range [-pi, pi]. See the class documentation for general info about the nature of these graphs and the data requirements.

Note: the toe angle is applied in the suspension frame (see PhysxVehicleWheelAttachmentAPI).

Declaration

float2[] physxVehicleSuspensionCompliance:wheelToeAngle

C++ Type

VtArray<GfVec2f>

Usd Type

SdfValueTypeNames->Float2Array

inline UsdAttribute CreateWheelToeAngleAttr() const

See GetWheelToeAngleAttr(), 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 GetWheelCamberAngleAttr() const

A graph of camber angle against normalized jounce with the camber angle expressed in radians in the range [-pi, pi]. See the class documentation for general info about the nature of these graphs and the data requirements.

Note: the camber angle is applied in the suspension frame (see PhysxVehicleWheelAttachmentAPI).

Declaration

float2[] physxVehicleSuspensionCompliance:wheelCamberAngle

C++ Type

VtArray<GfVec2f>

Usd Type

SdfValueTypeNames->Float2Array

inline UsdAttribute CreateWheelCamberAngleAttr() const

See GetWheelCamberAngleAttr(), 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 GetSuspensionForceAppPointAttr() const

Suspension forces are applied at an offset from the suspension frame (see PhysxVehicleWheelAttachmentAPI). An entry in this array defines this offset for a given normalized jounce value (which is the first element in the float4 while the other 3 elements are used to store the x, y, z coordinates of the offset). See the class documentation for general info about the nature of these compliance terms and the data requirements.

Declaration

float4[] physxVehicleSuspensionCompliance:suspensionForceAppPoint

C++ Type

VtArray<GfVec4f>

Usd Type

SdfValueTypeNames->Float4Array

inline UsdAttribute CreateSuspensionForceAppPointAttr() const

See GetSuspensionForceAppPointAttr(), 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 GetTireForceAppPointAttr() const

Tire forces are applied at an offset from the suspension frame (see PhysxVehicleWheelAttachmentAPI). An entry in this array defines this offset for a given normalized jounce value (which is the first element in the float4 while the other 3 elements are used to store the x, y, z coordinates of the offset). See the class documentation for general info about the nature of these compliance terms and the data requirements.

Declaration

float4[] physxVehicleSuspensionCompliance:tireForceAppPoint

C++ Type

VtArray<GfVec4f>

Usd Type

SdfValueTypeNames->Float4Array

inline UsdAttribute CreateTireForceAppPointAttr() const

See GetTireForceAppPointAttr(), 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 PhysxSchemaPhysxVehicleSuspensionComplianceAPI Apply(const UsdPrim &prim)

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