usdrt::PhysxSchemaPhysxSceneQuasistaticAPI

Defined in usdrt/scenegraph/usd/physxSchema/physxSceneQuasistaticAPI.h

class PhysxSchemaPhysxSceneQuasistaticAPI : public usdrt::UsdAPISchemaBase 

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.

Public Functions

inline explicit PhysxSchemaPhysxSceneQuasistaticAPI(const UsdPrim &prim = UsdPrim()): 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.

inline explicit PhysxSchemaPhysxSceneQuasistaticAPI(const UsdSchemaBase &schemaObj): Construct a PhysxSchemaPhysxSceneQuasistaticAPI on the prim held by schemaObj . Should be preferred over PhysxSchemaPhysxSceneQuasistaticAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

inline virtual ~PhysxSchemaPhysxSceneQuasistaticAPI(): Destructor.

inline UsdAttribute GetEnableQuasistaticAttr() const

Whether the actors should behave quasistatic or not.


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

inline UsdAttribute CreateEnableQuasistaticAttr() const: See GetEnableQuasistaticAttr(), and also Create vs Get Property Methods 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.

UsdPrim GetPrim() const: Return this schema object’s held prim.

SdfPath GetPath() const: Return the SdfPath to this schema object’s held prim.

inline explicit operator bool() const

Check if this schema object is compatible with it’s held prim and that the prim is valid.

A typed schema object is compatible if the held prim’s type is or is a subtype of the schema’s type. Based on prim.IsA().

An API schema object is compatible if the API is of type SingleApplyAPI or UsdSchemaType::MultipleApplyAPI, and the schema has been applied to the prim. Based on prim.HasAPI.

This method invokes polymorphic behaviour.

See also

UsdSchemaBase::_IsCompatible()

Returns: True if the help prim is valid, and the schema object is compatible with its held prim.

Public Static Functions

static inline PhysxSchemaPhysxSceneQuasistaticAPI Apply(const UsdPrim &prim)

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.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

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.

Public Static Attributes

static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI 

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

See also

UsdSchemaType

Protected Functions

inline const TfToken &_GetInstanceName() const

Returns the instance name of the API schema object belonging to a multiple-apply API schema.

The returned instance name will be empty for non-applied and single-apply API schemas.

inline virtual bool _IsCompatible() const

Check whether this APISchema object is valid for the currently held prim.

If this is an applied API schema, this returns true if the held prim is valid and already has the API schema applied to it, along with the instanceName (in the case of multiple-apply). The instanceName should not be empty in the case of a multiple-apply API schema.

This check is performed when clients invoke the explicit bool conversion operator, implemented in UsdSchemaBase.

See also

UsdPrim::HasAPI()

inline const TfToken _GetType() const

Helper for subclasses to get this schema’s type token.

Note

This diverges from Usd and returns a TfToken, since we don’t implements TfType.

Returns: The token representing the schema’s TfType.