Compliance describes how toe and camber angle and force application points are affected by suspension compression. More...

Inherits UsdAPISchemaBase.

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

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

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

PHYSXSCHEMA_API UsdAttribute	GetWheelToeAngleAttr () const
	A graph of toe angle against normalized jounce with the toe angle expressed in radians in the range [-pi, pi]. More...

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

PHYSXSCHEMA_API UsdAttribute	GetWheelCamberAngleAttr () const
	A graph of camber angle against normalized jounce with the camber angle expressed in radians in the range [-pi, pi]. More...

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

PHYSXSCHEMA_API UsdAttribute	GetSuspensionForceAppPointAttr () const
	Suspension forces are applied at an offset from the suspension frame (see PhysxVehicleWheelAttachmentAPI). More...

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

PHYSXSCHEMA_API UsdAttribute	GetTireForceAppPointAttr () const
	Tire forces are applied at an offset from the suspension frame (see PhysxVehicleWheelAttachmentAPI). More...

PHYSXSCHEMA_API UsdAttribute	CreateTireForceAppPointAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetTireForceAppPointAttr(), 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 PhysxSchemaPhysxVehicleSuspensionComplianceAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxVehicleSuspensionComplianceAPI 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 PhysxSchemaPhysxVehicleSuspensionComplianceAPI	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

Compliance describes how toe and camber angle and force application points are affected by suspension compression.

Each compliance term is in the form of a graph with up to 3 points. The points in the graph consist of a normalized jounce value (with 0 meaning fully elongated and 1 fully compressed suspension) and a corresponding compliance value (which can be an angle or point etc. depending on the specific compliance term). The sequence of points must respresent monotonically increasing values of normalized jounce. The actual compliance value will be computed by linear interpolation based on the current normalized jounce. If any graph has zero points in it, a value of 0.0 is used for the compliance value. If any graph has 1 point in it, the compliance value of that point is used directly. This API schema has to be applied to a prim with PhysxVehicleWheelAttachmentAPI applied. If defined, then this setup takes precedence over the deprecated attributes suspensionForceAppPointOffset and tireForceAppPointOffset of the PhysxVehicleWheelAttachmentAPI API schema, the deprecated attributes camberAtRest, camberAtMaxCompression, camberAtMaxDroop of the PhysxVehicleSuspensionAPI API schema as well as the deprecated attribute toeAngle of the PhysxVehicleWheelAPI API schema.

Definition at line 72 of file physxVehicleSuspensionComplianceAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxVehicleSuspensionComplianceAPI ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxVehicleSuspensionComplianceAPI on UsdPrim prim .

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

Definition at line 84 of file physxVehicleSuspensionComplianceAPI.h.

PhysxSchemaPhysxVehicleSuspensionComplianceAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxVehicleSuspensionComplianceAPI on the prim held by schemaObj .

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

Definition at line 92 of file physxVehicleSuspensionComplianceAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxVehicleSuspensionComplianceAPI ( )

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

static

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

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

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

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

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

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

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

static

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

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

*

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

Suspension forces are applied at an offset from the suspension frame (see PhysxVehicleWheelAttachmentAPI).

An entry in this array defines this offset for a given normalized jounce value (which is the first element in the float4 while the other 3 elements are used to store the x, y, z coordinates of the offset). See the class documentation for general info about the nature of these compliance terms and the data requirements.


Declaration	`float4[] physxVehicleSuspensionCompliance:suspensionForceAppPoint`
C++ Type	VtArray<GfVec4f>
Usd Type	SdfValueTypeNames->Float4Array

PHYSXSCHEMA_API UsdAttribute GetTireForceAppPointAttr ( ) const

Tire forces are applied at an offset from the suspension frame (see PhysxVehicleWheelAttachmentAPI).

An entry in this array defines this offset for a given normalized jounce value (which is the first element in the float4 while the other 3 elements are used to store the x, y, z coordinates of the offset). See the class documentation for general info about the nature of these compliance terms and the data requirements.


Declaration	`float4[] physxVehicleSuspensionCompliance:tireForceAppPoint`
C++ Type	VtArray<GfVec4f>
Usd Type	SdfValueTypeNames->Float4Array

PHYSXSCHEMA_API UsdAttribute GetWheelCamberAngleAttr ( ) const

A graph of camber angle against normalized jounce with the camber angle expressed in radians in the range [-pi, pi].

See the class documentation for general info about the nature of these graphs and the data requirements.

Note: the camber angle is applied in the suspension frame (see PhysxVehicleWheelAttachmentAPI).


Declaration	`float2[] physxVehicleSuspensionCompliance:wheelCamberAngle`
C++ Type	VtArray<GfVec2f>
Usd Type	SdfValueTypeNames->Float2Array

PHYSXSCHEMA_API UsdAttribute GetWheelToeAngleAttr ( ) const

A graph of toe angle against normalized jounce with the toe angle expressed in radians in the range [-pi, pi].

See the class documentation for general info about the nature of these graphs and the data requirements.

Note: the toe angle is applied in the suspension frame (see PhysxVehicleWheelAttachmentAPI).


Declaration	`float2[] physxVehicleSuspensionCompliance:wheelToeAngle`
C++ Type	VtArray<GfVec2f>
Usd Type	SdfValueTypeNames->Float2Array

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 78 of file physxVehicleSuspensionComplianceAPI.h.

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

C:/g/19412595/omni/schema/source/physxSchema/physxVehicleSuspensionComplianceAPI.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