usdrt::PhysxSchemaPhysxVehicleSteeringAPI

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

Functions

Variables

class PhysxSchemaPhysxVehicleSteeringAPI : public usdrt::UsdAPISchemaBase

Describes a steering system for a vehicle by specifying which wheels are connected to the steer control and by defining the maximum steer angle for those wheels (see PhysxVehicleControllerAPI for the steer control). This API schema has to be applied to a prim with PhysxVehicleAPI applied. Can only be used for vehicles that have a drive (see PhysxVehicleDriveBasicAPI or PhysxVehicleDriveStandardAPI).

Public Functions

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

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

inline explicit PhysxSchemaPhysxVehicleSteeringAPI(const UsdSchemaBase &schemaObj)

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

inline virtual ~PhysxSchemaPhysxVehicleSteeringAPI()

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

List of indices, referencing the wheels that are going to be steered. The indices refer to the attribute “index” of PhysxVehicleWheelAttachmentAPI. If not specified, every wheel will be affected by the steer control using an angle multiplier of 1 (see attribute angleMultipliers).

Declaration

int[] physxVehicleSteering:wheels

C++ Type

VtArray<int>

Usd Type

SdfValueTypeNames->IntArray

inline UsdAttribute CreateWheelsAttr() const

See GetWheelsAttr(), 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 GetMaxSteerAngleAttr() const

The maximum steer angle (in radians) that can be achieved by the wheels. Has to be in range [-pi, pi] when multiplied by the attribute angleMultipliers. The steer angle of wheels[i] will be defined by maxSteerAngle * angleMultipliers[i] * physxVehicleController:steer (see PhysxVehicleControllerAPI).

Declaration

float physxVehicleSteering:maxSteerAngle = 0

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateMaxSteerAngleAttr() const

See GetMaxSteerAngleAttr(), 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 GetAngleMultipliersAttr() const

Allows to adjust the max steer angle for each wheel that is steered. The values are unitless multipliers. See maxSteerAngle for how these multipliers affect the steer angle of a wheel. If the attribute is defined, then the length of the array needs to match the length of the “wheels” array. If the attribute is not defined, a multiplier value of 1 will be used for all steered wheels.

Declaration

float[] physxVehicleSteering:angleMultipliers

C++ Type

VtArray<float>

Usd Type

SdfValueTypeNames->FloatArray

inline UsdAttribute CreateAngleMultipliersAttr() const

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

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