usdrt::ForceFieldSchemaPhysxForceFieldWindAPI

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

Functions

Variables

class ForceFieldSchemaPhysxForceFieldWindAPI : public usdrt::UsdAPISchemaBase

A force field that simulates an unsteady wind that pushes rigid bodies.

Public Functions

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

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

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

inline virtual ~ForceFieldSchemaPhysxForceFieldWindAPI()

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

The drag coefficient determines how quickly the body moves along with the wind. Smaller values cause the body to react more slowly.

Declaration

float physxForceFieldWind:drag = 0

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateDragAttr() const

See GetDragAttr(), 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 GetAverageSpeedAttr() const

The average speed of the wind. Speed changes are added to this base speed, but the net speed can never drop below zero.

Declaration

float physxForceFieldWind:averageSpeed = 0

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateAverageSpeedAttr() const

See GetAverageSpeedAttr(), 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 GetAverageDirectionAttr() const

The initial direction of the wind in the world coordinate system. Wind direction changes are added to this base direciton.

Declaration

vector3f physxForceFieldWind:averageDirection = (0, 0, 0)

C++ Type

GfVec3f

Usd Type

SdfValueTypeNames->Vector3f

inline UsdAttribute CreateAverageDirectionAttr() const

See GetAverageDirectionAttr(), 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 GetSpeedVariationAttr() const

The magnitude of the random changes of the wind speed.

Declaration

float physxForceFieldWind:speedVariation = 0

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateSpeedVariationAttr() const

See GetSpeedVariationAttr(), 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 GetSpeedVariationFrequencyAttr() const

The frequency of the random changes of the wind speed.

Declaration

float physxForceFieldWind:speedVariationFrequency = 0

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateSpeedVariationFrequencyAttr() const

See GetSpeedVariationFrequencyAttr(), 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 GetDirectionVariationAttr() const

The magnitude of the random changes of the wind direction in the world coordinate system.

Declaration

float3 physxForceFieldWind:directionVariation = (0, 0, 0)

C++ Type

GfVec3f

Usd Type

SdfValueTypeNames->Float3

inline UsdAttribute CreateDirectionVariationAttr() const

See GetDirectionVariationAttr(), 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 GetDirectionVariationFrequencyAttr() const

The frequency of the random variations of the wind direction in the world coordinate system.

Declaration

float3 physxForceFieldWind:directionVariationFrequency = (0, 0, 0)

C++ Type

GfVec3f

Usd Type

SdfValueTypeNames->Float3

inline UsdAttribute CreateDirectionVariationFrequencyAttr() const

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

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

Returns

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