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

Inherits UsdAPISchemaBase.

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

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

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

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

PHYSXSCHEMA_API UsdAttribute	GetGearingAttr () const
	Attachment distance scaling factor. 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	GetLocalPosAttr () const
	Location of the attachment. More...

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

PHYSXSCHEMA_API UsdAttribute	GetParentAttachmentAttr () const
	API instance name of parent attachment at parentLink. More...

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

PHYSXSCHEMA_API UsdRelationship	GetParentLinkRel () const
	Relationship to parent link that has a PhysxTendonAttachmentAPI or PhysxTendonAttachmentRootAPI with instance name parentAttachment applied. More...

PHYSXSCHEMA_API UsdRelationship	CreateParentLinkRel () const
	See GetParentLinkRel(), 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 TfTokenVector	GetSchemaAttributeNames (bool includeInherited, const TfToken &instanceName)
	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 PhysxSchemaPhysxTendonAttachmentAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxTendonAttachmentAPI holding the prim adhering to this schema at `path` on `stage`. More...

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

static PHYSXSCHEMA_API std::vector < PhysxSchemaPhysxTendonAttachmentAPI >	GetAll (const UsdPrim &prim)
	Return a vector of all named instances of PhysxSchemaPhysxTendonAttachmentAPI on the given `prim`. More...

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

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

static PHYSXSCHEMA_API bool	CanApply (const UsdPrim &prim, const TfToken &name, std::string *whyNot=nullptr)
	Returns true if this multiple-apply API schema can be applied, with the given instance name, `name`, to the given `prim`. More...

static PHYSXSCHEMA_API PhysxSchemaPhysxTendonAttachmentAPI	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 UsdSchemaKind	schemaKind = UsdSchemaKind::MultipleApplyAPI
	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

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

Applied to an articulation-link rigid-body Xformable.

A tendon attachment is part of a spatial tendon and is attached to an articulation link. The distance between the attachment and its parent attachment contributes to the length of the tendon, after scaling by the gearing attribute.

The localPos attribute defines the translational offset of the attachment in the link's local frame; in particular, this means that the offset is scaled together with any scaling applied to the link.

An articulation link may have multiple distinct attachments that belong to the same or distinct spatial tendons; therefore, the spatial tendon APIs are multi-apply and each attachment must have a unique instance name that is used in parent-child relationships of the attachments.

For any described attribute Fallback Value or Allowed Values below that are text/tokens, the actual token is published and defined in PhysxSchemaTokens. So to set an attribute to the value "rightHanded", use PhysxSchemaTokens->rightHanded as the value.

Definition at line 75 of file physxTendonAttachmentAPI.h.

Constructor & Destructor Documentation

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

inlineexplicit

Construct a PhysxSchemaPhysxTendonAttachmentAPI on UsdPrim prim with name name .

Equivalent to PhysxSchemaPhysxTendonAttachmentAPI::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 92 of file physxTendonAttachmentAPI.h.

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

inlineexplicit

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

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

Definition at line 101 of file physxTendonAttachmentAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxTendonAttachmentAPI ( )

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 PhysxSchemaPhysxTendonAttachmentAPI 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 "PhysxTendonAttachmentAPI:<i>name</i>" to the token-valued, listOp metadata apiSchemas on the prim. For example, if name is 'instance1', the token 'PhysxTendonAttachmentAPI:instance1' is added to 'apiSchemas'.

Returns: A valid PhysxSchemaPhysxTendonAttachmentAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxTendonAttachmentAPI 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,
		const TfToken &	name,
		std::string *	whyNot = `nullptr`
	)

static

Returns true if this multiple-apply API schema can be applied, with the given instance name, name, to the given prim.

If this schema can not be a applied 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 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.

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

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

See GetParentAttachmentAttr(), 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 UsdRelationship CreateParentLinkRel ( ) const

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

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

static

Return a PhysxSchemaPhysxTendonAttachmentAPI 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. path must be of the format <path>.physxTendon:name .

This is shorthand for the following:

*  TfToken name = SdfPath::StripNamespace(path.GetToken());
*  PhysxSchemaPhysxTendonAttachmentAPI(
*      stage->GetPrimAtPath(path.GetPrimPath()), name);
*  

static PHYSXSCHEMA_API PhysxSchemaPhysxTendonAttachmentAPI Get	(	const UsdPrim &	prim,
		const TfToken &	name
	)

static

Return a PhysxSchemaPhysxTendonAttachmentAPI with name name holding the prim prim.

Shorthand for PhysxSchemaPhysxTendonAttachmentAPI(prim, name);

static PHYSXSCHEMA_API std::vector<PhysxSchemaPhysxTendonAttachmentAPI> GetAll ( const UsdPrim & prim )

static

Return a vector of all named instances of PhysxSchemaPhysxTendonAttachmentAPI on the given prim.

PHYSXSCHEMA_API UsdAttribute GetGearingAttr ( ) const

Attachment distance scaling factor.

Range: (-inf, inf) Units: unitless


Declaration	`float gearing = 1`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetLocalPosAttr ( ) const

Location of the attachment.

Only considered if API is applied to an articulation link (i.e. with a PhysicsRigidBodyAPI). Units: (local-frame) distance


Declaration	`point3f localPos = (0, 0, 0)`
C++ Type	GfVec3f
Usd Type	SdfValueTypeNames->Point3f

TfToken GetName ( ) const

inline

Returns the name of this multiple-apply schema instance.

Definition at line 127 of file physxTendonAttachmentAPI.h.

PHYSXSCHEMA_API UsdAttribute GetParentAttachmentAttr ( ) const

API instance name of parent attachment at parentLink.


Declaration	`uniform token parentAttachment`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform

PHYSXSCHEMA_API UsdRelationship GetParentLinkRel ( ) const

Relationship to parent link that has a PhysxTendonAttachmentAPI or PhysxTendonAttachmentRootAPI with instance name parentAttachment applied.

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.

static PHYSXSCHEMA_API TfTokenVector GetSchemaAttributeNames	(	bool	includeInherited,
		const TfToken &	instanceName
	)

static

Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes for a given instance name.

Does not include attributes that may be authored by custom/extended methods of the schemas involved. The names returned will have the proper namespace prefix.

static PHYSXSCHEMA_API bool IsPhysxTendonAttachmentAPIPath	(	const SdfPath &	path,
		TfToken *	name
	)

static

Checks if the given path path is of an API schema of type PhysxTendonAttachmentAPI.

If so, it stores the instance name of the schema in name and returns true. Otherwise, it returns false.

static PHYSXSCHEMA_API bool IsSchemaPropertyBaseName ( const TfToken & baseName )

static

Checks if the given name baseName is the base name of a property of PhysxTendonAttachmentAPI.

Member Data Documentation

const UsdSchemaKind schemaKind = UsdSchemaKind::MultipleApplyAPI

static

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

See Also: UsdSchemaKind

Definition at line 81 of file physxTendonAttachmentAPI.h.

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

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