usdrt::ForceFieldSchemaPhysxForceFieldNoiseAPI

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

Functions

Variables

class ForceFieldSchemaPhysxForceFieldNoiseAPI : public usdrt::UsdAPISchemaBase

A force field that adds randomized motion to a rigid body.

Public Functions

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

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

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

inline virtual ~ForceFieldSchemaPhysxForceFieldNoiseAPI()

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 noise. Smaller values cause the body to react more slowly.

Declaration

float physxForceFieldNoise: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 GetAmplitudeAttr() const

The magnitude of the oscillations along each of the three local axes.

Declaration

float3 physxForceFieldNoise:amplitude = (0, 0, 0)

C++ Type

GfVec3f

Usd Type

SdfValueTypeNames->Float3

inline UsdAttribute CreateAmplitudeAttr() const

See GetAmplitudeAttr(), 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 GetFrequencyAttr() const

The frequency of the oscillations for each of the three local axes.

Declaration

float3 physxForceFieldNoise:frequency = (0, 0, 0)

C++ Type

GfVec3f

Usd Type

SdfValueTypeNames->Float3

inline UsdAttribute CreateFrequencyAttr() const

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

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

Returns

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