Properties of the PhysX vehicle automatic gear shift box. More...

Inherits UsdAPISchemaBase.

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

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

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

PHYSXSCHEMA_API UsdAttribute	GetUpRatiosAttr () const
	Value of normalized engine speed (engineRotationSpeed / maxRotationSpeed) that is high enough to increment gear. More...

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

PHYSXSCHEMA_API UsdAttribute	GetDownRatiosAttr () const
	Value of normalized engine speed (engineRotationSpeed / maxRotationSpeed) that is low enough to decrement gear. More...

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

PHYSXSCHEMA_API UsdAttribute	GetLatencyAttr () const
	The latency time of the automatic gear shift box (units: seconds). More...

PHYSXSCHEMA_API UsdAttribute	CreateLatencyAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetLatencyAttr(), 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 PhysxSchemaPhysxVehicleAutoGearBoxAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxVehicleAutoGearBoxAPI 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 PhysxSchemaPhysxVehicleAutoGearBoxAPI	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 the PhysX vehicle automatic gear shift box.

If the automatic gear shift box 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 automatic gear shift box setup, PhysxVehicleAutoGearBoxAPI can be applied to a separate prim which can be linked to (see PhysxVehicleDriveStandardAPI).

Definition at line 61 of file physxVehicleAutoGearBoxAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxVehicleAutoGearBoxAPI ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxVehicleAutoGearBoxAPI on UsdPrim prim .

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

Definition at line 73 of file physxVehicleAutoGearBoxAPI.h.

PhysxSchemaPhysxVehicleAutoGearBoxAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxVehicleAutoGearBoxAPI on the prim held by schemaObj .

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

Definition at line 81 of file physxVehicleAutoGearBoxAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxVehicleAutoGearBoxAPI ( )

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

static

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

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

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

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

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

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

static

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

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

*

PHYSXSCHEMA_API UsdAttribute GetDownRatiosAttr ( ) const

Value of normalized engine speed (engineRotationSpeed / maxRotationSpeed) that is low enough to decrement gear.

The first entry is for second gear then up to the highest gear. When (engineRotationSpeed / maxRotationSpeed) < downRatios[currentGear] the autobox will begin a transition to currentGear-1 unless currentGear is first gear or neutral or reverse.

Note: if not defined, the following values will be used: [0.5, 0.5, 0.5, 0.5].


Declaration	`float[] physxVehicleAutoGearBox:downRatios`
C++ Type	VtArray<float>
Usd Type	SdfValueTypeNames->FloatArray

PHYSXSCHEMA_API UsdAttribute GetLatencyAttr ( ) const

The latency time of the automatic gear shift box (units: seconds).

This is the minimum time that must pass between each gear change that is initiated by the automatic gear shift box.

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


Declaration	`float physxVehicleAutoGearBox:latency`
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 GetUpRatiosAttr ( ) const

Value of normalized engine speed (engineRotationSpeed / maxRotationSpeed) that is high enough to increment gear.

The first entry is for first gear and then up to the second highest gear. When (engineRotationSpeed / maxRotationSpeed) > upRatios[currentGear] the autobox will begin a transition to currentGear+1 unless currentGear is the highest possible gear or neutral or reverse.

Note: if not defined, the following values will be used: [0.65, 0.65, 0.65, 0.65].


Declaration	`float[] physxVehicleAutoGearBox:upRatios`
C++ Type	VtArray<float>
Usd Type	SdfValueTypeNames->FloatArray

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 67 of file physxVehicleAutoGearBoxAPI.h.

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

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