PhysX distance joint extended parameters. More...
Inherits UsdAPISchemaBase.
Public Member Functions | |
PhysxSchemaPhysxPhysicsDistanceJointAPI (const UsdPrim &prim=UsdPrim()) | |
Construct a PhysxSchemaPhysxPhysicsDistanceJointAPI on UsdPrim prim . More... | |
PhysxSchemaPhysxPhysicsDistanceJointAPI (const UsdSchemaBase &schemaObj) | |
Construct a PhysxSchemaPhysxPhysicsDistanceJointAPI on the prim held by schemaObj . More... | |
virtual PHYSXSCHEMA_API | ~PhysxSchemaPhysxPhysicsDistanceJointAPI () |
Destructor. More... | |
PHYSXSCHEMA_API UsdAttribute | GetSpringEnabledAttr () const |
Whether spring should be enabled. More... | |
PHYSXSCHEMA_API UsdAttribute | CreateSpringEnabledAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetSpringEnabledAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
PHYSXSCHEMA_API UsdAttribute | GetSpringStiffnessAttr () const |
Spring stiffness. More... | |
PHYSXSCHEMA_API UsdAttribute | CreateSpringStiffnessAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetSpringStiffnessAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
PHYSXSCHEMA_API UsdAttribute | GetSpringDampingAttr () const |
Spring damping. More... | |
PHYSXSCHEMA_API UsdAttribute | CreateSpringDampingAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetSpringDampingAttr(), 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 PhysxSchemaPhysxPhysicsDistanceJointAPI | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a PhysxSchemaPhysxPhysicsDistanceJointAPI holding the prim adhering to this schema at path on stage . More... | |
static PHYSXSCHEMA_API PhysxSchemaPhysxPhysicsDistanceJointAPI | Apply (const UsdPrim &prim) |
Applies this single-apply API schema to the given prim . More... | |
Static Public Attributes | |
static const UsdSchemaType | schemaType = UsdSchemaType::SingleApplyAPI |
Compile time constant representing what kind of schema this class is. More... | |
Protected Member Functions | |
PHYSXSCHEMA_API UsdSchemaType | _GetSchemaType () const override |
Returns the type of schema this class belongs to. More... | |
Friends | |
class | UsdSchemaRegistry |
PhysX distance joint extended parameters.
Definition at line 57 of file physxPhysicsDistanceJointAPI.h.
|
inlineexplicit |
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
Definition at line 69 of file physxPhysicsDistanceJointAPI.h.
|
inlineexplicit |
Construct a PhysxSchemaPhysxPhysicsDistanceJointAPI on the prim held by schemaObj
.
Should be preferred over PhysxSchemaPhysxPhysicsDistanceJointAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.
Definition at line 77 of file physxPhysicsDistanceJointAPI.h.
|
virtual |
Destructor.
|
overrideprotected |
Returns the type of schema this class belongs to.
|
static |
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.
PHYSXSCHEMA_API UsdAttribute CreateSpringDampingAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetSpringDampingAttr(), 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 CreateSpringEnabledAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetSpringEnabledAttr(), 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 CreateSpringStiffnessAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetSpringStiffnessAttr(), 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 |
Return a PhysxSchemaPhysxPhysicsDistanceJointAPI 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:
|
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.
PHYSXSCHEMA_API 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 |
PHYSXSCHEMA_API UsdAttribute GetSpringEnabledAttr | ( | ) | const |
Whether spring should be enabled.
(default off)
Declaration | bool physxPhysicsDistanceJoint:springEnabled = 0 |
C++ Type | bool |
Usd Type | SdfValueTypeNames->Bool |
PHYSXSCHEMA_API 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 |
|
static |
Compile time constant representing what kind of schema this class is.
Definition at line 63 of file physxPhysicsDistanceJointAPI.h.