ForceFieldSchemaPhysxForceFieldWindAPI Class Reference

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

Inherits UsdAPISchemaBase.

Public Member Functions
	ForceFieldSchemaPhysxForceFieldWindAPI (const UsdPrim &prim=UsdPrim(), const TfToken &name=TfToken())
	Construct a ForceFieldSchemaPhysxForceFieldWindAPI on UsdPrim prim with name name . More...
	ForceFieldSchemaPhysxForceFieldWindAPI (const UsdSchemaBase &schemaObj, const TfToken &name)
	Construct a ForceFieldSchemaPhysxForceFieldWindAPI on the prim held by schemaObj with name name. More...
virtual FORCEFIELDSCHEMA_API	~ForceFieldSchemaPhysxForceFieldWindAPI ()
	Destructor. More...
TfToken	GetName () const
	Returns the name of this multiple-apply schema instance. More...
FORCEFIELDSCHEMA_API UsdAttribute	GetDragAttr () const
	The drag coefficient determines how quickly the body moves along with the wind. More...
FORCEFIELDSCHEMA_API 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. More...
FORCEFIELDSCHEMA_API UsdAttribute	GetAverageSpeedAttr () const
	The average speed of the wind. More...
FORCEFIELDSCHEMA_API 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. More...
FORCEFIELDSCHEMA_API UsdAttribute	GetAverageDirectionAttr () const
	The initial direction of the wind in the world coordinate system. More...
FORCEFIELDSCHEMA_API 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. More...
FORCEFIELDSCHEMA_API UsdAttribute	GetSpeedVariationAttr () const
	The magnitude of the random changes of the wind speed. More...
FORCEFIELDSCHEMA_API 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. More...
FORCEFIELDSCHEMA_API UsdAttribute	GetSpeedVariationFrequencyAttr () const
	The frequency of the random changes of the wind speed. More...
FORCEFIELDSCHEMA_API 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. More...
FORCEFIELDSCHEMA_API UsdAttribute	GetDirectionVariationAttr () const
	The magnitude of the random changes of the wind direction in the world coordinate system. More...
FORCEFIELDSCHEMA_API 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. More...
FORCEFIELDSCHEMA_API UsdAttribute	GetDirectionVariationFrequencyAttr () const
	The frequency of the random variations of the wind direction in the world coordinate system. More...
FORCEFIELDSCHEMA_API 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. More...

Static Public Member Functions
static FORCEFIELDSCHEMA_API 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. More...
static FORCEFIELDSCHEMA_API 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. More...
static FORCEFIELDSCHEMA_API ForceFieldSchemaPhysxForceFieldWindAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a ForceFieldSchemaPhysxForceFieldWindAPI holding the prim adhering to this schema at path on stage. More...
static FORCEFIELDSCHEMA_API ForceFieldSchemaPhysxForceFieldWindAPI	Get (const UsdPrim &prim, const TfToken &name)
	Return a ForceFieldSchemaPhysxForceFieldWindAPI with name name holding the prim prim. More...
static FORCEFIELDSCHEMA_API std::vector < ForceFieldSchemaPhysxForceFieldWindAPI >	GetAll (const UsdPrim &prim)
	Return a vector of all named instances of ForceFieldSchemaPhysxForceFieldWindAPI on the given prim. More...
static FORCEFIELDSCHEMA_API bool	IsSchemaPropertyBaseName (const TfToken &baseName)
	Checks if the given name baseName is the base name of a property of PhysxForceFieldWindAPI. More...
static FORCEFIELDSCHEMA_API bool	IsPhysxForceFieldWindAPIPath (const SdfPath &path, TfToken *name)
	Checks if the given path path is of an API schema of type PhysxForceFieldWindAPI. More...
static FORCEFIELDSCHEMA_API 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. More...
static FORCEFIELDSCHEMA_API 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. More...

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::MultipleApplyAPI
	Compile time constant representing what kind of schema this class is. More...

Protected Member Functions
FORCEFIELDSCHEMA_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to. More...

Friends
class	UsdSchemaRegistry

Detailed Description

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

Definition at line 57 of file physxForceFieldWindAPI.h.

Constructor & Destructor Documentation

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

inlineexplicit

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

Definition at line 74 of file physxForceFieldWindAPI.h.

ForceFieldSchemaPhysxForceFieldWindAPI ( const UsdSchemaBase &  schemaObj, const TfToken &  name  )

inlineexplicit

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.

Definition at line 83 of file physxForceFieldWindAPI.h.

virtual FORCEFIELDSCHEMA_API ~ForceFieldSchemaPhysxForceFieldWindAPI ( )

virtual

Destructor.

Member Function Documentation

FORCEFIELDSCHEMA_API UsdSchemaKind _GetSchemaKind ( ) const

overrideprotected

Returns the kind of schema this class belongs to.

See Also

UsdSchemaKind

static FORCEFIELDSCHEMA_API ForceFieldSchemaPhysxForceFieldWindAPI Apply ( const UsdPrim &  prim, const TfToken &  name  )

static

Applies this multiple-apply API schema to the given prim along with the given instance name, name.

This information is stored by adding "PhysxForceFieldWindAPI:<i>name</i>" to the token-valued, listOp metadata apiSchemas on the prim. For example, if name is 'instance1', the token 'PhysxForceFieldWindAPI:instance1' is added to 'apiSchemas'.

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.

See Also

UsdPrim::GetAppliedSchemas()

UsdPrim::HasAPI()

UsdPrim::CanApplyAPI()

UsdPrim::ApplyAPI()

UsdPrim::RemoveAPI()

static FORCEFIELDSCHEMA_API bool CanApply ( const UsdPrim &  prim, const TfToken &  name, std::string *  whyNot = nullptr  )

static

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

UsdPrim::HasAPI()

UsdPrim::CanApplyAPI()

UsdPrim::ApplyAPI()

UsdPrim::RemoveAPI()

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

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

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

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

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

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

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

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

static

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 FORCEFIELDSCHEMA_API ForceFieldSchemaPhysxForceFieldWindAPI Get ( const UsdPrim &  prim, const TfToken &  name  )

static

Return a ForceFieldSchemaPhysxForceFieldWindAPI with name name holding the prim prim.

Shorthand for ForceFieldSchemaPhysxForceFieldWindAPI(prim, name);

static FORCEFIELDSCHEMA_API std::vector<ForceFieldSchemaPhysxForceFieldWindAPI> GetAll ( const UsdPrim &  prim )

static

Return a vector of all named instances of ForceFieldSchemaPhysxForceFieldWindAPI on the given prim.

FORCEFIELDSCHEMA_API UsdAttribute GetAverageDirectionAttr

(

)

const

The initial direction of the wind in the world coordinate system.

Wind direction changes are added to this base direciton.

Declaration	vector3f physxForceFieldWind:averageDirection = (0, 0, 0)
C++ Type	GfVec3f
Usd Type	SdfValueTypeNames->Vector3f

FORCEFIELDSCHEMA_API UsdAttribute GetAverageSpeedAttr

(

)

const

The average speed of the wind.

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

Declaration	float physxForceFieldWind:averageSpeed = 0
C++ Type	float
Usd Type	SdfValueTypeNames->Float

FORCEFIELDSCHEMA_API UsdAttribute GetDirectionVariationAttr

(

)

const

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

Declaration	float3 physxForceFieldWind:directionVariation = (0, 0, 0)
C++ Type	GfVec3f
Usd Type	SdfValueTypeNames->Float3

FORCEFIELDSCHEMA_API UsdAttribute GetDirectionVariationFrequencyAttr

(

)

const

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

Declaration	float3 physxForceFieldWind:directionVariationFrequency = (0, 0, 0)
C++ Type	GfVec3f
Usd Type	SdfValueTypeNames->Float3

FORCEFIELDSCHEMA_API UsdAttribute GetDragAttr

(

)

const

The drag coefficient determines how quickly the body moves along with the wind.

Smaller values cause the body to react more slowly.

Declaration	float physxForceFieldWind:drag = 0
C++ Type	float
Usd Type	SdfValueTypeNames->Float

TfToken GetName ( ) const

inline

Returns the name of this multiple-apply schema instance.

Definition at line 109 of file physxForceFieldWindAPI.h.

static FORCEFIELDSCHEMA_API const TfTokenVector& GetSchemaAttributeNames ( bool  includeInherited = true )

static

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 FORCEFIELDSCHEMA_API TfTokenVector GetSchemaAttributeNames ( bool  includeInherited, const TfToken &  instanceName  )

static

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.

FORCEFIELDSCHEMA_API UsdAttribute GetSpeedVariationAttr

(

)

const

The magnitude of the random changes of the wind speed.

Declaration	float physxForceFieldWind:speedVariation = 0
C++ Type	float
Usd Type	SdfValueTypeNames->Float

FORCEFIELDSCHEMA_API UsdAttribute GetSpeedVariationFrequencyAttr

(

)

const

The frequency of the random changes of the wind speed.

Declaration	float physxForceFieldWind:speedVariationFrequency = 0
C++ Type	float
Usd Type	SdfValueTypeNames->Float

static FORCEFIELDSCHEMA_API bool IsPhysxForceFieldWindAPIPath ( const SdfPath &  path, TfToken *  name  )

static

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 FORCEFIELDSCHEMA_API bool IsSchemaPropertyBaseName ( const TfToken &  baseName )

static

Checks if the given name baseName is the base name of a property of PhysxForceFieldWindAPI.

Member Data Documentation

const UsdSchemaKind schemaKind = UsdSchemaKind::MultipleApplyAPI

static

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

See Also

UsdSchemaKind

Definition at line 63 of file physxForceFieldWindAPI.h.

---

The documentation for this class was generated from the following file:

• C:/g/19412595/omni/schema/source/forceFieldSchema/physxForceFieldWindAPI.h