Forcefields Schema#

Variables

TfStaticData<ForceFieldSchemaTokensType> ForceFieldSchemaTokens#

A global variable with static, efficient TfToken for use in all public USD API.

See also

class ForceFieldSchemaPhysxForceFieldAPI : public UsdAPISchemaBase#

Force field base class that simply specifies the position and enables or disables the ForceField.

Public Functions

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

Construct a ForceFieldSchemaPhysxForceFieldAPI on UsdPrim prim with name name . Equivalent to ForceFieldSchemaPhysxForceFieldAPI::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 ForceFieldSchemaPhysxForceFieldAPI( const UsdSchemaBase &schemaObj, const TfToken &name, )#: Construct a ForceFieldSchemaPhysxForceFieldAPI on the prim held by schemaObj with name name. Should be preferred over ForceFieldSchemaPhysxForceFieldAPI(schemaObj.GetPrim(), name), as it preserves SchemaBase state.

virtual ~ForceFieldSchemaPhysxForceFieldAPI()#: Destructor.

inline TfToken GetName() const#: Returns the name of this multiple-apply schema instance.

UsdAttribute GetEnabledAttr() const#

Enable or disable this ForceField. Overrides all other settings.


Declaration	`bool physxForceField:enabled = 1`
C++ Type	bool
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Bool

UsdAttribute CreateEnabledAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetEnabledAttr(), 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.

UsdAttribute GetSurfaceSampleDensityAttr() const#

Number of rays to cast per square unit of surface area. When Surface Sampling is disabled, by setting this value to 0.0, (or when it is enabled and a rigid body has no geometry to sample) all forces act through the Center of Mass of the Rigid Body and no rotational torques will be applied. Any positive value will enable Surface Sampling. Ray casts are performed against the Collision Object of the Rigid Body in order to apply forces on the surface along the direction of the surface normal. This will apply torques to the Rigid Body that will induce rotation. Higher densities will cast more rays over the surface and spread the same force over the surface area. More ray casts will generate more accurate forces and torques, but will take additional compute time.


Declaration	`float physxForceField:surfaceSampleDensity = 0`
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateSurfaceSampleDensityAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetSurfaceSampleDensityAttr(), 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.

UsdAttribute GetSurfaceAreaScaleEnabledAttr() const#

Enable or disable scaling forces by the surface area that faces in the direction of the applied force. If a rigid body has no geometry to sample, the surface area scaling is also disabled for that rigid body. The surface area measurement is an approximation based on the collision object bounding box. Certain forces, like wind and drag increase as the exposed surface area increases, but this may not always be desirable.


Declaration	`bool physxForceField:surfaceAreaScaleEnabled = 1`
C++ Type	bool
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Bool

UsdAttribute CreateSurfaceAreaScaleEnabledAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetSurfaceAreaScaleEnabledAttr(), 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.

UsdAttribute GetPositionAttr() const#

The location of the force field. Set to (0, 0, 0) to obtain the position from the prim and continuously update it if it is animated.


Declaration	`float3 physxForceField:position = (0, 0, 0)`
C++ Type	GfVec3f
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float3

UsdAttribute CreatePositionAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetPositionAttr(), 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.

UsdAttribute GetRangeAttr() const#

Forces are not applied when the distance to the force field is outside of this (minimum, maximum) range. Each force field can have a different definition of distance, e.g. for a spherical fore field, the distance is to the center, for a plane, the distance is to the closest point on the surface, for a line, it is to the closest point on the line. The minimum or maximum range is ignored if the value is negative.


Declaration	`float2 physxForceField:range = (-1, -1)`
C++ Type	GfVec2f
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float2

UsdAttribute CreateRangeAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetRangeAttr(), 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.

Public Static Functions

static 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. Does not include attributes that may be authored by custom/extended methods of the schemas involved.

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

static ForceFieldSchemaPhysxForceFieldAPI Get( const UsdStagePtr &stage, const SdfPath &path, )#

Return a ForceFieldSchemaPhysxForceFieldAPI 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:

TfToken name = SdfPath::StripNamespace(path.GetToken());
ForceFieldSchemaPhysxForceFieldAPI(
    stage->GetPrimAtPath(path.GetPrimPath()), name);

static ForceFieldSchemaPhysxForceFieldAPI Get( const UsdPrim &prim, const TfToken &name, )#: Return a ForceFieldSchemaPhysxForceFieldAPI with name name holding the prim prim. Shorthand for ForceFieldSchemaPhysxForceFieldAPI(prim, name);.

static std::vector<ForceFieldSchemaPhysxForceFieldAPI> GetAll( const UsdPrim &prim, )#: Return a vector of all named instances of ForceFieldSchemaPhysxForceFieldAPI on the given prim.

static bool IsSchemaPropertyBaseName(const TfToken &baseName)#: Checks if the given name baseName is the base name of a property of PhysxForceFieldAPI.

static bool IsPhysxForceFieldAPIPath( const SdfPath &path, TfToken *name, )#: Checks if the given path path is of an API schema of type PhysxForceFieldAPI. If so, it stores the instance name of the schema in name and returns true. Otherwise, it returns false.

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

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

static ForceFieldSchemaPhysxForceFieldAPI 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 “PhysxForceFieldAPI:name” to the token-valued, listOp metadata apiSchemas on the prim. For example, if name is ‘instance1’, the token ‘PhysxForceFieldAPI:instance1’ is added to ‘apiSchemas’.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

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

Public Static Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::MultipleApplyAPI#

Compile time constant representing what kind of schema this class is.

See also

UsdSchemaKind

Protected Functions

UsdSchemaKind _GetSchemaKind() const override#

Returns the kind of schema this class belongs to.

See also

UsdSchemaKind

class ForceFieldSchemaPhysxForceFieldConicalAPI : public UsdAPISchemaBase#

A conical force field that attracts and/or repels rigid bodies from a central point, but not outside of the cone angle limit, 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 center.

Public Functions

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

Construct a ForceFieldSchemaPhysxForceFieldConicalAPI on UsdPrim prim with name name . Equivalent to ForceFieldSchemaPhysxForceFieldConicalAPI::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 ForceFieldSchemaPhysxForceFieldConicalAPI( const UsdSchemaBase &schemaObj, const TfToken &name, )#: Construct a ForceFieldSchemaPhysxForceFieldConicalAPI on the prim held by schemaObj with name name. Should be preferred over ForceFieldSchemaPhysxForceFieldConicalAPI(schemaObj.GetPrim(), name), as it preserves SchemaBase state.

virtual ~ForceFieldSchemaPhysxForceFieldConicalAPI()#: Destructor.

inline TfToken GetName() const#: Returns the name of this multiple-apply schema instance.

UsdAttribute GetDirectionAttr() const#

The direction vector of the central axis of the cone. Forces are not applied to rigid bodies outside of the cone.


Declaration	`vector3f physxForceFieldLinear:direction = (0, 0, 0)`
C++ Type	GfVec3f
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Vector3f

UsdAttribute CreateDirectionAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetDirectionAttr(), 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.

UsdAttribute GetAngleAttr() const#

Angle from the central axis of the cone to the surface that defines the extents of the cone. Forces are not applied to rigid bodies outside of the cone.


Declaration	`float physxForceFieldConical:angle = 0`
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateAngleAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetAngleAttr(), 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.

UsdAttribute GetConstantAttr() const#

constant applies a steady force.


Declaration	`float physxForceFieldConical:constant = 0`
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateConstantAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetConstantAttr(), 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.

UsdAttribute GetLinearAttr() const#

linear sets a force that varies with distance to the center.


Declaration	`float physxForceFieldConical:linear = 0`
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

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.

UsdAttribute GetInverseSquareAttr() const#

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


Declaration	`float physxForceFieldConical:inverseSquare = 0`
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateInverseSquareAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetInverseSquareAttr(), 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.

UsdAttribute GetLinearFalloffAttr() const#

ramp down forces linearly with the angle from the central axis. set linearFalloff to 0.0 to disable. linearFalloff is the percentage of the force remaining at the cone angle extents (>0.0 to 1.0).


Declaration	`float physxForceFieldConical:linearFalloff = 0`
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateLinearFalloffAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetLinearFalloffAttr(), 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.

UsdAttribute GetPowerFalloffAttr() const#

ramp down forces dramatically with the angle from the central axis. set powerFalloff to 0.0 to disable. >0.0 to 1.0 decay more as this angle increases. 1.0 and greater decay more as the angle apporaches the cone angle limit.


Declaration	`float physxForceFieldConical:powerFalloff = 0`
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreatePowerFalloffAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetPowerFalloffAttr(), 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.

Public Static Functions

static 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. Does not include attributes that may be authored by custom/extended methods of the schemas involved.

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

static ForceFieldSchemaPhysxForceFieldConicalAPI Get( const UsdStagePtr &stage, const SdfPath &path, )#

Return a ForceFieldSchemaPhysxForceFieldConicalAPI 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:

TfToken name = SdfPath::StripNamespace(path.GetToken());
ForceFieldSchemaPhysxForceFieldConicalAPI(
    stage->GetPrimAtPath(path.GetPrimPath()), name);

static ForceFieldSchemaPhysxForceFieldConicalAPI Get( const UsdPrim &prim, const TfToken &name, )#: Return a ForceFieldSchemaPhysxForceFieldConicalAPI with name name holding the prim prim. Shorthand for ForceFieldSchemaPhysxForceFieldConicalAPI(prim, name);.

static std::vector<ForceFieldSchemaPhysxForceFieldConicalAPI> GetAll( const UsdPrim &prim, )#: Return a vector of all named instances of ForceFieldSchemaPhysxForceFieldConicalAPI on the given prim.

static bool IsSchemaPropertyBaseName(const TfToken &baseName)#: Checks if the given name baseName is the base name of a property of PhysxForceFieldConicalAPI.

static bool IsPhysxForceFieldConicalAPIPath( const SdfPath &path, TfToken *name, )#: Checks if the given path path is of an API schema of type PhysxForceFieldConicalAPI. If so, it stores the instance name of the schema in name and returns true. Otherwise, it returns false.

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

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

static ForceFieldSchemaPhysxForceFieldConicalAPI 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 “PhysxForceFieldConicalAPI:name” to the token-valued, listOp metadata apiSchemas on the prim. For example, if name is ‘instance1’, the token ‘PhysxForceFieldConicalAPI:instance1’ is added to ‘apiSchemas’.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

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

Public Static Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::MultipleApplyAPI#

Compile time constant representing what kind of schema this class is.

See also

UsdSchemaKind

Protected Functions

UsdSchemaKind _GetSchemaKind() const override#

Returns the kind of schema this class belongs to.

See also

UsdSchemaKind

class ForceFieldSchemaPhysxForceFieldDragAPI : public 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.

virtual ~ForceFieldSchemaPhysxForceFieldDragAPI()#: Destructor.

inline TfToken GetName() const#: Returns the name of this multiple-apply schema instance.

UsdAttribute GetMinimumSpeedAttr() const#

Drag forces are not applied below this minimum speed.


Declaration	`float physxForceFieldDrag:minimumSpeed = 0`
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

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.

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_Datatypes “Usd Type”	SdfValueTypeNames->Float

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.

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_Datatypes “Usd Type”	SdfValueTypeNames->Float

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.

Public Static Functions

static 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. Does not include attributes that may be authored by custom/extended methods of the schemas involved.

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

static ForceFieldSchemaPhysxForceFieldDragAPI Get( const UsdStagePtr &stage, const SdfPath &path, )#

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:

TfToken name = SdfPath::StripNamespace(path.GetToken());
ForceFieldSchemaPhysxForceFieldDragAPI(
    stage->GetPrimAtPath(path.GetPrimPath()), name);

static ForceFieldSchemaPhysxForceFieldDragAPI Get( const UsdPrim &prim, const TfToken &name, )#: Return a ForceFieldSchemaPhysxForceFieldDragAPI with name name holding the prim prim. Shorthand for ForceFieldSchemaPhysxForceFieldDragAPI(prim, name);.

static std::vector<ForceFieldSchemaPhysxForceFieldDragAPI> GetAll( const UsdPrim &prim, )#: Return a vector of all named instances of ForceFieldSchemaPhysxForceFieldDragAPI on the given prim.

static bool IsSchemaPropertyBaseName(const TfToken &baseName)#: Checks if the given name baseName is the base name of a property of PhysxForceFieldDragAPI.

static bool IsPhysxForceFieldDragAPIPath( const SdfPath &path, TfToken *name, )#: 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 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. 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.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

static 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:name” 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::CanApplyAPI()

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 UsdSchemaKind schemaKind = UsdSchemaKind::MultipleApplyAPI#

Compile time constant representing what kind of schema this class is.

See also

UsdSchemaKind

Protected Functions

UsdSchemaKind _GetSchemaKind() const override#

Returns the kind of schema this class belongs to.

See also

UsdSchemaKind

class ForceFieldSchemaPhysxForceFieldLinearAPI : public 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.

virtual ~ForceFieldSchemaPhysxForceFieldLinearAPI()#: Destructor.

inline TfToken GetName() const#: Returns the name of this multiple-apply schema instance.

UsdAttribute GetDirectionAttr() const#

The direction vector of the line.


Declaration	`vector3f physxForceFieldLinear:direction = (0, 0, 0)`
C++ Type	GfVec3f
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Vector3f

UsdAttribute CreateDirectionAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetDirectionAttr(), 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.

UsdAttribute GetConstantAttr() const#

constant applies a steady force.


Declaration	`float physxForceFieldLinear:constant = 0`
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateConstantAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetConstantAttr(), 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.

UsdAttribute GetLinearAttr() const#

linear sets a force that varies with distance to the line.


Declaration	`float physxForceFieldLinear:linear = 0`
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

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.

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_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateInverseSquareAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetInverseSquareAttr(), 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.

Public Static Functions

static 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. Does not include attributes that may be authored by custom/extended methods of the schemas involved.

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

static ForceFieldSchemaPhysxForceFieldLinearAPI Get( const UsdStagePtr &stage, const SdfPath &path, )#

Return a ForceFieldSchemaPhysxForceFieldLinearAPI 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:

TfToken name = SdfPath::StripNamespace(path.GetToken());
ForceFieldSchemaPhysxForceFieldLinearAPI(
    stage->GetPrimAtPath(path.GetPrimPath()), name);

static ForceFieldSchemaPhysxForceFieldLinearAPI Get( const UsdPrim &prim, const TfToken &name, )#: Return a ForceFieldSchemaPhysxForceFieldLinearAPI with name name holding the prim prim. Shorthand for ForceFieldSchemaPhysxForceFieldLinearAPI(prim, name);.

static std::vector<ForceFieldSchemaPhysxForceFieldLinearAPI> GetAll( const UsdPrim &prim, )#: Return a vector of all named instances of ForceFieldSchemaPhysxForceFieldLinearAPI on the given prim.

static bool IsSchemaPropertyBaseName(const TfToken &baseName)#: Checks if the given name baseName is the base name of a property of PhysxForceFieldLinearAPI.

static bool IsPhysxForceFieldLinearAPIPath( const SdfPath &path, TfToken *name, )#: Checks if the given path path is of an API schema of type PhysxForceFieldLinearAPI. If so, it stores the instance name of the schema in name and returns true. Otherwise, it returns false.

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

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

static 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:name” 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::CanApplyAPI()

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 UsdSchemaKind schemaKind = UsdSchemaKind::MultipleApplyAPI#

Compile time constant representing what kind of schema this class is.

See also

UsdSchemaKind

Protected Functions

UsdSchemaKind _GetSchemaKind() const override#

Returns the kind of schema this class belongs to.

See also

UsdSchemaKind

class ForceFieldSchemaPhysxForceFieldNoiseAPI : public 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.

virtual ~ForceFieldSchemaPhysxForceFieldNoiseAPI()#: Destructor.

inline TfToken GetName() const#: Returns the name of this multiple-apply schema instance.

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_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateDragAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetDragAttr(), 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.

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_Datatypes “Usd Type”	SdfValueTypeNames->Float3

UsdAttribute CreateAmplitudeAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetAmplitudeAttr(), 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.

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_Datatypes “Usd Type”	SdfValueTypeNames->Float3

UsdAttribute CreateFrequencyAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetFrequencyAttr(), 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.

Public Static Functions

static 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. Does not include attributes that may be authored by custom/extended methods of the schemas involved.

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

static ForceFieldSchemaPhysxForceFieldNoiseAPI Get( const UsdStagePtr &stage, const SdfPath &path, )#

Return a ForceFieldSchemaPhysxForceFieldNoiseAPI 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:

TfToken name = SdfPath::StripNamespace(path.GetToken());
ForceFieldSchemaPhysxForceFieldNoiseAPI(
    stage->GetPrimAtPath(path.GetPrimPath()), name);

static ForceFieldSchemaPhysxForceFieldNoiseAPI Get( const UsdPrim &prim, const TfToken &name, )#: Return a ForceFieldSchemaPhysxForceFieldNoiseAPI with name name holding the prim prim. Shorthand for ForceFieldSchemaPhysxForceFieldNoiseAPI(prim, name);.

static std::vector<ForceFieldSchemaPhysxForceFieldNoiseAPI> GetAll( const UsdPrim &prim, )#: Return a vector of all named instances of ForceFieldSchemaPhysxForceFieldNoiseAPI on the given prim.

static bool IsSchemaPropertyBaseName(const TfToken &baseName)#: Checks if the given name baseName is the base name of a property of PhysxForceFieldNoiseAPI.

static bool IsPhysxForceFieldNoiseAPIPath( const SdfPath &path, TfToken *name, )#: Checks if the given path path is of an API schema of type PhysxForceFieldNoiseAPI. If so, it stores the instance name of the schema in name and returns true. Otherwise, it returns false.

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

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

static 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:name” 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::CanApplyAPI()

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 UsdSchemaKind schemaKind = UsdSchemaKind::MultipleApplyAPI#

Compile time constant representing what kind of schema this class is.

See also

UsdSchemaKind

Protected Functions

UsdSchemaKind _GetSchemaKind() const override#

Returns the kind of schema this class belongs to.

See also

UsdSchemaKind

class ForceFieldSchemaPhysxForceFieldPlanarAPI : public UsdAPISchemaBase#

A planar force field that attracts and/or repels rigid bodies from a plane, defined by a point and normal 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 plane.

Public Functions

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

Construct a ForceFieldSchemaPhysxForceFieldPlanarAPI on UsdPrim prim with name name . Equivalent to ForceFieldSchemaPhysxForceFieldPlanarAPI::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 ForceFieldSchemaPhysxForceFieldPlanarAPI( const UsdSchemaBase &schemaObj, const TfToken &name, )#: Construct a ForceFieldSchemaPhysxForceFieldPlanarAPI on the prim held by schemaObj with name name. Should be preferred over ForceFieldSchemaPhysxForceFieldPlanarAPI(schemaObj.GetPrim(), name), as it preserves SchemaBase state.

virtual ~ForceFieldSchemaPhysxForceFieldPlanarAPI()#: Destructor.

inline TfToken GetName() const#: Returns the name of this multiple-apply schema instance.

UsdAttribute GetNormalAttr() const#

The normal vector to the plane.


Declaration	`vector3f physxForceFieldPlanar:normal = (0, 0, 0)`
C++ Type	GfVec3f
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Vector3f

UsdAttribute CreateNormalAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetNormalAttr(), 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.

UsdAttribute GetConstantAttr() const#

constant applies a steady force.


Declaration	`float physxForceFieldPlanar:constant = 0`
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateConstantAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetConstantAttr(), 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.

UsdAttribute GetLinearAttr() const#

linear sets a force that varies with distance to the plane.


Declaration	`float physxForceFieldPlanar:linear = 0`
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

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.

UsdAttribute GetInverseSquareAttr() const#

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


Declaration	`float physxForceFieldPlanar:inverseSquare = 0`
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateInverseSquareAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetInverseSquareAttr(), 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.

Public Static Functions

static 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. Does not include attributes that may be authored by custom/extended methods of the schemas involved.

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

static ForceFieldSchemaPhysxForceFieldPlanarAPI Get( const UsdStagePtr &stage, const SdfPath &path, )#

Return a ForceFieldSchemaPhysxForceFieldPlanarAPI 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:

TfToken name = SdfPath::StripNamespace(path.GetToken());
ForceFieldSchemaPhysxForceFieldPlanarAPI(
    stage->GetPrimAtPath(path.GetPrimPath()), name);

static ForceFieldSchemaPhysxForceFieldPlanarAPI Get( const UsdPrim &prim, const TfToken &name, )#: Return a ForceFieldSchemaPhysxForceFieldPlanarAPI with name name holding the prim prim. Shorthand for ForceFieldSchemaPhysxForceFieldPlanarAPI(prim, name);.

static std::vector<ForceFieldSchemaPhysxForceFieldPlanarAPI> GetAll( const UsdPrim &prim, )#: Return a vector of all named instances of ForceFieldSchemaPhysxForceFieldPlanarAPI on the given prim.

static bool IsSchemaPropertyBaseName(const TfToken &baseName)#: Checks if the given name baseName is the base name of a property of PhysxForceFieldPlanarAPI.

static bool IsPhysxForceFieldPlanarAPIPath( const SdfPath &path, TfToken *name, )#: Checks if the given path path is of an API schema of type PhysxForceFieldPlanarAPI. If so, it stores the instance name of the schema in name and returns true. Otherwise, it returns false.

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

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

static ForceFieldSchemaPhysxForceFieldPlanarAPI 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 “PhysxForceFieldPlanarAPI:name” to the token-valued, listOp metadata apiSchemas on the prim. For example, if name is ‘instance1’, the token ‘PhysxForceFieldPlanarAPI:instance1’ is added to ‘apiSchemas’.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

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

Public Static Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::MultipleApplyAPI#

Compile time constant representing what kind of schema this class is.

See also

UsdSchemaKind

Protected Functions

UsdSchemaKind _GetSchemaKind() const override#

Returns the kind of schema this class belongs to.

See also

UsdSchemaKind

class ForceFieldSchemaPhysxForceFieldRingAPI : public UsdAPISchemaBase#

A force field that applies forces to rotate rigid bodies around a ring, defined by a normal axis through the center of the ring and radius from that axis. The two sets of coefficients describe the attraction force to the ring and the tangential force that rotated bodies around the ring. The net force on the rigid body is calculated using f_ring = constant + linear * r + inverseSquare / r^2. f_spin = spinConstant + spinLinear * r + spinInverseSquare / r^2.

Public Functions

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

Construct a ForceFieldSchemaPhysxForceFieldRingAPI on UsdPrim prim with name name . Equivalent to ForceFieldSchemaPhysxForceFieldRingAPI::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 ForceFieldSchemaPhysxForceFieldRingAPI( const UsdSchemaBase &schemaObj, const TfToken &name, )#: Construct a ForceFieldSchemaPhysxForceFieldRingAPI on the prim held by schemaObj with name name. Should be preferred over ForceFieldSchemaPhysxForceFieldRingAPI(schemaObj.GetPrim(), name), as it preserves SchemaBase state.

virtual ~ForceFieldSchemaPhysxForceFieldRingAPI()#: Destructor.

inline TfToken GetName() const#: Returns the name of this multiple-apply schema instance.

UsdAttribute GetNormalAxisAttr() const#

The normal axis through the center of the ring in world coordinates.


Declaration	`vector3f physxForceFieldRing:normalAxis = (0, 0, 0)`
C++ Type	GfVec3f
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Vector3f

UsdAttribute CreateNormalAxisAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetNormalAxisAttr(), 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.

UsdAttribute GetRadiusAttr() const#

The distance from the normal axis to the center of the ring.


Declaration	`float physxForceFieldRing:radius = 0`
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateRadiusAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetRadiusAttr(), 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.

UsdAttribute GetConstantAttr() const#

constant applies a steady force that attracts bodies toward the ring.


Declaration	`float physxForceFieldRing:constant = 0`
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateConstantAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetConstantAttr(), 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.

UsdAttribute GetLinearAttr() const#

linear applies a force that attracts bodies toward the ring and varies with distance to the ring.


Declaration	`float physxForceFieldRing:linear = 0`
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

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.

UsdAttribute GetInverseSquareAttr() const#

inverseSquare applies a force that attracts bodies toward the ring and varies with the reciprocal of the square of the distance to the ring.


Declaration	`float physxForceFieldRing:inverseSquare = 0`
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateInverseSquareAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetInverseSquareAttr(), 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.

UsdAttribute GetSpinConstantAttr() const#

spinConstant applies a steady force that rotates bodies around the ring.


Declaration	`float physxForceFieldRing:spinConstant = 0`
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateSpinConstantAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetSpinConstantAttr(), 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.

UsdAttribute GetSpinLinearAttr() const#

spinLinear applies a force that rotates bodies around the ring and varies with distance to the ring.


Declaration	`float physxForceFieldRing:spinLinear = 0`
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateSpinLinearAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetSpinLinearAttr(), 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.

UsdAttribute GetSpinInverseSquareAttr() const#

inverseSquare sets a force that rotates bodies around the ring and varies with the reciprocal of the square of the distance to the ring.


Declaration	`float physxForceFieldRing:spinInverseSquare = 0`
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateSpinInverseSquareAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetSpinInverseSquareAttr(), 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.

Public Static Functions

static 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. Does not include attributes that may be authored by custom/extended methods of the schemas involved.

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

static ForceFieldSchemaPhysxForceFieldRingAPI Get( const UsdStagePtr &stage, const SdfPath &path, )#

Return a ForceFieldSchemaPhysxForceFieldRingAPI 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:

TfToken name = SdfPath::StripNamespace(path.GetToken());
ForceFieldSchemaPhysxForceFieldRingAPI(
    stage->GetPrimAtPath(path.GetPrimPath()), name);

static ForceFieldSchemaPhysxForceFieldRingAPI Get( const UsdPrim &prim, const TfToken &name, )#: Return a ForceFieldSchemaPhysxForceFieldRingAPI with name name holding the prim prim. Shorthand for ForceFieldSchemaPhysxForceFieldRingAPI(prim, name);.

static std::vector<ForceFieldSchemaPhysxForceFieldRingAPI> GetAll( const UsdPrim &prim, )#: Return a vector of all named instances of ForceFieldSchemaPhysxForceFieldRingAPI on the given prim.

static bool IsSchemaPropertyBaseName(const TfToken &baseName)#: Checks if the given name baseName is the base name of a property of PhysxForceFieldRingAPI.

static bool IsPhysxForceFieldRingAPIPath( const SdfPath &path, TfToken *name, )#: Checks if the given path path is of an API schema of type PhysxForceFieldRingAPI. If so, it stores the instance name of the schema in name and returns true. Otherwise, it returns false.

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

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

static ForceFieldSchemaPhysxForceFieldRingAPI 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 “PhysxForceFieldRingAPI:name” to the token-valued, listOp metadata apiSchemas on the prim. For example, if name is ‘instance1’, the token ‘PhysxForceFieldRingAPI:instance1’ is added to ‘apiSchemas’.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

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

Public Static Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::MultipleApplyAPI#

Compile time constant representing what kind of schema this class is.

See also

UsdSchemaKind

Protected Functions

UsdSchemaKind _GetSchemaKind() const override#

Returns the kind of schema this class belongs to.

See also

UsdSchemaKind

class ForceFieldSchemaPhysxForceFieldSphericalAPI : public UsdAPISchemaBase#

A spherical force field that attracts and/or repels rigid bodies from a central point 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 center.

Public Functions

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

Construct a ForceFieldSchemaPhysxForceFieldSphericalAPI on UsdPrim prim with name name . Equivalent to ForceFieldSchemaPhysxForceFieldSphericalAPI::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 ForceFieldSchemaPhysxForceFieldSphericalAPI( const UsdSchemaBase &schemaObj, const TfToken &name, )#: Construct a ForceFieldSchemaPhysxForceFieldSphericalAPI on the prim held by schemaObj with name name. Should be preferred over ForceFieldSchemaPhysxForceFieldSphericalAPI(schemaObj.GetPrim(), name), as it preserves SchemaBase state.

virtual ~ForceFieldSchemaPhysxForceFieldSphericalAPI()#: Destructor.

inline TfToken GetName() const#: Returns the name of this multiple-apply schema instance.

UsdAttribute GetConstantAttr() const#

constant applies a steady force.


Declaration	`float physxForceFieldSpherical:constant = 0`
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateConstantAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetConstantAttr(), 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.

UsdAttribute GetLinearAttr() const#

linear sets a force that varies with distance to the center.


Declaration	`float physxForceFieldSpherical:linear = 0`
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

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.

UsdAttribute GetInverseSquareAttr() const#

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


Declaration	`float physxForceFieldSpherical:inverseSquare = 0`
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateInverseSquareAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetInverseSquareAttr(), 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.

Public Static Functions

static 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. Does not include attributes that may be authored by custom/extended methods of the schemas involved.

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

static ForceFieldSchemaPhysxForceFieldSphericalAPI Get( const UsdStagePtr &stage, const SdfPath &path, )#

Return a ForceFieldSchemaPhysxForceFieldSphericalAPI 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:

TfToken name = SdfPath::StripNamespace(path.GetToken());
ForceFieldSchemaPhysxForceFieldSphericalAPI(
    stage->GetPrimAtPath(path.GetPrimPath()), name);

static ForceFieldSchemaPhysxForceFieldSphericalAPI Get( const UsdPrim &prim, const TfToken &name, )#: Return a ForceFieldSchemaPhysxForceFieldSphericalAPI with name name holding the prim prim. Shorthand for ForceFieldSchemaPhysxForceFieldSphericalAPI(prim, name);.

static std::vector<ForceFieldSchemaPhysxForceFieldSphericalAPI> GetAll( const UsdPrim &prim, )#: Return a vector of all named instances of ForceFieldSchemaPhysxForceFieldSphericalAPI on the given prim.

static bool IsSchemaPropertyBaseName(const TfToken &baseName)#: Checks if the given name baseName is the base name of a property of PhysxForceFieldSphericalAPI.

static bool IsPhysxForceFieldSphericalAPIPath( const SdfPath &path, TfToken *name, )#: Checks if the given path path is of an API schema of type PhysxForceFieldSphericalAPI. If so, it stores the instance name of the schema in name and returns true. Otherwise, it returns false.

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

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

static ForceFieldSchemaPhysxForceFieldSphericalAPI 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 “PhysxForceFieldSphericalAPI:name” to the token-valued, listOp metadata apiSchemas on the prim. For example, if name is ‘instance1’, the token ‘PhysxForceFieldSphericalAPI:instance1’ is added to ‘apiSchemas’.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

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

Public Static Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::MultipleApplyAPI#

Compile time constant representing what kind of schema this class is.

See also

UsdSchemaKind

Protected Functions

UsdSchemaKind _GetSchemaKind() const override#

Returns the kind of schema this class belongs to.

See also

UsdSchemaKind

class ForceFieldSchemaPhysxForceFieldSpinAPI : public UsdAPISchemaBase#

A force field that applies forces to rotate rigid bodies around a line, defined by a spin axis, and varies with the function coefficients. Positive values rotate clockwise around the spin axis when looking along the axis. The net force on the rigid body is calculated using f = constant + linear * r + inverseSquare / r^2.

Public Functions

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

Construct a ForceFieldSchemaPhysxForceFieldSpinAPI on UsdPrim prim with name name . Equivalent to ForceFieldSchemaPhysxForceFieldSpinAPI::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 ForceFieldSchemaPhysxForceFieldSpinAPI( const UsdSchemaBase &schemaObj, const TfToken &name, )#: Construct a ForceFieldSchemaPhysxForceFieldSpinAPI on the prim held by schemaObj with name name. Should be preferred over ForceFieldSchemaPhysxForceFieldSpinAPI(schemaObj.GetPrim(), name), as it preserves SchemaBase state.

virtual ~ForceFieldSchemaPhysxForceFieldSpinAPI()#: Destructor.

inline TfToken GetName() const#: Returns the name of this multiple-apply schema instance.

UsdAttribute GetSpinAxisAttr() const#

The axis around which rigid bodies are rotated in world coordinates.


Declaration	`vector3f physxForceFieldSpin:spinAxis = (0, 0, 0)`
C++ Type	GfVec3f
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Vector3f

UsdAttribute CreateSpinAxisAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetSpinAxisAttr(), 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.

UsdAttribute GetConstantAttr() const#

constant applies a steady force.


Declaration	`float physxForceFieldSpin:constant = 0`
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateConstantAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetConstantAttr(), 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.

UsdAttribute GetLinearAttr() const#

linear sets a force that varies with distance to the axis.


Declaration	`float physxForceFieldSpin:linear = 0`
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

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.

UsdAttribute GetInverseSquareAttr() const#

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


Declaration	`float physxForceFieldSpin:inverseSquare = 0`
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateInverseSquareAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetInverseSquareAttr(), 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.

Public Static Functions

static 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. Does not include attributes that may be authored by custom/extended methods of the schemas involved.

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

static ForceFieldSchemaPhysxForceFieldSpinAPI Get( const UsdStagePtr &stage, const SdfPath &path, )#

Return a ForceFieldSchemaPhysxForceFieldSpinAPI 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:

TfToken name = SdfPath::StripNamespace(path.GetToken());
ForceFieldSchemaPhysxForceFieldSpinAPI(
    stage->GetPrimAtPath(path.GetPrimPath()), name);

static ForceFieldSchemaPhysxForceFieldSpinAPI Get( const UsdPrim &prim, const TfToken &name, )#: Return a ForceFieldSchemaPhysxForceFieldSpinAPI with name name holding the prim prim. Shorthand for ForceFieldSchemaPhysxForceFieldSpinAPI(prim, name);.

static std::vector<ForceFieldSchemaPhysxForceFieldSpinAPI> GetAll( const UsdPrim &prim, )#: Return a vector of all named instances of ForceFieldSchemaPhysxForceFieldSpinAPI on the given prim.

static bool IsSchemaPropertyBaseName(const TfToken &baseName)#: Checks if the given name baseName is the base name of a property of PhysxForceFieldSpinAPI.

static bool IsPhysxForceFieldSpinAPIPath( const SdfPath &path, TfToken *name, )#: Checks if the given path path is of an API schema of type PhysxForceFieldSpinAPI. If so, it stores the instance name of the schema in name and returns true. Otherwise, it returns false.

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

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

static ForceFieldSchemaPhysxForceFieldSpinAPI 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 “PhysxForceFieldSpinAPI:name” to the token-valued, listOp metadata apiSchemas on the prim. For example, if name is ‘instance1’, the token ‘PhysxForceFieldSpinAPI:instance1’ is added to ‘apiSchemas’.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

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

Public Static Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::MultipleApplyAPI#

Compile time constant representing what kind of schema this class is.

See also

UsdSchemaKind

Protected Functions

UsdSchemaKind _GetSchemaKind() const override#

Returns the kind of schema this class belongs to.

See also

UsdSchemaKind

class ForceFieldSchemaPhysxForceFieldWindAPI : public 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.

virtual ~ForceFieldSchemaPhysxForceFieldWindAPI()#: Destructor.

inline TfToken GetName() const#: Returns the name of this multiple-apply schema instance.

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_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateDragAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetDragAttr(), 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.

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_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateAverageSpeedAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetAverageSpeedAttr(), 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.

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_Datatypes “Usd Type”	SdfValueTypeNames->Vector3f

UsdAttribute CreateAverageDirectionAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetAverageDirectionAttr(), 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.

UsdAttribute GetSpeedVariationAttr() const#

The magnitude of the random changes of the wind speed.


Declaration	`float physxForceFieldWind:speedVariation = 0`
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateSpeedVariationAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetSpeedVariationAttr(), 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.

UsdAttribute GetSpeedVariationFrequencyAttr() const#

The frequency of the random changes of the wind speed.


Declaration	`float physxForceFieldWind:speedVariationFrequency = 0`
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateSpeedVariationFrequencyAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetSpeedVariationFrequencyAttr(), 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.

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_Datatypes “Usd Type”	SdfValueTypeNames->Float3

UsdAttribute CreateDirectionVariationAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetDirectionVariationAttr(), 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.

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_Datatypes “Usd Type”	SdfValueTypeNames->Float3

UsdAttribute CreateDirectionVariationFrequencyAttr( VtValue const &defaultValue = VtValue(), bool writeSparsely = false, ) const#: See GetDirectionVariationFrequencyAttr(), 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.

Public Static Functions

static 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. Does not include attributes that may be authored by custom/extended methods of the schemas involved.

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

static ForceFieldSchemaPhysxForceFieldWindAPI Get( const UsdStagePtr &stage, const SdfPath &path, )#

Return a ForceFieldSchemaPhysxForceFieldWindAPI 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:

TfToken name = SdfPath::StripNamespace(path.GetToken());
ForceFieldSchemaPhysxForceFieldWindAPI(
    stage->GetPrimAtPath(path.GetPrimPath()), name);

static ForceFieldSchemaPhysxForceFieldWindAPI Get( const UsdPrim &prim, const TfToken &name, )#: Return a ForceFieldSchemaPhysxForceFieldWindAPI with name name holding the prim prim. Shorthand for ForceFieldSchemaPhysxForceFieldWindAPI(prim, name);.

static std::vector<ForceFieldSchemaPhysxForceFieldWindAPI> GetAll( const UsdPrim &prim, )#: Return a vector of all named instances of ForceFieldSchemaPhysxForceFieldWindAPI on the given prim.

static bool IsSchemaPropertyBaseName(const TfToken &baseName)#: Checks if the given name baseName is the base name of a property of PhysxForceFieldWindAPI.

static bool IsPhysxForceFieldWindAPIPath( const SdfPath &path, TfToken *name, )#: Checks if the given path path is of an API schema of type PhysxForceFieldWindAPI. If so, it stores the instance name of the schema in name and returns true. Otherwise, it returns false.

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

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

static 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:name” 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::CanApplyAPI()

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 UsdSchemaKind schemaKind = UsdSchemaKind::MultipleApplyAPI#

Compile time constant representing what kind of schema this class is.

See also

UsdSchemaKind

Protected Functions

UsdSchemaKind _GetSchemaKind() const override#

Returns the kind of schema this class belongs to.

See also

UsdSchemaKind

class ForceFieldSchemaTokensType#

ForceFieldSchemaTokens provides static, efficient TfToken for use in all public USD API.

These tokens are auto-generated from the module’s schema, representing property names, for when you need to fetch an attribute or relationship directly by name, e.g. UsdPrim::GetAttribute(), in the most efficient manner, and allow the compiler to verify that you spelled the name correctly.

ForceFieldSchemaTokens also contains all of the allowedTokens values declared for schema builtin attributes of ‘token’ scene description type. Use ForceFieldSchemaTokens like so:

gprim.GetMyTokenValuedAttr().Set(ForceFieldSchemaTokens->forceFieldBodies);

Public Members

const TfToken forceFieldBodies#

“forceFieldBodies”

This token is the instance name used to label all of the PhysxForceField collecitonAPI’s.

const TfToken physxForceField#

“physxForceField”

Property namespace prefix for the ForceFieldSchemaPhysxForceFieldRingAPI schema., Property namespace prefix for the ForceFieldSchemaPhysxForceFieldSpinAPI schema., Property namespace prefix for the ForceFieldSchemaPhysxForceFieldWindAPI schema., Property namespace prefix for the ForceFieldSchemaPhysxForceFieldNoiseAPI schema., Property namespace prefix for the ForceFieldSchemaPhysxForceFieldDragAPI schema., Property namespace prefix for the ForceFieldSchemaPhysxForceFieldLinearAPI schema., Property namespace prefix for the ForceFieldSchemaPhysxForceFieldPlanarAPI schema., Property namespace prefix for the ForceFieldSchemaPhysxForceFieldConicalAPI schema., Property namespace prefix for the ForceFieldSchemaPhysxForceFieldSphericalAPI schema., Property namespace prefix for the ForceFieldSchemaPhysxForceFieldAPI schema.

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldConicalAngle#

“physxForceField:__INSTANCE_NAME__:physxForceFieldConical:angle”

ForceFieldSchemaPhysxForceFieldConicalAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldConicalConstant#

“physxForceField:__INSTANCE_NAME__:physxForceFieldConical:constant”

ForceFieldSchemaPhysxForceFieldConicalAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldConicalInverseSquare#

“physxForceField:__INSTANCE_NAME__:physxForceFieldConical:inverseSquare”

ForceFieldSchemaPhysxForceFieldConicalAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldConicalLinear#

“physxForceField:__INSTANCE_NAME__:physxForceFieldConical:linear”

ForceFieldSchemaPhysxForceFieldConicalAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldConicalLinearFalloff#

“physxForceField:__INSTANCE_NAME__:physxForceFieldConical:linearFalloff”

ForceFieldSchemaPhysxForceFieldConicalAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldConicalPowerFalloff#

“physxForceField:__INSTANCE_NAME__:physxForceFieldConical:powerFalloff”

ForceFieldSchemaPhysxForceFieldConicalAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldDragLinear#

“physxForceField:__INSTANCE_NAME__:physxForceFieldDrag:linear”

ForceFieldSchemaPhysxForceFieldDragAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldDragMinimumSpeed#

“physxForceField:__INSTANCE_NAME__:physxForceFieldDrag:minimumSpeed”

ForceFieldSchemaPhysxForceFieldDragAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldDragSquare#

“physxForceField:__INSTANCE_NAME__:physxForceFieldDrag:square”

ForceFieldSchemaPhysxForceFieldDragAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldEnabled#

“physxForceField:__INSTANCE_NAME__:physxForceField:enabled”

ForceFieldSchemaPhysxForceFieldAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldLinearConstant#

“physxForceField:__INSTANCE_NAME__:physxForceFieldLinear:constant”

ForceFieldSchemaPhysxForceFieldLinearAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldLinearDirection#

“physxForceField:__INSTANCE_NAME__:physxForceFieldLinear:direction”

ForceFieldSchemaPhysxForceFieldLinearAPI, ForceFieldSchemaPhysxForceFieldConicalAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldLinearInverseSquare#

“physxForceField:__INSTANCE_NAME__:physxForceFieldLinear:inverseSquare”

ForceFieldSchemaPhysxForceFieldLinearAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldLinearLinear#

“physxForceField:__INSTANCE_NAME__:physxForceFieldLinear:linear”

ForceFieldSchemaPhysxForceFieldLinearAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldNoiseAmplitude#

“physxForceField:__INSTANCE_NAME__:physxForceFieldNoise:amplitude”

ForceFieldSchemaPhysxForceFieldNoiseAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldNoiseDrag#

“physxForceField:__INSTANCE_NAME__:physxForceFieldNoise:drag”

ForceFieldSchemaPhysxForceFieldNoiseAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldNoiseFrequency#

“physxForceField:__INSTANCE_NAME__:physxForceFieldNoise:frequency”

ForceFieldSchemaPhysxForceFieldNoiseAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldPlanarConstant#

“physxForceField:__INSTANCE_NAME__:physxForceFieldPlanar:constant”

ForceFieldSchemaPhysxForceFieldPlanarAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldPlanarInverseSquare#

“physxForceField:__INSTANCE_NAME__:physxForceFieldPlanar:inverseSquare”

ForceFieldSchemaPhysxForceFieldPlanarAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldPlanarLinear#

“physxForceField:__INSTANCE_NAME__:physxForceFieldPlanar:linear”

ForceFieldSchemaPhysxForceFieldPlanarAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldPlanarNormal#

“physxForceField:__INSTANCE_NAME__:physxForceFieldPlanar:normal”

ForceFieldSchemaPhysxForceFieldPlanarAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldPosition#

“physxForceField:__INSTANCE_NAME__:physxForceField:position”

ForceFieldSchemaPhysxForceFieldAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldRange#

“physxForceField:__INSTANCE_NAME__:physxForceField:range”

ForceFieldSchemaPhysxForceFieldAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldRingConstant#

“physxForceField:__INSTANCE_NAME__:physxForceFieldRing:constant”

ForceFieldSchemaPhysxForceFieldRingAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldRingInverseSquare#

“physxForceField:__INSTANCE_NAME__:physxForceFieldRing:inverseSquare”

ForceFieldSchemaPhysxForceFieldRingAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldRingLinear#

“physxForceField:__INSTANCE_NAME__:physxForceFieldRing:linear”

ForceFieldSchemaPhysxForceFieldRingAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldRingNormalAxis#

“physxForceField:__INSTANCE_NAME__:physxForceFieldRing:normalAxis”

ForceFieldSchemaPhysxForceFieldRingAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldRingRadius#

“physxForceField:__INSTANCE_NAME__:physxForceFieldRing:radius”

ForceFieldSchemaPhysxForceFieldRingAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldRingSpinConstant#

“physxForceField:__INSTANCE_NAME__:physxForceFieldRing:spinConstant”

ForceFieldSchemaPhysxForceFieldRingAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldRingSpinInverseSquare#

“physxForceField:__INSTANCE_NAME__:physxForceFieldRing:spinInverseSquare”

ForceFieldSchemaPhysxForceFieldRingAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldRingSpinLinear#

“physxForceField:__INSTANCE_NAME__:physxForceFieldRing:spinLinear”

ForceFieldSchemaPhysxForceFieldRingAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldSphericalConstant#

“physxForceField:__INSTANCE_NAME__:physxForceFieldSpherical:constant”

ForceFieldSchemaPhysxForceFieldSphericalAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldSphericalInverseSquare#

“physxForceField:__INSTANCE_NAME__:physxForceFieldSpherical:inverseSquare”

ForceFieldSchemaPhysxForceFieldSphericalAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldSphericalLinear#

“physxForceField:__INSTANCE_NAME__:physxForceFieldSpherical:linear”

ForceFieldSchemaPhysxForceFieldSphericalAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldSpinConstant#

“physxForceField:__INSTANCE_NAME__:physxForceFieldSpin:constant”

ForceFieldSchemaPhysxForceFieldSpinAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldSpinInverseSquare#

“physxForceField:__INSTANCE_NAME__:physxForceFieldSpin:inverseSquare”

ForceFieldSchemaPhysxForceFieldSpinAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldSpinLinear#

“physxForceField:__INSTANCE_NAME__:physxForceFieldSpin:linear”

ForceFieldSchemaPhysxForceFieldSpinAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldSpinSpinAxis#

“physxForceField:__INSTANCE_NAME__:physxForceFieldSpin:spinAxis”

ForceFieldSchemaPhysxForceFieldSpinAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldSurfaceAreaScaleEnabled#

“physxForceField:__INSTANCE_NAME__:physxForceField:surfaceAreaScaleEnabled”

ForceFieldSchemaPhysxForceFieldAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldSurfaceSampleDensity#

“physxForceField:__INSTANCE_NAME__:physxForceField:surfaceSampleDensity”

ForceFieldSchemaPhysxForceFieldAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldWindAverageDirection#

“physxForceField:__INSTANCE_NAME__:physxForceFieldWind:averageDirection”

ForceFieldSchemaPhysxForceFieldWindAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldWindAverageSpeed#

“physxForceField:__INSTANCE_NAME__:physxForceFieldWind:averageSpeed”

ForceFieldSchemaPhysxForceFieldWindAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldWindDirectionVariation#

“physxForceField:__INSTANCE_NAME__:physxForceFieldWind:directionVariation”

ForceFieldSchemaPhysxForceFieldWindAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldWindDirectionVariationFrequency#

“physxForceField:__INSTANCE_NAME__:physxForceFieldWind:directionVariationFrequency”

ForceFieldSchemaPhysxForceFieldWindAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldWindDrag#

“physxForceField:__INSTANCE_NAME__:physxForceFieldWind:drag”

ForceFieldSchemaPhysxForceFieldWindAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldWindSpeedVariation#

“physxForceField:__INSTANCE_NAME__:physxForceFieldWind:speedVariation”

ForceFieldSchemaPhysxForceFieldWindAPI

const TfToken physxForceField_MultipleApplyTemplate_PhysxForceFieldWindSpeedVariationFrequency#

“physxForceField:__INSTANCE_NAME__:physxForceFieldWind:speedVariationFrequency”

ForceFieldSchemaPhysxForceFieldWindAPI

const std::vector<TfToken> allTokens#: A vector of all of the tokens listed above.