usdrt::PhysxSchemaPhysxVehicleClutchAPI

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

Functions

Variables

class PhysxSchemaPhysxVehicleClutchAPI : public usdrt::UsdAPISchemaBase

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

Public Functions

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

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

inline explicit PhysxSchemaPhysxVehicleClutchAPI(const UsdSchemaBase &schemaObj)

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

inline virtual ~PhysxSchemaPhysxVehicleClutchAPI()

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

Strength of clutch (units: torque * seconds = mass * distance * distance / seconds). The value has to be positive. The clutch is the mechanism that couples the engine to the wheels. A stronger clutch more strongly couples the engine to the wheels, while a clutch of strength zero completely decouples the engine from the wheels. Stronger clutches more quickly bring the wheels and engine into equilibrium, while weaker clutches take longer, resulting in periods of clutch slip and delays in power transmission from the engine to the wheels. The torque generated by the clutch is proportional to the clutch strength and the velocity difference between the engine’s rotational speed and the rotational speed of the driven wheels after accounting for the gear ratio. The torque at the clutch is applied negatively to the engine and positively to the driven wheels.

Note: if not defined, the value 10.0 will be used. This default value is in meter length scale and kilograms and will get adjusted if other units are used.

Declaration

float physxVehicleClutch:strength

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateStrengthAttr() const

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

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