Gives access to residual values that inform about the remaining physics solver error present during the last position and during the last velocity iteration. More...

Inherits UsdAPISchemaBase.

Public Member Functions
	PhysxSchemaPhysxResidualReportingAPI (const UsdPrim &prim=UsdPrim())
	Construct a PhysxSchemaPhysxResidualReportingAPI on UsdPrim `prim` . More...

	PhysxSchemaPhysxResidualReportingAPI (const UsdSchemaBase &schemaObj)
	Construct a PhysxSchemaPhysxResidualReportingAPI on the prim held by `schemaObj` . More...

virtual PHYSXSCHEMA_API	~PhysxSchemaPhysxResidualReportingAPI ()
	Destructor. More...

PHYSXSCHEMA_API UsdAttribute	GetPhysxResidualReportingRmsResidualPositionIterationAttr () const
	The RMS (root mean squared) magnitude of the physics solver error during the last position iteration. More...

PHYSXSCHEMA_API UsdAttribute	CreatePhysxResidualReportingRmsResidualPositionIterationAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetPhysxResidualReportingRmsResidualPositionIterationAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetPhysxResidualReportingMaxResidualPositionIterationAttr () const
	The maximal magnitude of the physics solver error during the last position iteration. More...

PHYSXSCHEMA_API UsdAttribute	CreatePhysxResidualReportingMaxResidualPositionIterationAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetPhysxResidualReportingMaxResidualPositionIterationAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetPhysxResidualReportingRmsResidualVelocityIterationAttr () const
	The RMS (root mean squared) magnitude of the physics solver error during the last velocity iteration. More...

PHYSXSCHEMA_API UsdAttribute	CreatePhysxResidualReportingRmsResidualVelocityIterationAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetPhysxResidualReportingRmsResidualVelocityIterationAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetPhysxResidualReportingMaxResidualVelocityIterationAttr () const
	The maximal magnitude of the physics solver error during the last velocity iteration. More...

PHYSXSCHEMA_API UsdAttribute	CreatePhysxResidualReportingMaxResidualVelocityIterationAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetPhysxResidualReportingMaxResidualVelocityIterationAttr(), 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 PhysxSchemaPhysxResidualReportingAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxResidualReportingAPI 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 PhysxSchemaPhysxResidualReportingAPI	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

Gives access to residual values that inform about the remaining physics solver error present during the last position and during the last velocity iteration.

The residual reporting must be enabled on the Physics Scene, otherwise the reported values will be zero. The API can be applied to either:

Joints. The joint residual will be reported.
Articulation Roots. The RMS (root mean squared) and max value over all articulation joint residuals will be reported.
Physics Scene. The RMS and max value over all error/residual sources (including contacts) will be reported.

Definition at line 62 of file physxResidualReportingAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxResidualReportingAPI ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxResidualReportingAPI on UsdPrim prim .

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

Definition at line 74 of file physxResidualReportingAPI.h.

PhysxSchemaPhysxResidualReportingAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxResidualReportingAPI on the prim held by schemaObj .

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

Definition at line 82 of file physxResidualReportingAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxResidualReportingAPI ( )

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 PhysxSchemaPhysxResidualReportingAPI Apply ( const UsdPrim & prim )

static

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

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

Returns: A valid PhysxSchemaPhysxResidualReportingAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxResidualReportingAPI 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 CreatePhysxResidualReportingMaxResidualPositionIterationAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetPhysxResidualReportingMaxResidualPositionIterationAttr(), 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 CreatePhysxResidualReportingMaxResidualVelocityIterationAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetPhysxResidualReportingMaxResidualVelocityIterationAttr(), 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 CreatePhysxResidualReportingRmsResidualPositionIterationAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetPhysxResidualReportingRmsResidualPositionIterationAttr(), 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 CreatePhysxResidualReportingRmsResidualVelocityIterationAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetPhysxResidualReportingRmsResidualVelocityIterationAttr(), 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 PhysxSchemaPhysxResidualReportingAPI Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

static

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

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

*

PHYSXSCHEMA_API UsdAttribute GetPhysxResidualReportingMaxResidualPositionIterationAttr ( ) const

The maximal magnitude of the physics solver error during the last position iteration.

Range: [0, inf) Units: dimensionless


Declaration	`float physxResidualReporting:maxResidualPositionIteration = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetPhysxResidualReportingMaxResidualVelocityIterationAttr ( ) const

The maximal magnitude of the physics solver error during the last velocity iteration.

Range: [0, inf) Units: dimensionless


Declaration	`float physxResidualReporting:maxResidualVelocityIteration = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetPhysxResidualReportingRmsResidualPositionIterationAttr ( ) const

The RMS (root mean squared) magnitude of the physics solver error during the last position iteration.

Range: [0, inf) Units: dimensionless


Declaration	`float physxResidualReporting:rmsResidualPositionIteration = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetPhysxResidualReportingRmsResidualVelocityIterationAttr ( ) const

The RMS (root mean squared) magnitude of the physics solver error during the last velocity iteration.

Range: [0, inf) Units: dimensionless


Declaration	`float physxResidualReporting:rmsResidualVelocityIteration = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

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.

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

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

C:/g/19412595/omni/schema/source/physxSchema/physxResidualReportingAPI.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation