Differential to set up a wheeled tank vehicle. More...
Public Member Functions | |
PhysxSchemaPhysxVehicleTankDifferentialAPI (const UsdPrim &prim=UsdPrim()) | |
Construct a PhysxSchemaPhysxVehicleTankDifferentialAPI on UsdPrim prim . More... | |
PhysxSchemaPhysxVehicleTankDifferentialAPI (const UsdSchemaBase &schemaObj) | |
Construct a PhysxSchemaPhysxVehicleTankDifferentialAPI on the prim held by schemaObj . More... | |
virtual PHYSXSCHEMA_API | ~PhysxSchemaPhysxVehicleTankDifferentialAPI () |
Destructor. More... | |
PHYSXSCHEMA_API UsdAttribute | GetNumberOfWheelsPerTrackAttr () const |
For each track, this array holds the number of wheels assigned to that track. More... | |
PHYSXSCHEMA_API UsdAttribute | CreateNumberOfWheelsPerTrackAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetNumberOfWheelsPerTrackAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
PHYSXSCHEMA_API UsdAttribute | GetThrustIndexPerTrackAttr () const |
For each track, this array holds the index of the thrust control (0 or 1, see PhysxVehicleTankControllerAPI) that drives the track. More... | |
PHYSXSCHEMA_API UsdAttribute | CreateThrustIndexPerTrackAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetThrustIndexPerTrackAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
PHYSXSCHEMA_API 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]]). More... | |
PHYSXSCHEMA_API UsdAttribute | CreateTrackToWheelIndicesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetTrackToWheelIndicesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
PHYSXSCHEMA_API 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. More... | |
PHYSXSCHEMA_API UsdAttribute | CreateWheelIndicesInTrackOrderAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetWheelIndicesInTrackOrderAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
Public Member Functions inherited from PhysxSchemaPhysxVehicleMultiWheelDifferentialAPI | |
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 PhysxSchemaPhysxVehicleTankDifferentialAPI | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a PhysxSchemaPhysxVehicleTankDifferentialAPI holding the prim adhering to this schema at path on stage . More... | |
static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleTankDifferentialAPI | Apply (const UsdPrim &prim) |
Applies this single-apply API schema to the given prim . More... | |
Static Public Member Functions inherited from PhysxSchemaPhysxVehicleMultiWheelDifferentialAPI | |
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 PhysxSchemaPhysxVehicleMultiWheelDifferentialAPI | Apply (const UsdPrim &prim) |
Applies this single-apply API schema to the given prim . More... | |
Static Public Attributes | |
static const UsdSchemaType | schemaType = UsdSchemaType::SingleApplyAPI |
Compile time constant representing what kind of schema this class is. More... | |
Static Public Attributes inherited from PhysxSchemaPhysxVehicleMultiWheelDifferentialAPI | |
static const UsdSchemaType | schemaType = UsdSchemaType::SingleApplyAPI |
Compile time constant representing what kind of schema this class is. More... | |
Protected Member Functions | |
PHYSXSCHEMA_API UsdSchemaType | _GetSchemaType () const override |
Returns the type of schema this class belongs to. More... | |
Protected Member Functions inherited from PhysxSchemaPhysxVehicleMultiWheelDifferentialAPI | |
PHYSXSCHEMA_API UsdSchemaType | _GetSchemaType () const override |
Returns the type of schema this class belongs to. More... | |
Friends | |
class | UsdSchemaRegistry |
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).
Definition at line 62 of file physxVehicleTankDifferentialAPI.h.
|
inlineexplicit |
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
Definition at line 74 of file physxVehicleTankDifferentialAPI.h.
|
inlineexplicit |
Construct a PhysxSchemaPhysxVehicleTankDifferentialAPI on the prim held by schemaObj
.
Should be preferred over PhysxSchemaPhysxVehicleTankDifferentialAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.
Definition at line 82 of file physxVehicleTankDifferentialAPI.h.
|
virtual |
Destructor.
|
overrideprotected |
Returns the type of schema this class belongs to.
|
static |
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.
PHYSXSCHEMA_API UsdAttribute CreateNumberOfWheelsPerTrackAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetNumberOfWheelsPerTrackAttr(), 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 CreateThrustIndexPerTrackAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetThrustIndexPerTrackAttr(), 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 CreateTrackToWheelIndicesAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetTrackToWheelIndicesAttr(), 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 CreateWheelIndicesInTrackOrderAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetWheelIndicesInTrackOrderAttr(), 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 |
Return a PhysxSchemaPhysxVehicleTankDifferentialAPI 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:
PHYSXSCHEMA_API 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 |
|
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 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 |
PHYSXSCHEMA_API 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 |
PHYSXSCHEMA_API 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 |
|
static |
Compile time constant representing what kind of schema this class is.
Definition at line 68 of file physxVehicleTankDifferentialAPI.h.