Properties of the PhysX vehicle clutch. More...
Inherits UsdAPISchemaBase.
Public Member Functions | |
| PhysxSchemaPhysxVehicleClutchAPI (const UsdPrim &prim=UsdPrim()) | |
Construct a PhysxSchemaPhysxVehicleClutchAPI on UsdPrim prim . More... | |
| PhysxSchemaPhysxVehicleClutchAPI (const UsdSchemaBase &schemaObj) | |
Construct a PhysxSchemaPhysxVehicleClutchAPI on the prim held by schemaObj . More... | |
| virtual PHYSXSCHEMA_API | ~PhysxSchemaPhysxVehicleClutchAPI () |
| Destructor. More... | |
| PHYSXSCHEMA_API UsdAttribute | GetStrengthAttr () const |
| Strength of clutch (units: torque * seconds = mass * distance * distance / seconds). More... | |
| PHYSXSCHEMA_API UsdAttribute | CreateStrengthAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
| See GetStrengthAttr(), 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 PhysxSchemaPhysxVehicleClutchAPI | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a PhysxSchemaPhysxVehicleClutchAPI 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 PhysxSchemaPhysxVehicleClutchAPI | 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 |
Properties of the PhysX vehicle clutch.
If the clutch setup does not need to be shared among vehicle instances, it can be applied to the prim which has PhysxVehicleDriveStandardAPI applied. If the intent is to share the clutch setup, PhysxVehicleClutchAPI can be applied to a separate prim which can be linked to (see PhysxVehicleDriveStandardAPI).
Definition at line 60 of file physxVehicleClutchAPI.h.
|
inlineexplicit |
Construct a PhysxSchemaPhysxVehicleClutchAPI on UsdPrim prim .
Equivalent to PhysxSchemaPhysxVehicleClutchAPI::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 physxVehicleClutchAPI.h.
|
inlineexplicit |
Construct a PhysxSchemaPhysxVehicleClutchAPI on the prim held by schemaObj .
Should be preferred over PhysxSchemaPhysxVehicleClutchAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.
Definition at line 80 of file physxVehicleClutchAPI.h.
|
virtual |
Destructor.
|
overrideprotected |
Returns the kind of schema this class belongs to.
|
static |
Applies this single-apply API schema to the given prim.
This information is stored by adding "PhysxVehicleClutchAPI" to the token-valued, listOp metadata apiSchemas on the prim.
|
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.
| PHYSXSCHEMA_API UsdAttribute CreateStrengthAttr | ( | VtValue const & | defaultValue = VtValue(), |
| bool | writeSparsely = false |
||
| ) | const |
See GetStrengthAttr(), 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 PhysxSchemaPhysxVehicleClutchAPI 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:
|
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 GetStrengthAttr | ( | ) | const |
Strength of clutch (units: torque * seconds = mass * distance * distance / seconds).
The value has to be positive. The clutch is the mechanism that couples the engine to the wheels. A stronger clutch more strongly couples the engine to the wheels, while a clutch of strength zero completely decouples the engine from the wheels. Stronger clutches more quickly bring the wheels and engine into equilibrium, while weaker clutches take longer, resulting in periods of clutch slip and delays in power transmission from the engine to the wheels. The torque generated by the clutch is proportional to the clutch strength and the velocity difference between the engine's rotational speed and the rotational speed of the driven wheels after accounting for the gear ratio. The torque at the clutch is applied negatively to the engine and positively to the driven wheels.
Note: if not defined, the value 10.0 will be used. This default value is in meter length scale and kilograms and will get adjusted if other units are used.
| Declaration | float physxVehicleClutch:strength |
| C++ Type | float |
| Usd Type | SdfValueTypeNames->Float |
|
static |
Compile time constant representing what kind of schema this class is.
Definition at line 66 of file physxVehicleClutchAPI.h.
1.8.5 
