usdrt::ForceFieldSchemaPhysxForceFieldDragAPI

Defined in usdrt/scenegraph/usd/forceFieldSchema/physxForceFieldDragAPI.h

Functions

usdrt::ForceFieldSchemaPhysxForceFieldDragAPI::Apply: Applies this multiple-apply API schema to the given prim along with the given instance name, name .
usdrt::ForceFieldSchemaPhysxForceFieldDragAPI::CreateLinearAttr: See GetLinearAttr() , 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::ForceFieldSchemaPhysxForceFieldDragAPI::CreateMinimumSpeedAttr: See GetMinimumSpeedAttr() , 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::ForceFieldSchemaPhysxForceFieldDragAPI::CreateSquareAttr: See GetSquareAttr() , 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::ForceFieldSchemaPhysxForceFieldDragAPI::ForceFieldSchemaPhysxForceFieldDragAPI: 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.
usdrt::ForceFieldSchemaPhysxForceFieldDragAPI::ForceFieldSchemaPhysxForceFieldDragAPI: Construct a ForceFieldSchemaPhysxForceFieldDragAPI on UsdPrim prim with name name . Equivalent to ForceFieldSchemaPhysxForceFieldDragAPI::Get( prim.GetStage(), prim.GetPath().AppendProperty( "physxForceField:name"));.
usdrt::ForceFieldSchemaPhysxForceFieldDragAPI::GetLinearAttr: linear sets a force that varies proportionally with the speed of the rigid body.
usdrt::ForceFieldSchemaPhysxForceFieldDragAPI::GetMinimumSpeedAttr: Drag forces are not applied below this minimum speed.
usdrt::ForceFieldSchemaPhysxForceFieldDragAPI::GetName: Returns the name of this multiple-apply schema instance.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::ForceFieldSchemaPhysxForceFieldDragAPI::GetSquareAttr: square computes a force the varies with the square of the speed of the rigid body.
usdrt::DestructionSchemaDestructibleBaseAPI::_GetInstanceName: Returns the instance name of the API schema object belonging to a multiple-apply API schema.
usdrt::ForceFieldSchemaPhysxForceFieldDragAPI::operator bool: Boolean operator.
usdrt::ForceFieldSchemaPhysxForceFieldDragAPI::~ForceFieldSchemaPhysxForceFieldDragAPI: Destructor.

Variables

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

class ForceFieldSchemaPhysxForceFieldDragAPI : public usdrt::UsdAPISchemaBase 

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.

Public Functions

inline explicit ForceFieldSchemaPhysxForceFieldDragAPI(const UsdPrim &prim = UsdPrim(), const TfToken &name = TfToken())

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

inline explicit ForceFieldSchemaPhysxForceFieldDragAPI(const UsdSchemaBase &schemaObj, const TfToken &name): 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.

inline virtual ~ForceFieldSchemaPhysxForceFieldDragAPI(): 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 TfToken GetName() const: Returns the name of this multiple-apply schema instance.

inline 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 UsdAttribute CreateMinimumSpeedAttr() const: See GetMinimumSpeedAttr(), 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 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

inline UsdAttribute CreateLinearAttr() const: See GetLinearAttr(), 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 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

inline UsdAttribute CreateSquareAttr() const: See GetSquareAttr(), 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 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.

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’.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

Returns: A valid ForceFieldSchemaPhysxForceFieldDragAPI object is returned upon success. An invalid (or empty) ForceFieldSchemaPhysxForceFieldDragAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.

Public Static Attributes

static const UsdSchemaType schemaType = UsdSchemaType::MultipleApplyAPI 

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.