PhysX joint extended parameters. More...

Inherits UsdAPISchemaBase.

Public Member Functions
	PhysxSchemaPhysxJointAPI (const UsdPrim &prim=UsdPrim())
	Construct a PhysxSchemaPhysxJointAPI on UsdPrim `prim` . More...

	PhysxSchemaPhysxJointAPI (const UsdSchemaBase &schemaObj)
	Construct a PhysxSchemaPhysxJointAPI on the prim held by `schemaObj` . More...

virtual PHYSXSCHEMA_API	~PhysxSchemaPhysxJointAPI ()
	Destructor. More...

PHYSXSCHEMA_API UsdAttribute	GetEnableProjectionAttr () const
	Whether the actors should get projected for this constraint (the direction will be chosen by PhysX). More...

PHYSXSCHEMA_API UsdAttribute	CreateEnableProjectionAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetEnableProjectionAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetJointFrictionAttr () const
	Joint friction. More...

PHYSXSCHEMA_API UsdAttribute	CreateJointFrictionAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetJointFrictionAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetMaxJointVelocityAttr () const
	Maximum joint velocity. More...

PHYSXSCHEMA_API UsdAttribute	CreateMaxJointVelocityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetMaxJointVelocityAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetArmatureAttr () const
	Armature can help stabilize an articulation by adding to the inertial response of a joint. More...

PHYSXSCHEMA_API UsdAttribute	CreateArmatureAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetArmatureAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

Static Public Member Functions
static PHYSXSCHEMA_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
	Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More...

static PHYSXSCHEMA_API PhysxSchemaPhysxJointAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxJointAPI holding the prim adhering to this schema at `path` on `stage`. More...

static PHYSXSCHEMA_API bool	CanApply (const UsdPrim &prim, std::string *whyNot=nullptr)
	Returns true if this single-apply API schema can be applied to the given `prim`. More...

static PHYSXSCHEMA_API PhysxSchemaPhysxJointAPI	Apply (const UsdPrim &prim)
	Applies this single-apply API schema to the given `prim`. More...

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::SingleApplyAPI
	Compile time constant representing what kind of schema this class is. More...

Protected Member Functions
PHYSXSCHEMA_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to. More...

Friends
class	UsdSchemaRegistry

Detailed Description

PhysX joint extended parameters.

Definition at line 57 of file physxJointAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxJointAPI ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

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

Definition at line 69 of file physxJointAPI.h.

PhysxSchemaPhysxJointAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxJointAPI on the prim held by schemaObj .

Should be preferred over PhysxSchemaPhysxJointAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 77 of file physxJointAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxJointAPI ( )

virtual

Destructor.

Member Function Documentation

PHYSXSCHEMA_API UsdSchemaKind _GetSchemaKind ( ) const

overrideprotected

Returns the kind of schema this class belongs to.

See Also: UsdSchemaKind

static PHYSXSCHEMA_API PhysxSchemaPhysxJointAPI Apply ( const UsdPrim & prim )

static

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.

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.

See Also: UsdPrim::GetAppliedSchemas(); UsdPrim::HasAPI(); UsdPrim::CanApplyAPI(); UsdPrim::ApplyAPI(); UsdPrim::RemoveAPI()

static PHYSXSCHEMA_API bool CanApply	(	const UsdPrim &	prim,
		std::string *	whyNot = `nullptr`
	)

static

Returns true if this single-apply API schema can be applied to the given prim.

If this schema can not be a applied to the prim, this returns false and, if provided, populates whyNot with the reason it can not be applied.

Note that if CanApply returns false, that does not necessarily imply that calling Apply will fail. Callers are expected to call CanApply before calling Apply if they want to ensure that it is valid to apply a schema.

See Also: UsdPrim::GetAppliedSchemas(); UsdPrim::HasAPI(); UsdPrim::CanApplyAPI(); UsdPrim::ApplyAPI(); UsdPrim::RemoveAPI()

PHYSXSCHEMA_API UsdAttribute CreateArmatureAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetArmatureAttr(), and also Usd_Create_Or_Get_Property 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.

PHYSXSCHEMA_API UsdAttribute CreateEnableProjectionAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetEnableProjectionAttr(), and also Usd_Create_Or_Get_Property 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.

PHYSXSCHEMA_API UsdAttribute CreateJointFrictionAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetJointFrictionAttr(), and also Usd_Create_Or_Get_Property 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.

PHYSXSCHEMA_API UsdAttribute CreateMaxJointVelocityAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetMaxJointVelocityAttr(), and also Usd_Create_Or_Get_Property 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.

static PHYSXSCHEMA_API PhysxSchemaPhysxJointAPI Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

static

Return a PhysxSchemaPhysxJointAPI holding the prim adhering to this schema at path on stage.

If no prim exists at path on stage, or if the prim at that path does not adhere to this schema, return an invalid schema object. This is shorthand for the following:

* PhysxSchemaPhysxJointAPI(stage->GetPrimAtPath(path));

*

PHYSXSCHEMA_API 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

PHYSXSCHEMA_API 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

PHYSXSCHEMA_API 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

PHYSXSCHEMA_API 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

static PHYSXSCHEMA_API const TfTokenVector& GetSchemaAttributeNames ( bool includeInherited = true )

static

Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.

Does not include attributes that may be authored by custom/extended methods of the schemas involved.

Member Data Documentation

const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI

static

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

See Also: UsdSchemaKind

Definition at line 63 of file physxJointAPI.h.

The documentation for this class was generated from the following file:

C:/g/19412595/omni/schema/source/physxSchema/physxJointAPI.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation