usdrt::PhysxSchemaPhysxVehicleTankControllerAPI

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

Functions

Variables

class PhysxSchemaPhysxVehicleTankControllerAPI : public usdrt::UsdAPISchemaBase

PhysX vehicle tank controller to divert torque from the engine to the wheels of the tracks of a wheel based tank vehicle (see PhysxVehicleTankDifferentialAPI). Note that the “accelerator” attribute of PhysxVehicleControllerAPI still drives the engine torque whereas the thrust controls introduced here define how that torque gets diverted to the wheels, so both controls need to be used to drive a wheel based tank vehicle usually. This API schema has to be applied to a prim with PhysxVehicleAPI applied. Can only be used for vehicles that have a standard drive and a tank differential defined (see PhysxVehicleDriveStandardAPI, PhysxVehicleTankDifferentialAPI).

Public Functions

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

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

inline explicit PhysxSchemaPhysxVehicleTankControllerAPI(const UsdSchemaBase &schemaObj)

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

inline virtual ~PhysxSchemaPhysxVehicleTankControllerAPI()

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

Magnitude of thrust to apply to the tracks that are assigned to thrust control 0. Values have to be in [-1.0, 1.0] with the sign dictating whether the thrust will be applied positively or negatively with respect to the gearing ratio.

Declaration

float physxVehicleTankController:thrust0 = 0

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateThrust0Attr() const

See GetThrust0Attr(), 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 GetThrust1Attr() const

Magnitude of thrust to apply to the tracks that are assigned to thrust control 1. Values have to be in [-1.0, 1.0] with the sign dictating whether the thrust will be applied positively or negatively with respect to the gearing ratio.

Declaration

float physxVehicleTankController:thrust1 = 0

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateThrust1Attr() const

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

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