ForceFieldSchemaPhysxForceFieldRingAPI Class Reference

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

Inherits UsdAPISchemaBase.

Public Member Functions
	ForceFieldSchemaPhysxForceFieldRingAPI (const UsdPrim &prim=UsdPrim(), const TfToken &name=TfToken())
	Construct a ForceFieldSchemaPhysxForceFieldRingAPI on UsdPrim prim with name name . More...
	ForceFieldSchemaPhysxForceFieldRingAPI (const UsdSchemaBase &schemaObj, const TfToken &name)
	Construct a ForceFieldSchemaPhysxForceFieldRingAPI on the prim held by schemaObj with name name. More...
virtual FORCEFIELDSCHEMA_API	~ForceFieldSchemaPhysxForceFieldRingAPI ()
	Destructor. More...
TfToken	GetName () const
	Returns the name of this multiple-apply schema instance. More...
FORCEFIELDSCHEMA_API UsdAttribute	GetNormalAxisAttr () const
	The normal axis through the center of the ring in world coordinates. More...
FORCEFIELDSCHEMA_API 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. More...
FORCEFIELDSCHEMA_API UsdAttribute	GetRadiusAttr () const
	The distance from the normal axis to the center of the ring. More...
FORCEFIELDSCHEMA_API 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. More...
FORCEFIELDSCHEMA_API UsdAttribute	GetConstantAttr () const
	constant applies a steady force that attracts bodies toward the ring. More...
FORCEFIELDSCHEMA_API 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. More...
FORCEFIELDSCHEMA_API UsdAttribute	GetLinearAttr () const
	linear applies a force that attracts bodies toward the ring and varies with distance to the ring. More...
FORCEFIELDSCHEMA_API 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. More...
FORCEFIELDSCHEMA_API 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. More...
FORCEFIELDSCHEMA_API 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. More...
FORCEFIELDSCHEMA_API UsdAttribute	GetSpinConstantAttr () const
	spinConstant applies a steady force that rotates bodies around the ring. More...
FORCEFIELDSCHEMA_API 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. More...
FORCEFIELDSCHEMA_API UsdAttribute	GetSpinLinearAttr () const
	spinLinear applies a force that rotates bodies around the ring and varies with distance to the ring. More...
FORCEFIELDSCHEMA_API 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. More...
FORCEFIELDSCHEMA_API 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. More...
FORCEFIELDSCHEMA_API 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. 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 ForceFieldSchemaPhysxForceFieldRingAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a ForceFieldSchemaPhysxForceFieldRingAPI holding the prim adhering to this schema at path on stage. More...
static FORCEFIELDSCHEMA_API ForceFieldSchemaPhysxForceFieldRingAPI	Get (const UsdPrim &prim, const TfToken &name)
	Return a ForceFieldSchemaPhysxForceFieldRingAPI with name name holding the prim prim. More...
static FORCEFIELDSCHEMA_API std::vector < ForceFieldSchemaPhysxForceFieldRingAPI >	GetAll (const UsdPrim &prim)
	Return a vector of all named instances of ForceFieldSchemaPhysxForceFieldRingAPI 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 PhysxForceFieldRingAPI. More...
static FORCEFIELDSCHEMA_API bool	IsPhysxForceFieldRingAPIPath (const SdfPath &path, TfToken *name)
	Checks if the given path path is of an API schema of type PhysxForceFieldRingAPI. 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 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. 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 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.

Definition at line 62 of file physxForceFieldRingAPI.h.

Constructor & Destructor Documentation

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

inlineexplicit

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

Definition at line 79 of file physxForceFieldRingAPI.h.

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

inlineexplicit

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.

Definition at line 88 of file physxForceFieldRingAPI.h.

virtual FORCEFIELDSCHEMA_API ~ForceFieldSchemaPhysxForceFieldRingAPI ( )

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 ForceFieldSchemaPhysxForceFieldRingAPI 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 "PhysxForceFieldRingAPI:<i>name</i>" to the token-valued, listOp metadata apiSchemas on the prim. For example, if name is 'instance1', the token 'PhysxForceFieldRingAPI:instance1' is added to 'apiSchemas'.

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.

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

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

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

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

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

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

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

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

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

static

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

static

Return a ForceFieldSchemaPhysxForceFieldRingAPI with name name holding the prim prim.

Shorthand for ForceFieldSchemaPhysxForceFieldRingAPI(prim, name);

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

static

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

FORCEFIELDSCHEMA_API UsdAttribute GetConstantAttr

(

)

const

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

Declaration	float physxForceFieldRing:constant = 0
C++ Type	float
Usd Type	SdfValueTypeNames->Float

FORCEFIELDSCHEMA_API 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 Type	SdfValueTypeNames->Float

FORCEFIELDSCHEMA_API 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 Type	SdfValueTypeNames->Float

TfToken GetName ( ) const

inline

Returns the name of this multiple-apply schema instance.

Definition at line 114 of file physxForceFieldRingAPI.h.

FORCEFIELDSCHEMA_API 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 Type	SdfValueTypeNames->Vector3f

FORCEFIELDSCHEMA_API UsdAttribute GetRadiusAttr

(

)

const

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

Declaration	float physxForceFieldRing:radius = 0
C++ Type	float
Usd Type	SdfValueTypeNames->Float

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 GetSpinConstantAttr

(

)

const

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

Declaration	float physxForceFieldRing:spinConstant = 0
C++ Type	float
Usd Type	SdfValueTypeNames->Float

FORCEFIELDSCHEMA_API 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 Type	SdfValueTypeNames->Float

FORCEFIELDSCHEMA_API 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 Type	SdfValueTypeNames->Float

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

static

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

static

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

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 68 of file physxForceFieldRingAPI.h.

---

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

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