PhysxSchemaPhysxVehicleTireAPI Class Reference

Properties of a PhysX vehicle tire. More...

Inherits UsdAPISchemaBase.

Public Member Functions
	PhysxSchemaPhysxVehicleTireAPI (const UsdPrim &prim=UsdPrim())
	Construct a PhysxSchemaPhysxVehicleTireAPI on UsdPrim prim . More...
	PhysxSchemaPhysxVehicleTireAPI (const UsdSchemaBase &schemaObj)
	Construct a PhysxSchemaPhysxVehicleTireAPI on the prim held by schemaObj . More...
virtual PHYSXSCHEMA_API	~PhysxSchemaPhysxVehicleTireAPI ()
	Destructor. More...
PHYSXSCHEMA_API UsdAttribute	GetLatStiffXAttr () const
	Deprecated. More...
PHYSXSCHEMA_API UsdAttribute	CreateLatStiffXAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetLatStiffXAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetLatStiffYAttr () const
	Deprecated. More...
PHYSXSCHEMA_API UsdAttribute	CreateLatStiffYAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetLatStiffYAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetLateralStiffnessGraphAttr () const
	Tire lateral stiffness is represented as a graph of tire load that has linear behavior near zero load and flattens at large loads. More...
PHYSXSCHEMA_API UsdAttribute	CreateLateralStiffnessGraphAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetLateralStiffnessGraphAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetLongitudinalStiffnessPerUnitGravityAttr () const
	Deprecated. More...
PHYSXSCHEMA_API UsdAttribute	CreateLongitudinalStiffnessPerUnitGravityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetLongitudinalStiffnessPerUnitGravityAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetLongitudinalStiffnessAttr () const
	Tire longitudinal stiffness (units: mass * distance / seconds / seconds). More...
PHYSXSCHEMA_API UsdAttribute	CreateLongitudinalStiffnessAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetLongitudinalStiffnessAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetCamberStiffnessPerUnitGravityAttr () const
	Deprecated. More...
PHYSXSCHEMA_API UsdAttribute	CreateCamberStiffnessPerUnitGravityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetCamberStiffnessPerUnitGravityAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetCamberStiffnessAttr () const
	Tire camber stiffness (units: mass * distance / seconds / seconds / radians). More...
PHYSXSCHEMA_API UsdAttribute	CreateCamberStiffnessAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetCamberStiffnessAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetFrictionVsSlipGraphAttr () const
	Graph of friction vs longitudinal slip with 3 points. More...
PHYSXSCHEMA_API UsdAttribute	CreateFrictionVsSlipGraphAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetFrictionVsSlipGraphAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetRestLoadAttr () const
	The load that develops on the tire when the vehicle is at rest on a flat plane (units: force = mass * distance / seconds / seconds). More...
PHYSXSCHEMA_API UsdAttribute	CreateRestLoadAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetRestLoadAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdRelationship	GetFrictionTableRel () const
	A relationship to a PhysxVehicleTireFrictionTable instance. More...
PHYSXSCHEMA_API UsdRelationship	CreateFrictionTableRel () const
	See GetFrictionTableRel(), 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 PhysxSchemaPhysxVehicleTireAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxVehicleTireAPI 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 PhysxSchemaPhysxVehicleTireAPI	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

Properties of a PhysX vehicle tire.

If the tire setup does not need to be shared among vehicle instances, it can be applied to the prim which has PhysxVehicleWheelAttachmentAPI applied. If the intent is to share the tire setup, PhysxVehicleTireAPI can be applied to a separate prim which can be linked to (see PhysxVehicleWheelAttachmentAPI).

Definition at line 60 of file physxVehicleTireAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxVehicleTireAPI ( const UsdPrim &  prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxVehicleTireAPI on UsdPrim prim .

Equivalent to PhysxSchemaPhysxVehicleTireAPI::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 physxVehicleTireAPI.h.

PhysxSchemaPhysxVehicleTireAPI ( const UsdSchemaBase &  schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxVehicleTireAPI on the prim held by schemaObj .

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

Definition at line 80 of file physxVehicleTireAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxVehicleTireAPI ( )

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 PhysxSchemaPhysxVehicleTireAPI Apply ( const UsdPrim &  prim )

static

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

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

Returns

A valid PhysxSchemaPhysxVehicleTireAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxVehicleTireAPI 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 CreateCamberStiffnessAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetCamberStiffnessAttr(), 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 CreateCamberStiffnessPerUnitGravityAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetCamberStiffnessPerUnitGravityAttr(), 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 UsdRelationship CreateFrictionTableRel

(

)

const

See GetFrictionTableRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.

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

See GetFrictionVsSlipGraphAttr(), 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 CreateLateralStiffnessGraphAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetLateralStiffnessGraphAttr(), 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 CreateLatStiffXAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetLatStiffXAttr(), 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 CreateLatStiffYAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetLatStiffYAttr(), 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 CreateLongitudinalStiffnessAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetLongitudinalStiffnessAttr(), 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 CreateLongitudinalStiffnessPerUnitGravityAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetLongitudinalStiffnessPerUnitGravityAttr(), 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 CreateRestLoadAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetRestLoadAttr(), 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 PhysxSchemaPhysxVehicleTireAPI Get ( const UsdStagePtr &  stage, const SdfPath &  path  )

static

Return a PhysxSchemaPhysxVehicleTireAPI 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:

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

PHYSXSCHEMA_API UsdAttribute GetCamberStiffnessAttr

(

)

const

Tire camber stiffness (units: mass * distance / seconds / seconds / radians).

The value has to be greater or equal 0. Camber force can be approximated as: camberStiffness*camberAngle.

Note: the default value -1 is not a valid value as such but indicates that the deprecated attribute camberStiffnessPerUnitGravity should be used instead.

Declaration	float physxVehicleTire:camberStiffness = -1
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetCamberStiffnessPerUnitGravityAttr

(

)

const

Deprecated.

Please use camberStiffness instead.

Tire camber stiffness per unit gravitational acceleration. Camber stiffness of the tire is calculated as gravitationalAcceleration*camberStiffnessPerUnitGravity.

Note: will be ignored if camberStiffness is used.

Declaration	float physxVehicleTire:camberStiffnessPerUnitGravity = 0
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdRelationship GetFrictionTableRel

(

)

const

A relationship to a PhysxVehicleTireFrictionTable instance.

Note: if not defined, a default friction table will be used.

PHYSXSCHEMA_API UsdAttribute GetFrictionVsSlipGraphAttr

(

)

const

Graph of friction vs longitudinal slip with 3 points.

The friction value extracted from this graph will be multiplied with the friction value of the combination of ground material and tire type. The array is expected to have 3 entries/points. For the first point, the first value is always zero and the second value is the friction available at zero longitudinal slip. For the second point, the first value is the longitudinal slip with maximum friction and the second value is the maximum friction. For the third point, the first value is the end point of the graph and the second value is the friction for slips greater than the end point of the graph. Note that the friction value of the first point is typically smaller than the friction value of the second point and the friction value of the second point is typically larger than the friction value of the third point.

Note: if not defined, the following values will be used: [(0.0, 1.0), (0.1, 1.0), (1.0, 1.0)].

Declaration	float2[] physxVehicleTire:frictionVsSlipGraph
C++ Type	VtArray<GfVec2f>
Usd Type	SdfValueTypeNames->Float2Array

PHYSXSCHEMA_API UsdAttribute GetLateralStiffnessGraphAttr

(

)

const

Tire lateral stiffness is represented as a graph of tire load that has linear behavior near zero load and flattens at large loads.

The first value of the parameter describes the minimum normalized load (load/restLoad) that gives a flat lateral stiffness response to load. This value has to be greater or equal 0. The second value of the parameter defines the lateral stiffness when the response is flat (the max lateral stiffness, units: mass * distance / seconds / seconds). This value has to be positive.

Note: the default value (0, 0) is not a valid value as such but indicates that the deprecated attributes latStiffX and latStiffY should be used instead.

Declaration	float2 physxVehicleTire:lateralStiffnessGraph = (0, 0)
C++ Type	GfVec2f
Usd Type	SdfValueTypeNames->Float2

PHYSXSCHEMA_API UsdAttribute GetLatStiffXAttr

(

)

const

Deprecated.

Please use lateralStiffnessGraph instead.

Tire lateral stiffness is a graph of tire load that has linear behavior near zero load and flattens at large loads. The parameter describes the minimum normalized load (load/restLoad) that gives a flat lateral stiffness response to load.

Note: will be ignored if lateralStiffnessGraph is used.

Declaration	float physxVehicleTire:latStiffX = 2
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetLatStiffYAttr

(

)

const

Deprecated.

Please use lateralStiffnessGraph instead.

Tire lateral stiffness is a graph of tire load that has linear behavior near zero load and flattens at large loads. The parameter describes the maximum possible value of lateralStiffness/restLoad that occurs when (load/restLoad) >= latStiffX. If load/restLoad is greater than latStiffX then the lateral stiffness is latStiffY*restLoad, else the lateral stiffness is latStiffY*(load/latStiffX).

Note: will be ignored if lateralStiffnessGraph is used.

Note: if not defined, the value 17.095 will be used.

Declaration	float physxVehicleTire:latStiffY
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetLongitudinalStiffnessAttr

(

)

const

Tire longitudinal stiffness (units: mass * distance / seconds / seconds).

The value has to be positive. The resulting longitudinal force can be approximated as: longitudinalStiffness*longitudinalSlip.

Note: the default value 0 is not a valid value as such but indicates that the deprecated attribute longitudinalStiffnessPerUnitGravity should be used instead.

Declaration	float physxVehicleTire:longitudinalStiffness = 0
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetLongitudinalStiffnessPerUnitGravityAttr

(

)

const

Deprecated.

Please use longitudinalStiffness instead.

Tire longitudinal stiffness per unit gravitational acceleration. Longitudinal stiffness of the tire is calculated as gravitationalAcceleration*longitudinalStiffnessPerUnitGravity.

Note: will be ignored if longitudinalStiffness is used.

Note: if not defined, the value 500 will be used.

Declaration	float physxVehicleTire:longitudinalStiffnessPerUnitGravity
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetRestLoadAttr

(

)

const

The load that develops on the tire when the vehicle is at rest on a flat plane (units: force = mass * distance / seconds / seconds).

The value has to be greater or equal 0. If set to 0, the rest load will get computed automatically using the approximation of: gravitational acceleration * sprungMass.

Note: it is not possible for a vehicle to have some rest load values being user-defined and some being computed automatically. Either all values have to be user-defined or all have to be set to 0 for auto-computation.

Declaration	float physxVehicleTire:restLoad = 0
C++ Type	float
Usd Type	SdfValueTypeNames->Float

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.

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 physxVehicleTireAPI.h.

---

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

• C:/g/19412595/omni/schema/source/physxSchema/physxVehicleTireAPI.h