The PhysicsLimitAPI can be applied to a PhysicsJoint and will restrict the movement along an axis. More...
Inherits UsdAPISchemaBase.
Public Member Functions | |
UsdPhysicsLimitAPI (const UsdPrim &prim=UsdPrim(), const TfToken &name=TfToken()) | |
Construct a UsdPhysicsLimitAPI on UsdPrim prim with name name . More... | |
UsdPhysicsLimitAPI (const UsdSchemaBase &schemaObj, const TfToken &name) | |
Construct a UsdPhysicsLimitAPI on the prim held by schemaObj with name name . More... | |
virtual USDPHYSICS_API | ~UsdPhysicsLimitAPI () |
Destructor. More... | |
TfToken | GetName () const |
Returns the name of this multiple-apply schema instance. More... | |
USDPHYSICS_API UsdAttribute | GetLowAttr () const |
Lower limit. More... | |
USDPHYSICS_API UsdAttribute | CreateLowAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetLowAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
USDPHYSICS_API UsdAttribute | GetHighAttr () const |
Upper limit. More... | |
USDPHYSICS_API UsdAttribute | CreateHighAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetHighAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
Static Public Member Functions | |
static USDPHYSICS_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true, const TfToken instanceName=TfToken()) |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes for a given instance name. More... | |
static USDPHYSICS_API UsdPhysicsLimitAPI | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a UsdPhysicsLimitAPI holding the prim adhering to this schema at path on stage . More... | |
static USDPHYSICS_API UsdPhysicsLimitAPI | Get (const UsdPrim &prim, const TfToken &name) |
Return a UsdPhysicsLimitAPI with name name holding the prim prim . More... | |
static USDPHYSICS_API bool | IsSchemaPropertyBaseName (const TfToken &baseName) |
Checks if the given name baseName is the base name of a property of PhysicsLimitAPI. More... | |
static USDPHYSICS_API bool | IsPhysicsLimitAPIPath (const SdfPath &path, TfToken *name) |
Checks if the given path path is of an API schema of type PhysicsLimitAPI. More... | |
static USDPHYSICS_API 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 . More... | |
Static Public Attributes | |
static const UsdSchemaType | schemaType = UsdSchemaType::MultipleApplyAPI |
Compile time constant representing what kind of schema this class is. More... | |
Protected Member Functions | |
USDPHYSICS_API UsdSchemaType | _GetSchemaType () const override |
Returns the type of schema this class belongs to. More... | |
Friends | |
class | UsdSchemaRegistry |
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.
Definition at line 63 of file limitAPI.h.
|
inlineexplicit |
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
Definition at line 80 of file limitAPI.h.
|
inlineexplicit |
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.
Definition at line 89 of file limitAPI.h.
|
virtual |
Destructor.
|
overrideprotected |
Returns the type of schema this class belongs to.
|
static |
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'.
USDPHYSICS_API UsdAttribute CreateHighAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetHighAttr(), 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
.
USDPHYSICS_API UsdAttribute CreateLowAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetLowAttr(), 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 UsdPhysicsLimitAPI 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. path
must be of the format <path>.limit:name .
This is shorthand for the following:
|
static |
Return a UsdPhysicsLimitAPI with name name
holding the prim prim
.
Shorthand for UsdPhysicsLimitAPI(prim, name);
USDPHYSICS_API 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 |
USDPHYSICS_API 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 |
Returns the name of this multiple-apply schema instance.
Definition at line 109 of file limitAPI.h.
|
static |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes for a given instance name.
Does not include attributes that may be authored by custom/extended methods of the schemas involved. The names returned will have the proper namespace prefix.
|
static |
Checks if the given path path
is of an API schema of type PhysicsLimitAPI.
If so, it stores the instance name of the schema in name
and returns true. Otherwise, it returns false.
|
static |
Checks if the given name baseName
is the base name of a property of PhysicsLimitAPI.
|
static |
Compile time constant representing what kind of schema this class is.
Definition at line 69 of file limitAPI.h.