usdrt::UsdPhysicsScene

Defined in usdrt/scenegraph/usd/usdPhysics/scene.h

Functions

usdrt::UsdPhysicsScene::CreateGravityDirectionAttr: See GetGravityDirectionAttr() , 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 .
usdrt::UsdPhysicsScene::CreateGravityMagnitudeAttr: See GetGravityMagnitudeAttr() , 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 .
usdrt::UsdPhysicsScene::Define: Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.
usdrt::UsdPhysicsScene::GetGravityDirectionAttr: Gravity direction vector in simulation world space. Will be normalized before use. A zero vector is a request to use the negative upAxis. Unitless.
usdrt::UsdPhysicsScene::GetGravityMagnitudeAttr: Gravity acceleration magnitude in simulation world space. A negative value is a request to use a value equivalent to earth gravity regardless of the metersPerUnit scaling used by this scene. Units: distance/second/second.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::UsdPhysicsScene::UsdPhysicsScene: Construct a UsdPhysicsScene on the prim held by schemaObj . Should be preferred over UsdPhysicsScene (schemaObj.GetPrim()), as it preserves SchemaBase state.
usdrt::UsdPhysicsScene::UsdPhysicsScene: Construct a UsdPhysicsScene on UsdPrim prim . Equivalent to UsdPhysicsScene::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim .
usdrt::UsdPhysicsScene::operator bool: Boolean operator.
usdrt::UsdPhysicsScene::~UsdPhysicsScene: Destructor.

Variables

usdrt::UsdPhysicsScene::schemaType: Compile time constant representing what kind of schema this class is.

class UsdPhysicsScene : public usdrt::UsdTyped 

General physics simulation properties, required for simulation.

Public Functions

inline explicit UsdPhysicsScene(const UsdPrim &prim = UsdPrim()): Construct a UsdPhysicsScene on UsdPrim prim. Equivalent to UsdPhysicsScene::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim.

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

inline virtual ~UsdPhysicsScene(): Destructor.

inline operator bool() const

Boolean operator.

Returns: Return true if the contained prim is an instance of this schema using IsA, and false otherwise.

inline UsdAttribute GetGravityDirectionAttr() const

Gravity direction vector in simulation world space. Will be normalized before use. A zero vector is a request to use the negative upAxis. Unitless.


Declaration	`vector3f physics:gravityDirection = (0, 0, 0)`
C++ Type	GfVec3f
Usd Type	SdfValueTypeNames->Vector3f

inline UsdAttribute CreateGravityDirectionAttr() const: See GetGravityDirectionAttr(), 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.

inline UsdAttribute GetGravityMagnitudeAttr() const

Gravity acceleration magnitude in simulation world space. A negative value is a request to use a value equivalent to earth gravity regardless of the metersPerUnit scaling used by this scene. Units: distance/second/second.


Declaration	`float physics:gravityMagnitude = -inf`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateGravityMagnitudeAttr() const: See GetGravityMagnitudeAttr(), 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.

Public Static Functions

static inline UsdPhysicsScene Define(const UsdStageRefPtr &stage, const SdfPath &path): Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.

Public Static Attributes

static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped 

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