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

Inherits UsdAPISchemaBase.

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

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

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

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

PHYSXSCHEMA_API UsdAttribute	GetRestLengthAttr () const
	Sub-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
	Sub-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
	Sub-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...

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

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

static PHYSXSCHEMA_API std::vector < PhysxSchemaPhysxTendonAttachmentLeafAPI >	GetAll (const UsdPrim &prim)
	Return a vector of all named instances of PhysxSchemaPhysxTendonAttachmentLeafAPI 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 PhysxTendonAttachmentLeafAPI. More...

static PHYSXSCHEMA_API bool	IsPhysxTendonAttachmentLeafAPIPath (const SdfPath &path, TfToken *name)
	Checks if the given path `path` is of an API schema of type PhysxTendonAttachmentLeafAPI. 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 PhysxSchemaPhysxTendonAttachmentLeafAPI	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.

The leaf API creates a new sub-tendon between the leaf and the root attachment. A leaf cannot have any children, i.e. there cannot be another attachment API that refers to a leaf as parent.

Definition at line 62 of file physxTendonAttachmentLeafAPI.h.

Constructor & Destructor Documentation

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

inlineexplicit

Construct a PhysxSchemaPhysxTendonAttachmentLeafAPI on UsdPrim prim with name name .

Equivalent to PhysxSchemaPhysxTendonAttachmentLeafAPI::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 79 of file physxTendonAttachmentLeafAPI.h.

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

inlineexplicit

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

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

Definition at line 88 of file physxTendonAttachmentLeafAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxTendonAttachmentLeafAPI ( )

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

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

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 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.

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 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.

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

static

Return a PhysxSchemaPhysxTendonAttachmentLeafAPI 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());
*  PhysxSchemaPhysxTendonAttachmentLeafAPI(
*      stage->GetPrimAtPath(path.GetPrimPath()), name);
*  

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

static

Return a PhysxSchemaPhysxTendonAttachmentLeafAPI with name name holding the prim prim.

Shorthand for PhysxSchemaPhysxTendonAttachmentLeafAPI(prim, name);

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

static

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

PHYSXSCHEMA_API UsdAttribute GetLowerLimitAttr ( ) const

Sub-tendon length lower limit.

Range: (-inf, upperLimit] Units: distance


Declaration	`float lowerLimit = -inf`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

TfToken GetName ( ) const

inline

Returns the name of this multiple-apply schema instance.

Definition at line 114 of file physxTendonAttachmentLeafAPI.h.

PHYSXSCHEMA_API UsdAttribute GetRestLengthAttr ( ) const

Sub-tendon rest length.

If set to a negative value, the rest length is computed internally from the articulation pose and the attachment positions at simulation start. Range: [0, inf) Units: distance


Declaration	`float restLength = -inf`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

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.

PHYSXSCHEMA_API UsdAttribute GetUpperLimitAttr ( ) const

Sub-tendon length upper limit.

Range: [lowerLimit, inf) Units: distance


Declaration	`float upperLimit = inf`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

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

static

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

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 PhysxTendonAttachmentLeafAPI.

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

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

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