This document is for a version of USD that is under development. See this page for the current release.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
UsdPhysicsScene Class Reference

General physics simulation properties, required for simulation. More...

#include <scene.h>

+ Inheritance diagram for UsdPhysicsScene:

Public Member Functions

 UsdPhysicsScene (const UsdPrim &prim=UsdPrim())
 Construct a UsdPhysicsScene on UsdPrim prim .
 
 UsdPhysicsScene (const UsdSchemaBase &schemaObj)
 Construct a UsdPhysicsScene on the prim held by schemaObj .
 
virtual USDPHYSICS_API ~UsdPhysicsScene ()
 Destructor.
 
USDPHYSICS_API UsdAttribute GetGravityDirectionAttr () const
 Gravity direction vector in simulation world space.
 
USDPHYSICS_API UsdAttribute CreateGravityDirectionAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetGravityDirectionAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
 
USDPHYSICS_API UsdAttribute GetGravityMagnitudeAttr () const
 Gravity acceleration magnitude in simulation world space.
 
USDPHYSICS_API UsdAttribute CreateGravityMagnitudeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetGravityMagnitudeAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
 
- Public Member Functions inherited from UsdTyped
 UsdTyped (const UsdPrim &prim=UsdPrim())
 Construct a UsdTyped on UsdPrim prim .
 
 UsdTyped (const UsdSchemaBase &schemaObj)
 Construct a UsdTyped on the prim held by schemaObj .
 
virtual USD_API ~UsdTyped ()
 Destructor.
 
- Public Member Functions inherited from UsdSchemaBase
bool IsConcrete () const
 Returns whether or not this class corresponds to a concrete instantiable prim type in scene description.
 
bool IsTyped () const
 Returns whether or not this class inherits from UsdTyped.
 
bool IsAPISchema () const
 Returns whether this is an API schema or not.
 
bool IsAppliedAPISchema () const
 Returns whether this is an applied API schema or not.
 
bool IsMultipleApplyAPISchema () const
 Returns whether this is an applied API schema or not.
 
UsdSchemaKind GetSchemaKind () const
 Returns the kind of schema this class is.
 
USD_API UsdSchemaBase (const UsdPrim &prim=UsdPrim())
 Construct and store prim as the held prim.
 
USD_API UsdSchemaBase (const UsdSchemaBase &otherSchema)
 Construct and store for the same prim held by otherSchema.
 
virtual USD_API ~UsdSchemaBase ()
 Destructor.
 
UsdPrim GetPrim () const
 Return this schema object's held prim.
 
SdfPath GetPath () const
 Shorthand for GetPrim()->GetPath().
 
USD_API const UsdPrimDefinitionGetSchemaClassPrimDefinition () const
 Return the prim definition associated with this schema instance if one exists, otherwise return null.
 
USD_API operator bool () const
 Return true if this schema object is compatible with its held prim, false otherwise.
 

Static Public Member Functions

static USDPHYSICS_API const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.
 
static USDPHYSICS_API UsdPhysicsScene Get (const UsdStagePtr &stage, const SdfPath &path)
 Return a UsdPhysicsScene holding the prim adhering to this schema at path on stage.
 
static USDPHYSICS_API UsdPhysicsScene Define (const UsdStagePtr &stage, const SdfPath &path)
 Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.
 
- Static Public Member Functions inherited from UsdTyped
static USD_API const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.
 
static USD_API UsdTyped Get (const UsdStagePtr &stage, const SdfPath &path)
 Return a UsdTyped holding the prim adhering to this schema at path on stage.
 
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped
 Compile time constant representing what kind of schema this class is.
 
- Static Public Attributes inherited from UsdTyped
static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractBase
 Compile time constant representing what kind of schema this class is.
 
- Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractBase
 Compile time constant representing what kind of schema this class is.
 

Protected Member Functions

USDPHYSICS_API UsdSchemaKind _GetSchemaKind () const override
 Returns the kind of schema this class belongs to.
 
- Protected Member Functions inherited from UsdTyped
USD_API UsdSchemaKind _GetSchemaKind () const override
 Returns the kind of schema this class belongs to.
 
USD_API bool _IsCompatible () const override
 Subclasses may override _IsCompatible to do specific compatibility checking with the given prim, such as type compatibility or value compatibility.
 
- Protected Member Functions inherited from UsdSchemaBase
virtual UsdSchemaKind _GetSchemaType () const
 
const TfType_GetType () const
 
USD_API UsdAttribute _CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const
 

Friends

class UsdSchemaRegistry
 

Detailed Description

General physics simulation properties, required for simulation.

Definition at line 40 of file scene.h.

Constructor & Destructor Documentation

◆ UsdPhysicsScene() [1/2]

UsdPhysicsScene ( const UsdPrim prim = UsdPrim())
inlineexplicit

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

Definition at line 52 of file scene.h.

◆ UsdPhysicsScene() [2/2]

UsdPhysicsScene ( const UsdSchemaBase schemaObj)
inlineexplicit

Construct a UsdPhysicsScene on the prim held by schemaObj .

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

Definition at line 60 of file scene.h.

◆ ~UsdPhysicsScene()

virtual USDPHYSICS_API ~UsdPhysicsScene ( )
virtual

Destructor.

Member Function Documentation

◆ _GetSchemaKind()

USDPHYSICS_API UsdSchemaKind _GetSchemaKind ( ) const
overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See also
UsdSchemaKind

Reimplemented from UsdTyped.

◆ CreateGravityDirectionAttr()

USDPHYSICS_API UsdAttribute CreateGravityDirectionAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) 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.

◆ CreateGravityMagnitudeAttr()

USDPHYSICS_API UsdAttribute CreateGravityMagnitudeAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) 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.

◆ Define()

static USDPHYSICS_API UsdPhysicsScene Define ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.

If a prim adhering to this schema at path is already defined on this stage, return that prim. Otherwise author an SdfPrimSpec with specifier == SdfSpecifierDef and this schema's prim type name for the prim at path at the current EditTarget. Author SdfPrimSpec s with specifier == SdfSpecifierDef and empty typeName at the current EditTarget for any nonexistent, or existing but not Defined ancestors.

The given path must be an absolute prim path that does not contain any variant selections.

If it is impossible to author any of the necessary PrimSpecs, (for example, in case path cannot map to the current UsdEditTarget's namespace) issue an error and return an invalid UsdPrim.

Note that this method may return a defined prim whose typeName does not specify this schema class, in case a stronger typeName opinion overrides the opinion at the current EditTarget.

◆ Get()

static USDPHYSICS_API UsdPhysicsScene Get ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

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

UsdPhysicsScene(stage->GetPrimAtPath(path));
General physics simulation properties, required for simulation.
Definition: scene.h:41

◆ GetGravityDirectionAttr()

USDPHYSICS_API 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

◆ GetGravityMagnitudeAttr()

USDPHYSICS_API 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

◆ GetSchemaAttributeNames()

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

Friends And Related Function Documentation

◆ UsdSchemaRegistry

friend class UsdSchemaRegistry
friend

Definition at line 124 of file scene.h.

Member Data Documentation

◆ schemaKind

const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped
static

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

See also
UsdSchemaKind

Definition at line 46 of file scene.h.


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