usdrt::PhysxSchemaPhysxVehicleContextAPI

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

Functions

Variables

class PhysxSchemaPhysxVehicleContextAPI : public usdrt::UsdAPISchemaBase

PhysX vehicles general settings. Has to be applied to a PhysicsScene prim. For any described attribute Fallback Value or Allowed Values below that are text/tokens, the actual token is published and defined in PhysxSchemaTokens. So to set an attribute to the value “rightHanded”, use PhysxSchemaTokens->rightHanded as the value.

Public Functions

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

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

inline explicit PhysxSchemaPhysxVehicleContextAPI(const UsdSchemaBase &schemaObj)

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

inline virtual ~PhysxSchemaPhysxVehicleContextAPI()

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

The dynamics of the vehicle simulation can get applied to the PhysX rigid body by either applying an acceleration or by using a velocity delta.

Declaration

uniform token physxVehicleContext:updateMode = "velocityChange"

C++ Type

TfToken

Usd Type

SdfValueTypeNames->Token

Variability

SdfVariabilityUniform

Allowed Values

velocityChange, acceleration

inline UsdAttribute CreateUpdateModeAttr() const

See GetUpdateModeAttr(), 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 GetUpAxisAttr() const

Deprecated. Please use verticalAxis instead.

The normalized vector defining the general up direction to use for vehicles. Has to match one of the base axes (1,0,0), (0,1,0) etc. Arbitrary axes are not supported.

Note: will be ignored if verticalAxis is used.

Declaration

float3 physxVehicleContext:upAxis

C++ Type

GfVec3f

Usd Type

SdfValueTypeNames->Float3

inline UsdAttribute CreateUpAxisAttr() const

See GetUpAxisAttr(), 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 GetForwardAxisAttr() const

Deprecated. Please use longitudinalAxis instead.

The normalized vector defining the general forward direction to use for vehicles. Has to match one of the base axes (1,0,0), (0,1,0) etc. Arbitrary axes are not supported.

Note: will be ignored if longitudinalAxis is used.

Declaration

float3 physxVehicleContext:forwardAxis

C++ Type

GfVec3f

Usd Type

SdfValueTypeNames->Float3

inline UsdAttribute CreateForwardAxisAttr() const

See GetForwardAxisAttr(), 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 GetVerticalAxisAttr() const

The axis defining the general up direction to use for vehicles.

Note: the “undefined” token value is only a valid option for indicating that the deprecated attribute upAxis should be used instead. Else, a valid axis has to be chosen.

Declaration

uniform token physxVehicleContext:verticalAxis = "undefined"

C++ Type

TfToken

Usd Type

SdfValueTypeNames->Token

Variability

SdfVariabilityUniform

Allowed Values

posX, negX, posY, negY, posZ, negZ, undefined

inline UsdAttribute CreateVerticalAxisAttr() const

See GetVerticalAxisAttr(), 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 GetLongitudinalAxisAttr() const

The axis defining the general forward direction to use for vehicles.

Note: the “undefined” token value is only a valid option for indicating that the deprecated attribute forwardAxis should be used instead. Else, a valid axis has to be chosen.

Declaration

uniform token physxVehicleContext:longitudinalAxis = "undefined"

C++ Type

TfToken

Usd Type

SdfValueTypeNames->Token

Variability

SdfVariabilityUniform

Allowed Values

posX, negX, posY, negY, posZ, negZ, undefined

inline UsdAttribute CreateLongitudinalAxisAttr() const

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

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