Describes which wheels of a vehicle are driven as well as the distribution of the drive torque among those wheels. More...

Inherits UsdAPISchemaBase.

Public Member Functions
	PhysxSchemaPhysxVehicleMultiWheelDifferentialAPI (const UsdPrim &prim=UsdPrim())
	Construct a PhysxSchemaPhysxVehicleMultiWheelDifferentialAPI on UsdPrim `prim` . More...

	PhysxSchemaPhysxVehicleMultiWheelDifferentialAPI (const UsdSchemaBase &schemaObj)
	Construct a PhysxSchemaPhysxVehicleMultiWheelDifferentialAPI on the prim held by `schemaObj` . More...

virtual PHYSXSCHEMA_API	~PhysxSchemaPhysxVehicleMultiWheelDifferentialAPI ()
	Destructor. More...

PHYSXSCHEMA_API UsdAttribute	GetWheelsAttr () const
	List of indices, referencing the wheels that are driven (receiving torque from the engine). More...

PHYSXSCHEMA_API UsdAttribute	CreateWheelsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetWheelsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetTorqueRatiosAttr () const
	Defines how the drive torque should get distributed among the wheels specified in the "wheels" attribute. More...

PHYSXSCHEMA_API UsdAttribute	CreateTorqueRatiosAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetTorqueRatiosAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetAverageWheelSpeedRatiosAttr () const
	Defines how the speeds of the driven wheels get weighted when computing the average wheel speed at the clutch (for computing clutch slip). More...

PHYSXSCHEMA_API UsdAttribute	CreateAverageWheelSpeedRatiosAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetAverageWheelSpeedRatiosAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

Static Public Member Functions
static PHYSXSCHEMA_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
	Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More...

static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleMultiWheelDifferentialAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxVehicleMultiWheelDifferentialAPI holding the prim adhering to this schema at `path` on `stage`. More...

static PHYSXSCHEMA_API bool	CanApply (const UsdPrim &prim, std::string *whyNot=nullptr)
	Returns true if this single-apply API schema can be applied to the given `prim`. More...

static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleMultiWheelDifferentialAPI	Apply (const UsdPrim &prim)
	Applies this single-apply API schema to the given `prim`. More...

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::SingleApplyAPI
	Compile time constant representing what kind of schema this class is. More...

Protected Member Functions
PHYSXSCHEMA_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to. More...

Friends
class	UsdSchemaRegistry

Detailed Description

Describes which wheels of a vehicle are driven as well as the distribution of the drive torque among those wheels.

Has to be applied to a prim with PhysxVehicleAPI applied. Can only be used for vehicles that have a drive (see PhysxVehicleDriveBasicAPI or PhysxVehicleDriveStandardAPI).

Definition at line 60 of file physxVehicleMultiWheelDifferentialAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxVehicleMultiWheelDifferentialAPI ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxVehicleMultiWheelDifferentialAPI on UsdPrim prim .

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

Definition at line 72 of file physxVehicleMultiWheelDifferentialAPI.h.

PhysxSchemaPhysxVehicleMultiWheelDifferentialAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxVehicleMultiWheelDifferentialAPI on the prim held by schemaObj .

Should be preferred over PhysxSchemaPhysxVehicleMultiWheelDifferentialAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 80 of file physxVehicleMultiWheelDifferentialAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxVehicleMultiWheelDifferentialAPI ( )

virtual

Destructor.

Member Function Documentation

PHYSXSCHEMA_API UsdSchemaKind _GetSchemaKind ( ) const

overrideprotected

Returns the kind of schema this class belongs to.

See Also: UsdSchemaKind

static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleMultiWheelDifferentialAPI Apply ( const UsdPrim & prim )

static

Applies this single-apply API schema to the given prim.

This information is stored by adding "PhysxVehicleMultiWheelDifferentialAPI" to the token-valued, listOp metadata apiSchemas on the prim.

Returns: A valid PhysxSchemaPhysxVehicleMultiWheelDifferentialAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxVehicleMultiWheelDifferentialAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.

See Also: UsdPrim::GetAppliedSchemas(); UsdPrim::HasAPI(); UsdPrim::CanApplyAPI(); UsdPrim::ApplyAPI(); UsdPrim::RemoveAPI()

static PHYSXSCHEMA_API bool CanApply	(	const UsdPrim &	prim,
		std::string *	whyNot = `nullptr`
	)

static

Returns true if this single-apply API schema can be applied to the given prim.

If this schema can not be a applied to the prim, this returns false and, if provided, populates whyNot with the reason it can not be applied.

Note that if CanApply returns false, that does not necessarily imply that calling Apply will fail. Callers are expected to call CanApply before calling Apply if they want to ensure that it is valid to apply a schema.

See Also: UsdPrim::GetAppliedSchemas(); UsdPrim::HasAPI(); UsdPrim::CanApplyAPI(); UsdPrim::ApplyAPI(); UsdPrim::RemoveAPI()

PHYSXSCHEMA_API UsdAttribute CreateAverageWheelSpeedRatiosAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetAverageWheelSpeedRatiosAttr(), and also Usd_Create_Or_Get_Property 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.

PHYSXSCHEMA_API UsdAttribute CreateTorqueRatiosAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetTorqueRatiosAttr(), and also Usd_Create_Or_Get_Property 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.

PHYSXSCHEMA_API UsdAttribute CreateWheelsAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetWheelsAttr(), and also Usd_Create_Or_Get_Property 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.

static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleMultiWheelDifferentialAPI Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

static

Return a PhysxSchemaPhysxVehicleMultiWheelDifferentialAPI holding the prim adhering to this schema at path on stage.

If no prim exists at path on stage, or if the prim at that path does not adhere to this schema, return an invalid schema object. This is shorthand for the following:

* PhysxSchemaPhysxVehicleMultiWheelDifferentialAPI(stage->GetPrimAtPath(path));

*

PHYSXSCHEMA_API UsdAttribute GetAverageWheelSpeedRatiosAttr ( ) const

Defines how the speeds of the driven wheels get weighted when computing the average wheel speed at the clutch (for computing clutch slip).

The provided ratios must be in range [0, 1] and under normal circumstances sum up to 1. 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, the wheel speeds of all driven wheels will get weighted equally.

Note: if a vehicle is using a PhysxVehicleDriveBasicAPI drive, then this attribute should not be used.


Declaration	`float[] physxVehicleMultiWheelDifferential:averageWheelSpeedRatios`
C++ Type	VtArray<float>
Usd Type	SdfValueTypeNames->FloatArray

static PHYSXSCHEMA_API const TfTokenVector& GetSchemaAttributeNames ( bool includeInherited = true )

static

Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.

Does not include attributes that may be authored by custom/extended methods of the schemas involved.

PHYSXSCHEMA_API UsdAttribute GetTorqueRatiosAttr ( ) const

Defines how the drive torque should get distributed among the wheels specified in the "wheels" attribute.

The provided ratios must be in range [-1, 1] and under normal circumstances the absolute values should sum up to 1. 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, the torque will get split equally among all driven wheels.


Declaration	`float[] physxVehicleMultiWheelDifferential:torqueRatios`
C++ Type	VtArray<float>
Usd Type	SdfValueTypeNames->FloatArray

PHYSXSCHEMA_API UsdAttribute GetWheelsAttr ( ) const

List of indices, referencing the wheels that are driven (receiving torque from the engine).

The indices refer to the attribute "index" of PhysxVehicleWheelAttachmentAPI.


Declaration	`int[] physxVehicleMultiWheelDifferential:wheels`
C++ Type	VtArray<int>
Usd Type	SdfValueTypeNames->IntArray

Member Data Documentation

const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI

static

Compile time constant representing what kind of schema this class is.

See Also: UsdSchemaKind

Definition at line 66 of file physxVehicleMultiWheelDifferentialAPI.h.

The documentation for this class was generated from the following file:

C:/g/19412595/omni/schema/source/physxSchema/physxVehicleMultiWheelDifferentialAPI.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation