Differential to set up a wheeled tank vehicle. More...

Inherits UsdAPISchemaBase.

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

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

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

PHYSXSCHEMA_API UsdAttribute	GetNumberOfWheelsPerTrackAttr () const
	For each track, this array holds the number of wheels assigned to that track. More...

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

PHYSXSCHEMA_API UsdAttribute	GetThrustIndexPerTrackAttr () const
	For each track, this array holds the index of the thrust control (0 or 1, see PhysxVehicleTankControllerAPI) that drives the track. More...

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

PHYSXSCHEMA_API UsdAttribute	GetTrackToWheelIndicesAttr () const
	For each track, this array holds the start index of the list describing the wheels that are assigned to that track (e.g., the list of wheel indices assigned to the track with index 2 starts at: wheelIndicesInTrackOrder[trackToWheelIndices[2]]). More...

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

PHYSXSCHEMA_API UsdAttribute	GetWheelIndicesInTrackOrderAttr () const
	The wheels (identified by wheel attachment indices, see attribtue "index" of PhysxVehicleWheelAttachmentAPI) assigned to track 0, followed by the wheels assigned to track 1 and so on. More...

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

Differential to set up a wheeled tank vehicle.

Describes which wheels of a vehicle are part of the tank tracks. The wheels in each tank track have a constraint applied to them to enforce the rule that they all have the same longitudinal speed at the contact point between the wheel and the tank track. Driven wheels that are not part of a tank track receive the torque split specified in physxVehicleMultiWheelDifferential:torqueRatios. Has to be applied to a prim with PhysxVehicleAPI applied. Can only be used for vehicles that have a standard drive (see PhysxVehicleDriveStandardAPI).

Definition at line 62 of file physxVehicleTankDifferentialAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxVehicleTankDifferentialAPI ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxVehicleTankDifferentialAPI on UsdPrim prim .

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

Definition at line 74 of file physxVehicleTankDifferentialAPI.h.

PhysxSchemaPhysxVehicleTankDifferentialAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxVehicleTankDifferentialAPI on the prim held by schemaObj .

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

Definition at line 82 of file physxVehicleTankDifferentialAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxVehicleTankDifferentialAPI ( )

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

static

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

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

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

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

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

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

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

static

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

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

*

PHYSXSCHEMA_API UsdAttribute GetNumberOfWheelsPerTrackAttr ( ) const

For each track, this array holds the number of wheels assigned to that track.


Declaration	`int[] physxVehicleTankDifferential:numberOfWheelsPerTrack`
C++ Type	VtArray<int>
Usd Type	SdfValueTypeNames->IntArray

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

For each track, this array holds the index of the thrust control (0 or 1, see PhysxVehicleTankControllerAPI) that drives the track.

The length of the array needs to match the length of the "numberOfWheelsPerTrack" array.


Declaration	`int[] physxVehicleTankDifferential:thrustIndexPerTrack`
C++ Type	VtArray<int>
Usd Type	SdfValueTypeNames->IntArray

PHYSXSCHEMA_API UsdAttribute GetTrackToWheelIndicesAttr ( ) const

For each track, this array holds the start index of the list describing the wheels that are assigned to that track (e.g., the list of wheel indices assigned to the track with index 2 starts at: wheelIndicesInTrackOrder[trackToWheelIndices[2]]).

The length of the array needs to match the length of the "numberOfWheelsPerTrack" array.


Declaration	`int[] physxVehicleTankDifferential:trackToWheelIndices`
C++ Type	VtArray<int>
Usd Type	SdfValueTypeNames->IntArray

PHYSXSCHEMA_API UsdAttribute GetWheelIndicesInTrackOrderAttr ( ) const

The wheels (identified by wheel attachment indices, see attribtue "index" of PhysxVehicleWheelAttachmentAPI) assigned to track 0, followed by the wheels assigned to track 1 and so on.

The length of the array is expected to be equal (or larger than) the number of wheels that are assigned to tracks.


Declaration	`int[] physxVehicleTankDifferential:wheelIndicesInTrackOrder`
C++ Type	VtArray<int>
Usd Type	SdfValueTypeNames->IntArray

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 68 of file physxVehicleTankDifferentialAPI.h.

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

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