usdrt::PhysxSchemaPhysxVehicleDriveStandardAPI

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

Functions

Variables

class PhysxSchemaPhysxVehicleDriveStandardAPI : public usdrt::UsdAPISchemaBase

Standard drive model for a PhysX vehicle. The available drive torque will be split equally between all the wheels that are marked as driven (see PhysxVehicleMultiWheelDifferentialAPI or deprecated attribute “driven” in PhysxVehicleWheelAttachmentAPI) unless the torque distributon is configured explicitly (see PhysxVehicleMultiWheelDifferentialAPI for details).

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

Public Functions

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

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

inline explicit PhysxSchemaPhysxVehicleDriveStandardAPI(const UsdSchemaBase &schemaObj)

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

inline virtual ~PhysxSchemaPhysxVehicleDriveStandardAPI()

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 UsdRelationship GetEngineRel() const

A relationship to a PhysxVehicleEngineAPI prim that describes the engine.

Note: either this relationship has to be specified or the prim must have PhysxVehicleEngineAPI applied (none or both of the two is invalid).

inline UsdRelationship CreateEngineRel() const

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

inline UsdRelationship GetGearsRel() const

A relationship to a PhysxVehicleGearsAPI prim that describes the gears.

Note: either this relationship has to be specified or the prim must have PhysxVehicleGearsAPI applied (none or both of the two is invalid).

inline UsdRelationship CreateGearsRel() const

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

inline UsdRelationship GetAutoGearBoxRel() const

A relationship to a PhysxVehicleAutoGearBoxAPI prim that describes the automatic gear shift box. This relationship is optional and should be omitted if no automatic gear shift is desired. It is also possible to apply PhysxVehicleAutoGearBoxAPI to the prim directly. In that case the relationship must not be defined.

inline UsdRelationship CreateAutoGearBoxRel() const

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

inline UsdRelationship GetClutchRel() const

A relationship to a PhysxVehicleClutchAPI prim that describes the clutch.

Note: either this relationship has to be specified or the prim must have PhysxVehicleClutchAPI applied (none or both of the two is invalid).

inline UsdRelationship CreateClutchRel() const

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

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