usdrt::ForceFieldSchemaPhysxForceFieldLinearAPI

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

Functions

Variables

class ForceFieldSchemaPhysxForceFieldLinearAPI : public usdrt::UsdAPISchemaBase

A linear force field that attracts and/or repels rigid bodies from a line, defined by a point and direction vector, depending on the function coefficients. Positive values attract and negative values repel. The net force on the rigid body is calculated using f = constant + linear * r + inverseSquare / r^2, where r is the distance to the closest point on the line.

Public Functions

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

Construct a ForceFieldSchemaPhysxForceFieldLinearAPI on UsdPrim prim with name name . Equivalent to ForceFieldSchemaPhysxForceFieldLinearAPI::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 ForceFieldSchemaPhysxForceFieldLinearAPI(const UsdSchemaBase &schemaObj, const TfToken &name)

Construct a ForceFieldSchemaPhysxForceFieldLinearAPI on the prim held by schemaObj with name name . Should be preferred over ForceFieldSchemaPhysxForceFieldLinearAPI(schemaObj.GetPrim(), name), as it preserves SchemaBase state.

inline virtual ~ForceFieldSchemaPhysxForceFieldLinearAPI()

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 GetDirectionAttr() const

The direction vector of the line.

Declaration

vector3f physxForceFieldLinear:direction = (0, 0, 0)

C++ Type

GfVec3f

Usd Type

SdfValueTypeNames->Vector3f

inline UsdAttribute CreateDirectionAttr() const

See GetDirectionAttr(), 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 GetConstantAttr() const

constant applies a steady force.

Declaration

float physxForceFieldLinear:constant = 0

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateConstantAttr() const

See GetConstantAttr(), 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 with distance to the line.

Declaration

float physxForceFieldLinear: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 GetInverseSquareAttr() const

inverseSquare sets a force that varies with the reciprocal of the square of the distance to the line.

Declaration

float physxForceFieldLinear:inverseSquare = 0

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateInverseSquareAttr() const

See GetInverseSquareAttr(), 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 ForceFieldSchemaPhysxForceFieldLinearAPI 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 “PhysxForceFieldLinearAPI:<i>name</i>” to the token-valued, listOp metadata apiSchemas on the prim. For example, if name is ‘instance1’, the token ‘PhysxForceFieldLinearAPI:instance1’ is added to ‘apiSchemas’.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

Returns

A valid ForceFieldSchemaPhysxForceFieldLinearAPI object is returned upon success. An invalid (or empty) ForceFieldSchemaPhysxForceFieldLinearAPI 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.