usdrt::PhysxSchemaPhysxLimitAPI

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

Functions

Variables

class PhysxSchemaPhysxLimitAPI : public usdrt::UsdAPISchemaBase

Public Functions

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

Construct a PhysxSchemaPhysxLimitAPI on UsdPrim prim with name name . Equivalent to PhysxSchemaPhysxLimitAPI::Get( prim.GetStage(), prim.GetPath().AppendProperty( “physxLimit:name”));.

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

inline explicit PhysxSchemaPhysxLimitAPI(const UsdSchemaBase &schemaObj, const TfToken &name)

Construct a PhysxSchemaPhysxLimitAPI on the prim held by schemaObj with name name . Should be preferred over PhysxSchemaPhysxLimitAPI(schemaObj.GetPrim(), name), as it preserves SchemaBase state.

inline virtual ~PhysxSchemaPhysxLimitAPI()

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 GetRestitutionAttr() const

Controls the amount of bounce when the joint hits a limit. Range: [0, inf) Units: dimensionless.

Declaration

float restitution = 0

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateRestitutionAttr() const

See GetRestitutionAttr(), 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 GetBounceThresholdAttr() const

Determines the minimum impact velocity which will cause the joint to bounce. Range: [0, inf) Units: linear - distance / seconds angular - degrees / seconds.

Declaration

float bounceThreshold = 0

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateBounceThresholdAttr() const

See GetBounceThresholdAttr(), 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 GetStiffnessAttr() const

If greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit. Range: [0, inf) Units: linear - force / distance angular - torque / degrees.

Declaration

float stiffness = 0

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateStiffnessAttr() const

See GetStiffnessAttr(), 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 GetDampingAttr() const

If spring is greater than zero, this is the damping of the limit spring. Range: [0, inf) Units: linear - force / distance * seconds angular - torque / degrees * seconds.

Declaration

float damping = 0

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateDampingAttr() const

See GetDampingAttr(), 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 GetContactDistanceAttr() const

The distance inside the limit value at which the limit will be considered to be active by the solver. As this value is made larger, the limit becomes active more quickly. It thus becomes less likely to violate the extents of the limit, but more expensive. Range: [0, inf) Units: linear - distance angular - degrees.

Declaration

float contactDistance = 0

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateContactDistanceAttr() const

See GetContactDistanceAttr(), 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 PhysxSchemaPhysxLimitAPI 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 “PhysxLimitAPI:<i>name</i>” to the token-valued, listOp metadata apiSchemas on the prim. For example, if name is ‘instance1’, the token ‘PhysxLimitAPI:instance1’ is added to ‘apiSchemas’.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

Returns

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