PhysxSchemaPhysxForceAPI Class Reference

PhysX schema API that applies a force and torque to a rigid body (UsdGeom.Xformable with UsdPhysicsRigidBodyAPI). More...

Inherits UsdAPISchemaBase.

Public Member Functions
	PhysxSchemaPhysxForceAPI (const UsdPrim &prim=UsdPrim())
	Construct a PhysxSchemaPhysxForceAPI on UsdPrim prim . More...
	PhysxSchemaPhysxForceAPI (const UsdSchemaBase &schemaObj)
	Construct a PhysxSchemaPhysxForceAPI on the prim held by schemaObj . More...
virtual PHYSXSCHEMA_API	~PhysxSchemaPhysxForceAPI ()
	Destructor. More...
PHYSXSCHEMA_API UsdAttribute	GetForceEnabledAttr () const
	Boolean defining whether the force and torque are enabled or disabled. More...
PHYSXSCHEMA_API UsdAttribute	CreateForceEnabledAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetForceEnabledAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetWorldFrameEnabledAttr () const
	Boolean defining whether the force and torque are in world frame or in local frame. More...
PHYSXSCHEMA_API UsdAttribute	CreateWorldFrameEnabledAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetWorldFrameEnabledAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetModeAttr () const
	Force mode, can be either a force or an acceleration. More...
PHYSXSCHEMA_API UsdAttribute	CreateModeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetModeAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetForceAttr () const
	Force to apply defined in global or local frame depending on worldFrameEnabled. More...
PHYSXSCHEMA_API UsdAttribute	CreateForceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetForceAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetTorqueAttr () const
	Torque to apply defined in the global or local frame depending on worldFrameEnabled. More...
PHYSXSCHEMA_API UsdAttribute	CreateTorqueAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetTorqueAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

Static Public Member Functions
static PHYSXSCHEMA_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 PHYSXSCHEMA_API PhysxSchemaPhysxForceAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxForceAPI holding the prim adhering to this schema at path on stage. More...
static PHYSXSCHEMA_API bool	CanApply (const UsdPrim &prim, std::string *whyNot=nullptr)
	Returns true if this single-apply API schema can be applied to the given prim. More...
static PHYSXSCHEMA_API PhysxSchemaPhysxForceAPI	Apply (const UsdPrim &prim)
	Applies this single-apply API schema to the given prim. More...

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

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

Friends
class	UsdSchemaRegistry

Detailed Description

PhysX schema API that applies a force and torque to a rigid body (UsdGeom.Xformable with UsdPhysicsRigidBodyAPI).

The API can be applied to either:

• The rigid-body Xformable, in which case the force is applied at the body's center of mass.
• To an UsdGeom.Xformable that is a child of the rigid-body Xformable, in which case the force is applied at the location defined by the Xformable.

The worldFrameEnabled flag defines what coordinate frame the force and torque are expressed in. Note that any scale transform operations will only affect the force and torque values if on "acceleration" mode.

For any described attribute Fallback Value or Allowed Values below that are text/tokens, the actual token is published and defined in PhysxSchemaTokens. So to set an attribute to the value "rightHanded", use PhysxSchemaTokens->rightHanded as the value.

Definition at line 69 of file physxForceAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxForceAPI ( const UsdPrim &  prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxForceAPI on UsdPrim prim .

Equivalent to PhysxSchemaPhysxForceAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim

Definition at line 81 of file physxForceAPI.h.

PhysxSchemaPhysxForceAPI ( const UsdSchemaBase &  schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxForceAPI on the prim held by schemaObj .

Should be preferred over PhysxSchemaPhysxForceAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 89 of file physxForceAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxForceAPI ( )

virtual

Destructor.

Member Function Documentation

PHYSXSCHEMA_API UsdSchemaKind _GetSchemaKind ( ) const

overrideprotected

Returns the kind of schema this class belongs to.

See Also

UsdSchemaKind

static PHYSXSCHEMA_API PhysxSchemaPhysxForceAPI Apply ( const UsdPrim &  prim )

static

Applies this single-apply API schema to the given prim.

This information is stored by adding "PhysxForceAPI" to the token-valued, listOp metadata apiSchemas on the prim.

Returns

A valid PhysxSchemaPhysxForceAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxForceAPI 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 PHYSXSCHEMA_API bool CanApply ( const UsdPrim &  prim, std::string *  whyNot = nullptr  )

static

Returns true if this single-apply API schema can be applied to the given prim.

If this schema can not be a applied to 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()

PHYSXSCHEMA_API UsdAttribute CreateForceAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetForceAttr(), 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.

PHYSXSCHEMA_API UsdAttribute CreateForceEnabledAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetForceEnabledAttr(), 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.

PHYSXSCHEMA_API UsdAttribute CreateModeAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetModeAttr(), 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.

PHYSXSCHEMA_API UsdAttribute CreateTorqueAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetTorqueAttr(), 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.

PHYSXSCHEMA_API UsdAttribute CreateWorldFrameEnabledAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetWorldFrameEnabledAttr(), 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 PHYSXSCHEMA_API PhysxSchemaPhysxForceAPI Get ( const UsdStagePtr &  stage, const SdfPath &  path  )

static

Return a PhysxSchemaPhysxForceAPI 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. This is shorthand for the following:

*  PhysxSchemaPhysxForceAPI(stage->GetPrimAtPath(path));
*  

PHYSXSCHEMA_API UsdAttribute GetForceAttr

(

)

const

Force to apply defined in global or local frame depending on worldFrameEnabled.

The force is applied at the position defined by the relative transform to the parent rigid-body Xformable, or at the body's center of mass if the API is applied directly to a rigid-body Xformable. For units see mode attribute. Range: (-inf, inf)

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

PHYSXSCHEMA_API UsdAttribute GetForceEnabledAttr

(

)

const

Boolean defining whether the force and torque are enabled or disabled.

Declaration	bool physxForce:forceEnabled = 1
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

PHYSXSCHEMA_API UsdAttribute GetModeAttr

(

)

const

Force mode, can be either a force or an acceleration.

force - units: (linear) mass * distance / seconds^2, i.e. a force (angular) mass * distance * distance / time^2, i.e. a torque acceleration - units: (linear) distance / seconds^2, i.e. a linear acceleration. (angular) degrees / seconds^2, i.e. an angular acceleration.

Declaration	uniform token physxForce:mode = "acceleration"
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform
Allowed Values	force, acceleration

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

PHYSXSCHEMA_API UsdAttribute GetTorqueAttr

(

)

const

Torque to apply defined in the global or local frame depending on worldFrameEnabled.

For units see mode attribute. Range: (-inf, inf)

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

PHYSXSCHEMA_API UsdAttribute GetWorldFrameEnabledAttr

(

)

const

Boolean defining whether the force and torque are in world frame or in local frame.

Declaration	bool physxForce:worldFrameEnabled = 0
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

Member Data Documentation

const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI

static

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

See Also

UsdSchemaKind

Definition at line 75 of file physxForceAPI.h.

---

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

• C:/g/19412595/omni/schema/source/physxSchema/physxForceAPI.h