usdrt::PhysxSchemaPhysxPhysicsDistanceJointAPI

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

Functions

Variables

class PhysxSchemaPhysxPhysicsDistanceJointAPI : public usdrt::UsdAPISchemaBase

PhysX distance joint extended parameters.

Public Functions

inline explicit PhysxSchemaPhysxPhysicsDistanceJointAPI(const UsdPrim &prim = UsdPrim())

Construct a PhysxSchemaPhysxPhysicsDistanceJointAPI on UsdPrim prim. Equivalent to PhysxSchemaPhysxPhysicsDistanceJointAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim.

inline explicit PhysxSchemaPhysxPhysicsDistanceJointAPI(const UsdSchemaBase &schemaObj)

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

inline virtual ~PhysxSchemaPhysxPhysicsDistanceJointAPI()

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 UsdAttribute GetSpringEnabledAttr() const

Whether spring should be enabled. (default off)

Declaration

bool physxPhysicsDistanceJoint:springEnabled = 0

C++ Type

bool

Usd Type

SdfValueTypeNames->Bool

inline UsdAttribute CreateSpringEnabledAttr() const

See GetSpringEnabledAttr(), 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 GetSpringStiffnessAttr() const

Spring stiffness. Range: [0, inf) Units: force / distance = mass / seconds^2.

Declaration

float physxPhysicsDistanceJoint:springStiffness = 0

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateSpringStiffnessAttr() const

See GetSpringStiffnessAttr(), 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 GetSpringDampingAttr() const

Spring damping. Range: [0, inf) Units: force * seconds / distance = mass / seconds.

Declaration

float physxPhysicsDistanceJoint:springDamping = 0

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateSpringDampingAttr() const

See GetSpringDampingAttr(), 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 PhysxSchemaPhysxPhysicsDistanceJointAPI Apply(const UsdPrim &prim)

Applies this single-apply API schema to the given prim. This information is stored by adding “PhysxPhysicsDistanceJointAPI” to the token-valued, listOp metadata apiSchemas on the prim.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

Returns

A valid PhysxSchemaPhysxPhysicsDistanceJointAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxPhysicsDistanceJointAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.

Public Static Attributes

static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI

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.