usdrt::UsdPhysicsLimitAPI

Defined in usdrt/scenegraph/usd/usdPhysics/limitAPI.h

Functions

Variables

class UsdPhysicsLimitAPI : public usdrt::UsdAPISchemaBase

The PhysicsLimitAPI can be applied to a PhysicsJoint and will restrict the movement along an axis. PhysicsLimitAPI is a multipleApply schema: The PhysicsJoint can be restricted along “transX”, “transY”, “transZ”, “rotX”, “rotY”, “rotZ”, “distance”. Setting these as a multipleApply schema TfToken name will define the degree of freedom the PhysicsLimitAPI is applied to. Note that if the low limit is higher than the high limit, motion along this axis is considered locked.

Public Functions

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

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

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

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

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

inline virtual ~UsdPhysicsLimitAPI()

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

Lower limit. Units: degrees or distance depending on trans or rot axis applied to. -inf means not limited in negative direction.

Declaration

float physics:low = -inf

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateLowAttr() const

See GetLowAttr(), 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 GetHighAttr() const

Upper limit. Units: degrees or distance depending on trans or rot axis applied to. inf means not limited in positive direction.

Declaration

float physics:high = inf

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateHighAttr() const

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

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

Returns

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