PhysxSceneQuasistaticAPI defines quasistatic mode for simulation. More...

Inherits UsdAPISchemaBase.

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

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

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

PHYSXSCHEMA_API UsdAttribute	GetEnableQuasistaticAttr () const
	Whether the actors should behave quasistatic or not. More...

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

PHYSXSCHEMA_API UsdCollectionAPI	GetQuasistaticActorsCollectionAPI () const
	Return the UsdCollectionAPI interface used for defining what prims belong to the quasistatic API. 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 PhysxSchemaPhysxSceneQuasistaticAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxSceneQuasistaticAPI 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 PhysxSchemaPhysxSceneQuasistaticAPI	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

PhysxSceneQuasistaticAPI defines quasistatic mode for simulation.

The API must be applied to a UsdPhysics.PhysicsScene prim.

In this mode actors are simulated/moved by the physics engine by obeying external forces and constraints as usual, but they do not accumulate momentum. So that e.g. falling due to gravity is with constant speed, and motion stops as soon as external forces cease to apply. There is no conservation of momentum.

By default all actors belonging to the scene have this behavior unless the collection does have the includes defined, then the collection definition does have a precendence.

Definition at line 70 of file physxSceneQuasistaticAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxSceneQuasistaticAPI ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxSceneQuasistaticAPI on UsdPrim prim .

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

Definition at line 82 of file physxSceneQuasistaticAPI.h.

PhysxSchemaPhysxSceneQuasistaticAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxSceneQuasistaticAPI on the prim held by schemaObj .

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

Definition at line 90 of file physxSceneQuasistaticAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxSceneQuasistaticAPI ( )

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

static

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

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

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

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

static

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

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

*

PHYSXSCHEMA_API UsdAttribute GetEnableQuasistaticAttr ( ) const

Whether the actors should behave quasistatic or not.


Declaration	`bool physxSceneQuasistatic:enableQuasistatic = 1`
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

PHYSXSCHEMA_API UsdCollectionAPI GetQuasistaticActorsCollectionAPI ( ) const

Return the UsdCollectionAPI interface used for defining what prims belong to the quasistatic API.

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 76 of file physxSceneQuasistaticAPI.h.

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

C:/g/19412595/omni/schema/source/physxSchema/physxSceneQuasistaticAPI.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