usdrt::PhysxSchemaPhysxTendonAttachmentLeafAPI

Defined in usdrt/scenegraph/usd/physxSchema/physxTendonAttachmentLeafAPI.h

Functions

usdrt::PhysxSchemaPhysxTendonAttachmentLeafAPI::Apply: Applies this multiple-apply API schema to the given prim along with the given instance name, name .
usdrt::PhysxSchemaPhysxTendonAttachmentLeafAPI::CreateLowerLimitAttr: See GetLowerLimitAttr() , and also Create vs Get Property Methods 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 .
usdrt::PhysxSchemaPhysxTendonAttachmentLeafAPI::CreateRestLengthAttr: See GetRestLengthAttr() , and also Create vs Get Property Methods 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 .
usdrt::PhysxSchemaPhysxTendonAttachmentLeafAPI::CreateUpperLimitAttr: See GetUpperLimitAttr() , and also Create vs Get Property Methods 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 .
usdrt::PhysxSchemaPhysxTendonAttachmentLeafAPI::GetLowerLimitAttr: Sub-tendon length lower limit. Range: (-inf, upperLimit] Units: distance.
usdrt::PhysxSchemaPhysxTendonAttachmentLeafAPI::GetName: Returns the name of this multiple-apply schema instance.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::PhysxSchemaPhysxTendonAttachmentLeafAPI::GetRestLengthAttr: 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.
usdrt::PhysxSchemaPhysxTendonAttachmentLeafAPI::GetUpperLimitAttr: Sub-tendon length upper limit. Range: [lowerLimit, inf) Units: distance.
usdrt::PhysxSchemaPhysxTendonAttachmentLeafAPI::PhysxSchemaPhysxTendonAttachmentLeafAPI: Construct a PhysxSchemaPhysxTendonAttachmentLeafAPI on UsdPrim prim with name name . Equivalent to PhysxSchemaPhysxTendonAttachmentLeafAPI::Get( prim.GetStage(), prim.GetPath().AppendProperty( "physxTendon:name"));.
usdrt::PhysxSchemaPhysxTendonAttachmentLeafAPI::PhysxSchemaPhysxTendonAttachmentLeafAPI: 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.
usdrt::DestructionSchemaDestructibleBaseAPI::_GetInstanceName: Returns the instance name of the API schema object belonging to a multiple-apply API schema.
usdrt::PhysxSchemaPhysxTendonAttachmentLeafAPI::operator bool: Boolean operator.
usdrt::PhysxSchemaPhysxTendonAttachmentLeafAPI::~PhysxSchemaPhysxTendonAttachmentLeafAPI: Destructor.

Variables

usdrt::PhysxSchemaPhysxTendonAttachmentLeafAPI::schemaType: Compile time constant representing what kind of schema this class is.

class PhysxSchemaPhysxTendonAttachmentLeafAPI : public usdrt::UsdAPISchemaBase 

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.

Public Functions

inline explicit PhysxSchemaPhysxTendonAttachmentLeafAPI(const UsdPrim &prim = UsdPrim(), const TfToken &name = TfToken())

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

inline explicit PhysxSchemaPhysxTendonAttachmentLeafAPI(const UsdSchemaBase &schemaObj, const TfToken &name): 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.

inline virtual ~PhysxSchemaPhysxTendonAttachmentLeafAPI(): Destructor.

inline operator bool() const

Boolean operator.

Returns: Return true if the contained prim is has this api schema applied using HasAPI, and false otherwise.

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

inline 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

inline UsdAttribute CreateRestLengthAttr() const: See GetRestLengthAttr(), and also Create vs Get Property Methods 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.

inline UsdAttribute GetLowerLimitAttr() const

Sub-tendon length lower limit. Range: (-inf, upperLimit] Units: distance.


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

inline UsdAttribute CreateLowerLimitAttr() const: See GetLowerLimitAttr(), and also Create vs Get Property Methods 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.

inline UsdAttribute GetUpperLimitAttr() const

Sub-tendon length upper limit. Range: [lowerLimit, inf) Units: distance.


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

inline UsdAttribute CreateUpperLimitAttr() const: See GetUpperLimitAttr(), and also Create vs Get Property Methods 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.

UsdPrim GetPrim() const: Return this schema object’s held prim.

SdfPath GetPath() const: Return the SdfPath to this schema object’s held prim.

Public Static Functions

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

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

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

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.

Public Static Attributes

static const UsdSchemaType schemaType = UsdSchemaType::MultipleApplyAPI 

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

See also

UsdSchemaType

Protected Functions

inline const TfToken &_GetInstanceName() const

Returns the instance name of the API schema object belonging to a multiple-apply API schema.

The returned instance name will be empty for non-applied and single-apply API schemas.