usdrt::PhysxSchemaPhysxJointAPI

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

Functions

usdrt::PhysxSchemaPhysxJointAPI::Apply: Applies this single-apply API schema to the given prim . This information is stored by adding "PhysxJointAPI" to the token-valued, listOp metadata apiSchemas on the prim.
usdrt::PhysxSchemaPhysxJointAPI::CreateArmatureAttr: See GetArmatureAttr() , 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::PhysxSchemaPhysxJointAPI::CreateEnableProjectionAttr: See GetEnableProjectionAttr() , 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::PhysxSchemaPhysxJointAPI::CreateJointFrictionAttr: See GetJointFrictionAttr() , 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::PhysxSchemaPhysxJointAPI::CreateMaxJointVelocityAttr: See GetMaxJointVelocityAttr() , 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::PhysxSchemaPhysxJointAPI::GetArmatureAttr: Armature can help stabilize an articulation by adding to the inertial response of a joint. Conceptually, armature represents the inertia of an actuator driving the joint. Note that this parameter is used only when the joint belongs to an articulation. Range: [0, inf) Units: Linear joint - mass Angular joint - mass * (distance)^2.
usdrt::PhysxSchemaPhysxJointAPI::GetEnableProjectionAttr: Whether the actors should get projected for this constraint (the direction will be chosen by PhysX).
usdrt::PhysxSchemaPhysxJointAPI::GetJointFrictionAttr: Joint friction. Only applies for joints that are parts of an articulation. Range: [0, inf) Units: dimensionless.
usdrt::PhysxSchemaPhysxJointAPI::GetMaxJointVelocityAttr: Maximum joint velocity. Range: [0, inf) Units: Linear joint - distance / time Angular joint - degrees / time.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::PhysxSchemaPhysxJointAPI::PhysxSchemaPhysxJointAPI: Construct a PhysxSchemaPhysxJointAPI on the prim held by schemaObj . Should be preferred over PhysxSchemaPhysxJointAPI (schemaObj.GetPrim()), as it preserves SchemaBase state.
usdrt::PhysxSchemaPhysxJointAPI::PhysxSchemaPhysxJointAPI: Construct a PhysxSchemaPhysxJointAPI on UsdPrim prim . Equivalent to PhysxSchemaPhysxJointAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim .
usdrt::DestructionSchemaDestructibleBaseAPI::_GetInstanceName: Returns the instance name of the API schema object belonging to a multiple-apply API schema.
usdrt::PhysxSchemaPhysxJointAPI::operator bool: Boolean operator.
usdrt::PhysxSchemaPhysxJointAPI::~PhysxSchemaPhysxJointAPI: Destructor.

Variables

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

class PhysxSchemaPhysxJointAPI : public usdrt::UsdAPISchemaBase 

PhysX joint extended parameters.

Public Functions

inline explicit PhysxSchemaPhysxJointAPI(const UsdPrim &prim = UsdPrim()): Construct a PhysxSchemaPhysxJointAPI on UsdPrim prim. Equivalent to PhysxSchemaPhysxJointAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim.

inline explicit PhysxSchemaPhysxJointAPI(const UsdSchemaBase &schemaObj): Construct a PhysxSchemaPhysxJointAPI on the prim held by schemaObj . Should be preferred over PhysxSchemaPhysxJointAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

inline virtual ~PhysxSchemaPhysxJointAPI(): 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 GetEnableProjectionAttr() const

Whether the actors should get projected for this constraint (the direction will be chosen by PhysX).


Declaration	`bool physxJoint:enableProjection = 0`
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

inline UsdAttribute CreateEnableProjectionAttr() const: See GetEnableProjectionAttr(), 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 GetJointFrictionAttr() const

Joint friction. Only applies for joints that are parts of an articulation. Range: [0, inf) Units: dimensionless.


Declaration	`float physxJoint:jointFriction = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateJointFrictionAttr() const: See GetJointFrictionAttr(), 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 GetMaxJointVelocityAttr() const

Maximum joint velocity. Range: [0, inf) Units: Linear joint - distance / time Angular joint - degrees / time.


Declaration	`float physxJoint:maxJointVelocity = 1000000`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateMaxJointVelocityAttr() const: See GetMaxJointVelocityAttr(), 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 GetArmatureAttr() const

Armature can help stabilize an articulation by adding to the inertial response of a joint. Conceptually, armature represents the inertia of an actuator driving the joint. Note that this parameter is used only when the joint belongs to an articulation. Range: [0, inf) Units: Linear joint - mass Angular joint - mass * (distance)^2.


Declaration	`float physxJoint:armature = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateArmatureAttr() const: See GetArmatureAttr(), 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 PhysxSchemaPhysxJointAPI Apply(const UsdPrim &prim)

Applies this single-apply API schema to the given prim. This information is stored by adding “PhysxJointAPI” 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 PhysxSchemaPhysxJointAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxJointAPI 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.