A force field that slows rigid bodies by generating a force that is opposite to their velocity direction using the forumula f = -linear * v - square * v^2. More...
Inherits UsdAPISchemaBase.
Public Member Functions | |
ForceFieldSchemaPhysxForceFieldDragAPI (const UsdPrim &prim=UsdPrim(), const TfToken &name=TfToken()) | |
Construct a ForceFieldSchemaPhysxForceFieldDragAPI on UsdPrim prim with name name . More... | |
ForceFieldSchemaPhysxForceFieldDragAPI (const UsdSchemaBase &schemaObj, const TfToken &name) | |
Construct a ForceFieldSchemaPhysxForceFieldDragAPI on the prim held by schemaObj with name name . More... | |
virtual FORCEFIELDSCHEMA_API | ~ForceFieldSchemaPhysxForceFieldDragAPI () |
Destructor. More... | |
TfToken | GetName () const |
Returns the name of this multiple-apply schema instance. More... | |
FORCEFIELDSCHEMA_API UsdAttribute | GetMinimumSpeedAttr () const |
Drag forces are not applied below this minimum speed. More... | |
FORCEFIELDSCHEMA_API UsdAttribute | CreateMinimumSpeedAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetMinimumSpeedAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
FORCEFIELDSCHEMA_API UsdAttribute | GetLinearAttr () const |
linear sets a force that varies proportionally with the speed of the rigid body. More... | |
FORCEFIELDSCHEMA_API UsdAttribute | CreateLinearAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetLinearAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
FORCEFIELDSCHEMA_API UsdAttribute | GetSquareAttr () const |
square computes a force the varies with the square of the speed of the rigid body. More... | |
FORCEFIELDSCHEMA_API UsdAttribute | CreateSquareAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetSquareAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
Static Public Member Functions | |
static FORCEFIELDSCHEMA_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 FORCEFIELDSCHEMA_API TfTokenVector | GetSchemaAttributeNames (bool includeInherited, const TfToken &instanceName) |
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 FORCEFIELDSCHEMA_API ForceFieldSchemaPhysxForceFieldDragAPI | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a ForceFieldSchemaPhysxForceFieldDragAPI holding the prim adhering to this schema at path on stage . More... | |
static FORCEFIELDSCHEMA_API ForceFieldSchemaPhysxForceFieldDragAPI | Get (const UsdPrim &prim, const TfToken &name) |
Return a ForceFieldSchemaPhysxForceFieldDragAPI with name name holding the prim prim . More... | |
static FORCEFIELDSCHEMA_API std::vector < ForceFieldSchemaPhysxForceFieldDragAPI > | GetAll (const UsdPrim &prim) |
Return a vector of all named instances of ForceFieldSchemaPhysxForceFieldDragAPI on the given prim . More... | |
static FORCEFIELDSCHEMA_API bool | IsSchemaPropertyBaseName (const TfToken &baseName) |
Checks if the given name baseName is the base name of a property of PhysxForceFieldDragAPI. More... | |
static FORCEFIELDSCHEMA_API bool | IsPhysxForceFieldDragAPIPath (const SdfPath &path, TfToken *name) |
Checks if the given path path is of an API schema of type PhysxForceFieldDragAPI. More... | |
static FORCEFIELDSCHEMA_API bool | CanApply (const UsdPrim &prim, const TfToken &name, std::string *whyNot=nullptr) |
Returns true if this multiple-apply API schema can be applied, with the given instance name, name , to the given prim . More... | |
static FORCEFIELDSCHEMA_API ForceFieldSchemaPhysxForceFieldDragAPI | 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 UsdSchemaKind | schemaKind = UsdSchemaKind::MultipleApplyAPI |
Compile time constant representing what kind of schema this class is. More... | |
Protected Member Functions | |
FORCEFIELDSCHEMA_API UsdSchemaKind | _GetSchemaKind () const override |
Returns the kind of schema this class belongs to. More... | |
Friends | |
class | UsdSchemaRegistry |
A force field that slows rigid bodies by generating a force that is opposite to their velocity direction using the forumula f = -linear * v - square * v^2.
Definition at line 58 of file physxForceFieldDragAPI.h.
|
inlineexplicit |
Construct a ForceFieldSchemaPhysxForceFieldDragAPI on UsdPrim prim
with name name
.
Equivalent to ForceFieldSchemaPhysxForceFieldDragAPI::Get( prim.GetStage(), prim.GetPath().AppendProperty( "physxForceField:name"));
for a valid prim
, but will not immediately throw an error for an invalid prim
Definition at line 75 of file physxForceFieldDragAPI.h.
|
inlineexplicit |
Construct a ForceFieldSchemaPhysxForceFieldDragAPI on the prim held by schemaObj
with name name
.
Should be preferred over ForceFieldSchemaPhysxForceFieldDragAPI(schemaObj.GetPrim(), name), as it preserves SchemaBase state.
Definition at line 84 of file physxForceFieldDragAPI.h.
|
virtual |
Destructor.
|
overrideprotected |
Returns the kind 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 "PhysxForceFieldDragAPI:<i>name</i>" to the token-valued, listOp metadata apiSchemas on the prim. For example, if name
is 'instance1', the token 'PhysxForceFieldDragAPI:instance1' is added to 'apiSchemas'.
|
static |
Returns true if this multiple-apply API schema can be applied, with the given instance name, name
, to the given prim
.
If this schema can not be a applied 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.
FORCEFIELDSCHEMA_API UsdAttribute CreateLinearAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetLinearAttr(), 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
.
FORCEFIELDSCHEMA_API UsdAttribute CreateMinimumSpeedAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetMinimumSpeedAttr(), 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
.
FORCEFIELDSCHEMA_API UsdAttribute CreateSquareAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetSquareAttr(), 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 ForceFieldSchemaPhysxForceFieldDragAPI 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>.physxForceField:name .
This is shorthand for the following:
|
static |
Return a ForceFieldSchemaPhysxForceFieldDragAPI with name name
holding the prim prim
.
Shorthand for ForceFieldSchemaPhysxForceFieldDragAPI(prim, name);
|
static |
Return a vector of all named instances of ForceFieldSchemaPhysxForceFieldDragAPI on the given prim
.
FORCEFIELDSCHEMA_API UsdAttribute GetLinearAttr | ( | ) | const |
linear sets a force that varies proportionally with the speed of the rigid body.
Declaration | float physxForceFieldDrag:linear = 0 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
FORCEFIELDSCHEMA_API UsdAttribute GetMinimumSpeedAttr | ( | ) | const |
Drag forces are not applied below this minimum speed.
Declaration | float physxForceFieldDrag:minimumSpeed = 0 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
|
inline |
Returns the name of this multiple-apply schema instance.
Definition at line 110 of file physxForceFieldDragAPI.h.
|
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.
|
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.
FORCEFIELDSCHEMA_API UsdAttribute GetSquareAttr | ( | ) | const |
square computes a force the varies with the square of the speed of the rigid body.
Declaration | float physxForceFieldDrag:square = 0 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
|
static |
Checks if the given path path
is of an API schema of type PhysxForceFieldDragAPI.
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 PhysxForceFieldDragAPI.
|
static |
Compile time constant representing what kind of schema this class is.
Definition at line 64 of file physxForceFieldDragAPI.h.