PhysxSchemaPhysxVehicleWheelAPI Class Reference

Properties of a PhysX vehicle wheel. More...

Inherits UsdAPISchemaBase.

Public Member Functions
	PhysxSchemaPhysxVehicleWheelAPI (const UsdPrim &prim=UsdPrim())
	Construct a PhysxSchemaPhysxVehicleWheelAPI on UsdPrim prim . More...
	PhysxSchemaPhysxVehicleWheelAPI (const UsdSchemaBase &schemaObj)
	Construct a PhysxSchemaPhysxVehicleWheelAPI on the prim held by schemaObj . More...
virtual PHYSXSCHEMA_API	~PhysxSchemaPhysxVehicleWheelAPI ()
	Destructor. More...
PHYSXSCHEMA_API UsdAttribute	GetRadiusAttr () const
	The radius of the wheel (metal wheel plus tire). More...
PHYSXSCHEMA_API UsdAttribute	CreateRadiusAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetRadiusAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetWidthAttr () const
	The width of the wheel (metal wheel plus tire). More...
PHYSXSCHEMA_API UsdAttribute	CreateWidthAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetWidthAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetMassAttr () const
	The mass of the wheel (metal wheel plus tire). More...
PHYSXSCHEMA_API UsdAttribute	CreateMassAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetMassAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetMoiAttr () const
	The moment of inertia (metal wheel plus tire) about the rolling axis (units: mass * distance * distance). More...
PHYSXSCHEMA_API UsdAttribute	CreateMoiAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetMoiAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetDampingRateAttr () const
	The damping rate applied to the wheel (units: torque * seconds = mass * distance * distance / seconds). More...
PHYSXSCHEMA_API UsdAttribute	CreateDampingRateAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetDampingRateAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetMaxBrakeTorqueAttr () const
	Deprecated. More...
PHYSXSCHEMA_API UsdAttribute	CreateMaxBrakeTorqueAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetMaxBrakeTorqueAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetMaxHandBrakeTorqueAttr () const
	Deprecated. More...
PHYSXSCHEMA_API UsdAttribute	CreateMaxHandBrakeTorqueAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetMaxHandBrakeTorqueAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetMaxSteerAngleAttr () const
	Deprecated. More...
PHYSXSCHEMA_API UsdAttribute	CreateMaxSteerAngleAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetMaxSteerAngleAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetToeAngleAttr () const
	Deprecated. More...
PHYSXSCHEMA_API UsdAttribute	CreateToeAngleAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetToeAngleAttr(), 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 PhysxSchemaPhysxVehicleWheelAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxVehicleWheelAPI 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 PhysxSchemaPhysxVehicleWheelAPI	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 wheel.

If the wheel 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 wheel setup, PhysxVehicleWheelAPI can be applied to a separate prim which can be linked to (see PhysxVehicleWheelAttachmentAPI).

Definition at line 60 of file physxVehicleWheelAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxVehicleWheelAPI ( const UsdPrim &  prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxVehicleWheelAPI on UsdPrim prim .

Equivalent to PhysxSchemaPhysxVehicleWheelAPI::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 physxVehicleWheelAPI.h.

PhysxSchemaPhysxVehicleWheelAPI ( const UsdSchemaBase &  schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxVehicleWheelAPI on the prim held by schemaObj .

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

Definition at line 80 of file physxVehicleWheelAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxVehicleWheelAPI ( )

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

static

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

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

Returns

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

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

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

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

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

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

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

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

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

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

static

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

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

PHYSXSCHEMA_API UsdAttribute GetDampingRateAttr

(

)

const

The damping rate applied to the wheel (units: torque * seconds = mass * distance * distance / seconds).

Note: this attribute has to be specified (there is no default).

Declaration	float physxVehicleWheel:dampingRate
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetMassAttr

(

)

const

The mass of the wheel (metal wheel plus tire).

Note: this attribute has to be specified (there is no default).

Declaration	float physxVehicleWheel:mass
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetMaxBrakeTorqueAttr

(

)

const

Deprecated.

Please use PhysxVehicleBrakesAPI instead.

The maximum brake torque that can be applied to the wheel (units: mass * distance * distance / seconds / seconds).

Note: will be ignored if PhysxVehicleBrakesAPI is used.

Declaration	float physxVehicleWheel:maxBrakeTorque
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetMaxHandBrakeTorqueAttr

(

)

const

Deprecated.

Please use PhysxVehicleBrakesAPI instead.

The maximum hand brake torque that can be applied to the wheel (units: mass * distance * distance / seconds / seconds).

Note: will be ignored if PhysxVehicleBrakesAPI is used.

Declaration	float physxVehicleWheel:maxHandBrakeTorque
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetMaxSteerAngleAttr

(

)

const

Deprecated.

Please use PhysxVehicleSteeringAPI instead.

The maximum steer angle (in radians) that can be achieved by the wheel.

Note: will be ignored if PhysxVehicleSteeringAPI is used.

Declaration	float physxVehicleWheel:maxSteerAngle
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetMoiAttr

(

)

const

The moment of inertia (metal wheel plus tire) about the rolling axis (units: mass * distance * distance).

Note: this attribute has to be specified (there is no default).

Declaration	float physxVehicleWheel:moi
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetRadiusAttr

(

)

const

The radius of the wheel (metal wheel plus tire).

Note: this attribute has to be specified (there is no default).

Declaration	float physxVehicleWheel:radius
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.

PHYSXSCHEMA_API UsdAttribute GetToeAngleAttr

(

)

const

Deprecated.

Please use PhysxVehicleSuspensionComplianceAPI instead.

The wheel toe angle (in radians).

Note: currently, this attribute is only considered for vehicles using the PhysxVehicleDriveStandard drive type.

Note: will be ignored if PhysxVehicleSuspensionComplianceAPI is used.

Declaration	float physxVehicleWheel:toeAngle
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetWidthAttr

(

)

const

The width of the wheel (metal wheel plus tire).

Note: this attribute has to be specified (there is no default).

Declaration	float physxVehicleWheel:width
C++ Type	float
Usd Type	SdfValueTypeNames->Float

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

---

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

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