usdrt::PhysxSchemaPhysxVehicleAutoGearBoxAPI

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

Functions

Variables

class PhysxSchemaPhysxVehicleAutoGearBoxAPI : public usdrt::UsdAPISchemaBase

Properties of the PhysX vehicle automatic gear shift box. If the automatic gear shift box 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 automatic gear shift box setup, PhysxVehicleAutoGearBoxAPI can be applied to a separate prim which can be linked to (see PhysxVehicleDriveStandardAPI).

Public Functions

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

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

inline explicit PhysxSchemaPhysxVehicleAutoGearBoxAPI(const UsdSchemaBase &schemaObj)

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

inline virtual ~PhysxSchemaPhysxVehicleAutoGearBoxAPI()

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

Value of normalized engine speed (engineRotationSpeed / maxRotationSpeed) that is high enough to increment gear. The first entry is for first gear and then up to the second highest gear. When (engineRotationSpeed / maxRotationSpeed) > upRatios[currentGear] the autobox will begin a transition to currentGear+1 unless currentGear is the highest possible gear or neutral or reverse.

Note: if not defined, the following values will be used: [0.65, 0.65, 0.65, 0.65].

Declaration

float[] physxVehicleAutoGearBox:upRatios

C++ Type

VtArray<float>

Usd Type

SdfValueTypeNames->FloatArray

inline UsdAttribute CreateUpRatiosAttr() const

See GetUpRatiosAttr(), 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 GetDownRatiosAttr() const

Value of normalized engine speed (engineRotationSpeed / maxRotationSpeed) that is low enough to decrement gear. The first entry is for second gear then up to the highest gear. When (engineRotationSpeed / maxRotationSpeed) < downRatios[currentGear] the autobox will begin a transition to currentGear-1 unless currentGear is first gear or neutral or reverse.

Note: if not defined, the following values will be used: [0.5, 0.5, 0.5, 0.5].

Declaration

float[] physxVehicleAutoGearBox:downRatios

C++ Type

VtArray<float>

Usd Type

SdfValueTypeNames->FloatArray

inline UsdAttribute CreateDownRatiosAttr() const

See GetDownRatiosAttr(), 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 GetLatencyAttr() const

The latency time of the automatic gear shift box (units: seconds). This is the minimum time that must pass between each gear change that is initiated by the automatic gear shift box.

Note: if not defined, the value 2.0 will be used.

Declaration

float physxVehicleAutoGearBox:latency

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateLatencyAttr() const

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

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