WARNING: Draft API, this design is not fixed and may change in the future. More...

Inheritance diagram for PhysxSchemaPhysxTendonAxisRootAPI:

Public Member Functions
	PhysxSchemaPhysxTendonAxisRootAPI (const UsdPrim &prim=UsdPrim(), const TfToken &name=TfToken())
	Construct a PhysxSchemaPhysxTendonAxisRootAPI on UsdPrim `prim` with name `name` . More...

	PhysxSchemaPhysxTendonAxisRootAPI (const UsdSchemaBase &schemaObj, const TfToken &name)
	Construct a PhysxSchemaPhysxTendonAxisRootAPI on the prim held by `schemaObj` with name `name`. More...

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

TfToken	GetName () const
	Returns the name of this multiple-apply schema instance. More...

PHYSXSCHEMA_API UsdAttribute	GetStiffnessAttr () const
	Tendon length spring stiffness. More...

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

PHYSXSCHEMA_API UsdAttribute	GetDampingAttr () const
	Tendon length damping. More...

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

PHYSXSCHEMA_API UsdAttribute	GetLimitStiffnessAttr () const
	Tendon length-limit spring stiffness. More...

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

PHYSXSCHEMA_API UsdAttribute	GetOffsetAttr () const
	Tendon length offset. More...

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

PHYSXSCHEMA_API UsdAttribute	GetRestLengthAttr () const
	Tendon rest length. More...

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

PHYSXSCHEMA_API UsdAttribute	GetLowerLimitAttr () const
	Tendon length lower limit. More...

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

PHYSXSCHEMA_API UsdAttribute	GetUpperLimitAttr () const
	Tendon length upper limit. More...

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

PHYSXSCHEMA_API UsdAttribute	GetTendonEnabledAttr () const
	Enables/disables the tendon from contributing to the articulation dynamics. More...

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

Public Member Functions inherited from PhysxSchemaPhysxTendonAxisAPI
	PhysxSchemaPhysxTendonAxisAPI (const UsdPrim &prim=UsdPrim(), const TfToken &name=TfToken())
	Construct a PhysxSchemaPhysxTendonAxisAPI on UsdPrim `prim` with name `name` . More...

	PhysxSchemaPhysxTendonAxisAPI (const UsdSchemaBase &schemaObj, const TfToken &name)
	Construct a PhysxSchemaPhysxTendonAxisAPI on the prim held by `schemaObj` with name `name`. More...

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

TfToken	GetName () const
	Returns the name of this multiple-apply schema instance. More...

PHYSXSCHEMA_API UsdAttribute	GetGearingAttr () const
	Joint gearing(s) per joint axis in axis token array, in the same order. More...

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

PHYSXSCHEMA_API UsdAttribute	GetForceCoefficientAttr () const
	Joint force coefficient(s) per joint axis in axis token array, in the same order. More...

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

PHYSXSCHEMA_API UsdAttribute	GetJointAxisAttr () const
	Specifies target joint axis/axes. More...

PHYSXSCHEMA_API UsdAttribute	CreateJointAxisAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetJointAxisAttr(), 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, const TfToken instanceName=TfToken())
	Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes for a given instance name. More...

static PHYSXSCHEMA_API PhysxSchemaPhysxTendonAxisRootAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxTendonAxisRootAPI holding the prim adhering to this schema at `path` on `stage`. More...

static PHYSXSCHEMA_API PhysxSchemaPhysxTendonAxisRootAPI	Get (const UsdPrim &prim, const TfToken &name)
	Return a PhysxSchemaPhysxTendonAxisRootAPI with name `name` holding the prim `prim`. More...

static PHYSXSCHEMA_API bool	IsSchemaPropertyBaseName (const TfToken &baseName)
	Checks if the given name `baseName` is the base name of a property of PhysxTendonAxisRootAPI. More...

static PHYSXSCHEMA_API bool	IsPhysxTendonAxisRootAPIPath (const SdfPath &path, TfToken *name)
	Checks if the given path `path` is of an API schema of type PhysxTendonAxisRootAPI. More...

static PHYSXSCHEMA_API PhysxSchemaPhysxTendonAxisRootAPI	Apply (const UsdPrim &prim, const TfToken &name)
	Applies this multiple-apply API schema to the given `prim` along with the given instance name, `name`. More...

Static Public Member Functions inherited from PhysxSchemaPhysxTendonAxisAPI
static PHYSXSCHEMA_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true, const TfToken instanceName=TfToken())
	Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes for a given instance name. More...

static PHYSXSCHEMA_API PhysxSchemaPhysxTendonAxisAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxTendonAxisAPI holding the prim adhering to this schema at `path` on `stage`. More...

static PHYSXSCHEMA_API PhysxSchemaPhysxTendonAxisAPI	Get (const UsdPrim &prim, const TfToken &name)
	Return a PhysxSchemaPhysxTendonAxisAPI with name `name` holding the prim `prim`. More...

static PHYSXSCHEMA_API bool	IsSchemaPropertyBaseName (const TfToken &baseName)
	Checks if the given name `baseName` is the base name of a property of PhysxTendonAxisAPI. More...

static PHYSXSCHEMA_API bool	IsPhysxTendonAxisAPIPath (const SdfPath &path, TfToken *name)
	Checks if the given path `path` is of an API schema of type PhysxTendonAxisAPI. More...

static PHYSXSCHEMA_API PhysxSchemaPhysxTendonAxisAPI	Apply (const UsdPrim &prim, const TfToken &name)
	Applies this multiple-apply API schema to the given `prim` along with the given instance name, `name`. More...

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

Static Public Attributes inherited from PhysxSchemaPhysxTendonAxisAPI
static const UsdSchemaType	schemaType = UsdSchemaType::MultipleApplyAPI
	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 PhysxSchemaPhysxTendonAxisAPI
PHYSXSCHEMA_API UsdSchemaType	_GetSchemaType () const override
	Returns the type of schema this class belongs to. More...

Friends
class	UsdSchemaRegistry

Detailed Description

WARNING: Draft API, this design is not fixed and may change in the future.

At this point, we don't support multi-axis joints (e.g. spherical, D6) yet.

Applied to a Physics Joint that must be part of an articulation, e.g. PhysicsRevoluteJoint or PhysicsPrismaticJoint.

In addition to creating a regular axis of the fixed tendon, the root API provides attributes that apply to the entire tendon. The root API must be applied to the joint that is the common ancestor of all joint axes in the tendon.

For restrictions on tendon structure and grouping of axes into tendons, see PhysxTendonAxisAPI.

Definition at line 66 of file physxTendonAxisRootAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxTendonAxisRootAPI	(	const UsdPrim &	prim = `UsdPrim()`,
		const TfToken &	name = `TfToken()`
	)

inlineexplicit

Construct a PhysxSchemaPhysxTendonAxisRootAPI on UsdPrim prim with name name .

Equivalent to PhysxSchemaPhysxTendonAxisRootAPI::Get( prim.GetStage(), prim.GetPath().AppendProperty( "physxTendon:name"));

for a valid prim, but will not immediately throw an error for an invalid prim

Definition at line 83 of file physxTendonAxisRootAPI.h.

PhysxSchemaPhysxTendonAxisRootAPI	(	const UsdSchemaBase &	schemaObj,
		const TfToken &	name
	)

inlineexplicit

Construct a PhysxSchemaPhysxTendonAxisRootAPI on the prim held by schemaObj with name name.

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

Definition at line 92 of file physxTendonAxisRootAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxTendonAxisRootAPI ( )

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 PhysxSchemaPhysxTendonAxisRootAPI Apply	(	const UsdPrim &	prim,
		const TfToken &	name
	)

static

Applies this multiple-apply API schema to the given prim along with the given instance name, name.

This information is stored by adding "PhysxTendonAxisRootAPI:<i>name</i>" to the token-valued, listOp metadata apiSchemas on the prim. For example, if name is 'instance1', the token 'PhysxTendonAxisRootAPI:instance1' is added to 'apiSchemas'.

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

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