PhysX vehicle tank controller to divert torque from the engine to the wheels of the tracks of a wheel based tank vehicle (see PhysxVehicleTankDifferentialAPI). More...

Inheritance diagram for PhysxSchemaPhysxVehicleTankControllerAPI:

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

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

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

PHYSXSCHEMA_API UsdAttribute	GetThrust0Attr () const
	Magnitude of thrust to apply to the tracks that are assigned to thrust control 0. More...

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

PHYSXSCHEMA_API UsdAttribute	GetThrust1Attr () const
	Magnitude of thrust to apply to the tracks that are assigned to thrust control 1. More...

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

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

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

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

PHYSXSCHEMA_API UsdAttribute	GetAcceleratorAttr () const
	Driven vehicle. More...

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

PHYSXSCHEMA_API UsdAttribute	GetBrake0Attr () const
	Brake control for braking system "brakes0" (see PhysxVehicleBrakesAPI) that triggers the connected brakes and defines the brake strength. More...

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

PHYSXSCHEMA_API UsdAttribute	GetBrake1Attr () const
	Brake control for braking system "brakes1" (see PhysxVehicleBrakesAPI) that triggers the connected brakes and defines the brake strength. More...

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

PHYSXSCHEMA_API UsdAttribute	GetBrakeAttr () const
	Deprecated. More...

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

PHYSXSCHEMA_API UsdAttribute	GetHandbrakeAttr () const
	Deprecated. More...

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

PHYSXSCHEMA_API UsdAttribute	GetSteerAttr () const
	Steer control for the steering system (see PhysxVehicleSteeringAPI). More...

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

PHYSXSCHEMA_API UsdAttribute	GetSteerLeftAttr () const
	Deprecated. More...

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

PHYSXSCHEMA_API UsdAttribute	GetSteerRightAttr () const
	Deprecated. More...

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

PHYSXSCHEMA_API UsdAttribute	GetTargetGearAttr () const
	Driven vehicle. More...

PHYSXSCHEMA_API UsdAttribute	CreateTargetGearAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetTargetGearAttr(), 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 PhysxSchemaPhysxVehicleTankControllerAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxVehicleTankControllerAPI holding the prim adhering to this schema at `path` on `stage`. More...

static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleTankControllerAPI	Apply (const UsdPrim &prim)
	Applies this single-apply API schema to the given `prim`. More...

Static Public Member Functions inherited from PhysxSchemaPhysxVehicleControllerAPI
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 PhysxSchemaPhysxVehicleControllerAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxVehicleControllerAPI holding the prim adhering to this schema at `path` on `stage`. More...

static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleControllerAPI	Apply (const UsdPrim &prim)
	Applies this single-apply API schema to the given `prim`. More...

Static Public Attributes
static const UsdSchemaType	schemaType = UsdSchemaType::SingleApplyAPI
	Compile time constant representing what kind of schema this class is. More...

Static Public Attributes inherited from PhysxSchemaPhysxVehicleControllerAPI
static const UsdSchemaType	schemaType = UsdSchemaType::SingleApplyAPI
	Compile time constant representing what kind of schema this class is. More...

Protected Member Functions
PHYSXSCHEMA_API UsdSchemaType	_GetSchemaType () const override
	Returns the type of schema this class belongs to. More...

Protected Member Functions inherited from PhysxSchemaPhysxVehicleControllerAPI
PHYSXSCHEMA_API UsdSchemaType	_GetSchemaType () const override
	Returns the type of schema this class belongs to. More...

Friends
class	UsdSchemaRegistry

Detailed Description

PhysX vehicle tank controller to divert torque from the engine to the wheels of the tracks of a wheel based tank vehicle (see PhysxVehicleTankDifferentialAPI).

Note that the "accelerator" attribute of PhysxVehicleControllerAPI still drives the engine torque whereas the thrust controls introduced here define how that torque gets diverted to the wheels, so both controls need to be used to drive a wheel based tank vehicle usually. This API schema has to be applied to a prim with PhysxVehicleAPI applied. Can only be used for vehicles that have a standard drive and a tank differential defined (see PhysxVehicleDriveStandardAPI, PhysxVehicleTankDifferentialAPI).

Definition at line 63 of file physxVehicleTankControllerAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxVehicleTankControllerAPI ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxVehicleTankControllerAPI on UsdPrim prim .

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

Definition at line 75 of file physxVehicleTankControllerAPI.h.

PhysxSchemaPhysxVehicleTankControllerAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxVehicleTankControllerAPI on the prim held by schemaObj .

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

Definition at line 83 of file physxVehicleTankControllerAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxVehicleTankControllerAPI ( )

virtual

Destructor.

Member Function Documentation

PHYSXSCHEMA_API UsdSchemaType _GetSchemaType ( ) const

overrideprotected

Returns the type of schema this class belongs to.

See Also: UsdSchemaType

static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleTankControllerAPI Apply ( const UsdPrim & prim )

static

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

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

Returns: A valid PhysxSchemaPhysxVehicleTankControllerAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxVehicleTankControllerAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.

See Also: UsdPrim::GetAppliedSchemas(); UsdPrim::HasAPI(); UsdPrim::ApplyAPI(); UsdPrim::RemoveAPI()

PHYSXSCHEMA_API UsdAttribute CreateThrust0Attr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

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

static

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

* PhysxSchemaPhysxVehicleTankControllerAPI(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 GetThrust0Attr ( ) const

Magnitude of thrust to apply to the tracks that are assigned to thrust control 0.

Values have to be in [-1.0, 1.0] with the sign dictating whether the thrust will be applied positively or negatively with respect to the gearing ratio.


Declaration	`float physxVehicleTankController:thrust0 = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetThrust1Attr ( ) const

Magnitude of thrust to apply to the tracks that are assigned to thrust control 1.

Values have to be in [-1.0, 1.0] with the sign dictating whether the thrust will be applied positively or negatively with respect to the gearing ratio.


Declaration	`float physxVehicleTankController:thrust1 = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

Member Data Documentation

const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI

static

Compile time constant representing what kind of schema this class is.

See Also: UsdSchemaType

Definition at line 69 of file physxVehicleTankControllerAPI.h.

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

W:/919a5455eee1e83c/src/physxSchema/physxVehicleTankControllerAPI.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