Standard drive model for a PhysX vehicle. More...

Inherits UsdAPISchemaBase.

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

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

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

PHYSXSCHEMA_API UsdRelationship	GetEngineRel () const
	A relationship to a PhysxVehicleEngineAPI prim that describes the engine. More...

PHYSXSCHEMA_API UsdRelationship	CreateEngineRel () const
	See GetEngineRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdRelationship	GetGearsRel () const
	A relationship to a PhysxVehicleGearsAPI prim that describes the gears. More...

PHYSXSCHEMA_API UsdRelationship	CreateGearsRel () const
	See GetGearsRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdRelationship	GetAutoGearBoxRel () const
	A relationship to a PhysxVehicleAutoGearBoxAPI prim that describes the automatic gear shift box. More...

PHYSXSCHEMA_API UsdRelationship	CreateAutoGearBoxRel () const
	See GetAutoGearBoxRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdRelationship	GetClutchRel () const
	A relationship to a PhysxVehicleClutchAPI prim that describes the clutch. More...

PHYSXSCHEMA_API UsdRelationship	CreateClutchRel () const
	See GetClutchRel(), 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 PhysxSchemaPhysxVehicleDriveStandardAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxVehicleDriveStandardAPI 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 PhysxSchemaPhysxVehicleDriveStandardAPI	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

Standard drive model for a PhysX vehicle.

The available drive torque will be split equally between all the wheels that are marked as driven (see PhysxVehicleMultiWheelDifferentialAPI or deprecated attribute "driven" in PhysxVehicleWheelAttachmentAPI) unless the torque distributon is configured explicitly (see PhysxVehicleMultiWheelDifferentialAPI for details).

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

Definition at line 64 of file physxVehicleDriveStandardAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxVehicleDriveStandardAPI ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxVehicleDriveStandardAPI on UsdPrim prim .

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

Definition at line 76 of file physxVehicleDriveStandardAPI.h.

PhysxSchemaPhysxVehicleDriveStandardAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxVehicleDriveStandardAPI on the prim held by schemaObj .

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

Definition at line 84 of file physxVehicleDriveStandardAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxVehicleDriveStandardAPI ( )

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

static

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

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

Returns: A valid PhysxSchemaPhysxVehicleDriveStandardAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxVehicleDriveStandardAPI 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 UsdRelationship CreateAutoGearBoxRel ( ) const

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

PHYSXSCHEMA_API UsdRelationship CreateClutchRel ( ) const

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

PHYSXSCHEMA_API UsdRelationship CreateEngineRel ( ) const

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

PHYSXSCHEMA_API UsdRelationship CreateGearsRel ( ) const

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

static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleDriveStandardAPI Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

static

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

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

*

PHYSXSCHEMA_API UsdRelationship GetAutoGearBoxRel ( ) const

A relationship to a PhysxVehicleAutoGearBoxAPI prim that describes the automatic gear shift box.

This relationship is optional and should be omitted if no automatic gear shift is desired. It is also possible to apply PhysxVehicleAutoGearBoxAPI to the prim directly. In that case the relationship must not be defined.

PHYSXSCHEMA_API UsdRelationship GetClutchRel ( ) const

A relationship to a PhysxVehicleClutchAPI prim that describes the clutch.

Note: either this relationship has to be specified or the prim must have PhysxVehicleClutchAPI applied (none or both of the two is invalid).

PHYSXSCHEMA_API UsdRelationship GetEngineRel ( ) const

A relationship to a PhysxVehicleEngineAPI prim that describes the engine.

Note: either this relationship has to be specified or the prim must have PhysxVehicleEngineAPI applied (none or both of the two is invalid).

PHYSXSCHEMA_API UsdRelationship GetGearsRel ( ) const

A relationship to a PhysxVehicleGearsAPI prim that describes the gears.

Note: either this relationship has to be specified or the prim must have PhysxVehicleGearsAPI applied (none or both of the two is invalid).

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 70 of file physxVehicleDriveStandardAPI.h.

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

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