usdrt::PhysxSchemaPhysxVehicleTankDifferentialAPI

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

Functions

Variables

class PhysxSchemaPhysxVehicleTankDifferentialAPI : public usdrt::UsdAPISchemaBase

Differential to set up a wheeled tank vehicle. Describes which wheels of a vehicle are part of the tank tracks. The wheels in each tank track have a constraint applied to them to enforce the rule that they all have the same longitudinal speed at the contact point between the wheel and the tank track. Driven wheels that are not part of a tank track receive the torque split specified in physxVehicleMultiWheelDifferential:torqueRatios. Has to be applied to a prim with PhysxVehicleAPI applied. Can only be used for vehicles that have a standard drive (see PhysxVehicleDriveStandardAPI).

Public Functions

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

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

inline explicit PhysxSchemaPhysxVehicleTankDifferentialAPI(const UsdSchemaBase &schemaObj)

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

inline virtual ~PhysxSchemaPhysxVehicleTankDifferentialAPI()

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

For each track, this array holds the number of wheels assigned to that track. A track needs at least 2 wheels assigned.

Declaration

int[] physxVehicleTankDifferential:numberOfWheelsPerTrack

C++ Type

VtArray<int>

Usd Type

SdfValueTypeNames->IntArray

inline UsdAttribute CreateNumberOfWheelsPerTrackAttr() const

See GetNumberOfWheelsPerTrackAttr(), 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 GetThrustIndexPerTrackAttr() const

For each track, this array holds the index of the thrust control (0 or 1, see PhysxVehicleTankControllerAPI) that drives the track. The length of the array needs to match the length of the “numberOfWheelsPerTrack” array.

Declaration

int[] physxVehicleTankDifferential:thrustIndexPerTrack

C++ Type

VtArray<int>

Usd Type

SdfValueTypeNames->IntArray

inline UsdAttribute CreateThrustIndexPerTrackAttr() const

See GetThrustIndexPerTrackAttr(), 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 GetTrackToWheelIndicesAttr() const

For each track, this array holds the start index of the list describing the wheels that are assigned to that track (e.g., the list of wheel indices assigned to the track with index 2 starts at: wheelIndicesInTrackOrder[trackToWheelIndices[2]]). The length of the array needs to match the length of the “numberOfWheelsPerTrack” array.

Declaration

int[] physxVehicleTankDifferential:trackToWheelIndices

C++ Type

VtArray<int>

Usd Type

SdfValueTypeNames->IntArray

inline UsdAttribute CreateTrackToWheelIndicesAttr() const

See GetTrackToWheelIndicesAttr(), 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 GetWheelIndicesInTrackOrderAttr() const

The wheels (identified by wheel attachment indices, see attribtue “index” of PhysxVehicleWheelAttachmentAPI) assigned to track 0, followed by the wheels assigned to track 1 and so on. The length of the array will match the number of wheels that are assigned to tracks.

Declaration

int[] physxVehicleTankDifferential:wheelIndicesInTrackOrder

C++ Type

VtArray<int>

Usd Type

SdfValueTypeNames->IntArray

inline UsdAttribute CreateWheelIndicesInTrackOrderAttr() const

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

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