All Classes Files Functions Variables Pages
UsdPhysicsScene Class Reference

Prim to define general physics simulation properties. More...

Inherits UsdTyped.

Public Member Functions

 UsdPhysicsScene (const UsdPrim &prim=UsdPrim())
 Construct a UsdPhysicsScene on UsdPrim prim . More...
 
 UsdPhysicsScene (const UsdSchemaBase &schemaObj)
 Construct a UsdPhysicsScene on the prim held by schemaObj . More...
 
virtual USDPHYSICS_API ~UsdPhysicsScene ()
 Destructor. More...
 
USDPHYSICS_API UsdAttribute GetGravityDirectionAttr () const
 Gravity direction vector in simulation world space. More...
 
USDPHYSICS_API UsdAttribute CreateGravityDirectionAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetGravityDirectionAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
 
USDPHYSICS_API UsdAttribute GetGravityMagnitudeAttr () const
 Gravity acceleration magnitude in simulation world space. More...
 
USDPHYSICS_API UsdAttribute CreateGravityMagnitudeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetGravityMagnitudeAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
 

Static Public Member Functions

static USDPHYSICS_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 USDPHYSICS_API
UsdPhysicsScene 
Get (const UsdStagePtr &stage, const SdfPath &path)
 Return a UsdPhysicsScene holding the prim adhering to this schema at path on stage. More...
 
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. More...
 

Static Public Attributes

static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped
 Compile time constant representing what kind of schema this class is. More...
 

Protected Member Functions

USDPHYSICS_API UsdSchemaType _GetSchemaType () const override
 Returns the type of schema this class belongs to. More...
 

Friends

class UsdSchemaRegistry
 

Detailed Description

Prim to define general physics simulation properties.

Definition at line 57 of file scene.h.

Constructor & Destructor Documentation

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 69 of file scene.h.

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 77 of file scene.h.

virtual USDPHYSICS_API ~UsdPhysicsScene ( )
virtual

Destructor.

Member Function Documentation

USDPHYSICS_API UsdSchemaType _GetSchemaType ( ) const
overrideprotected

Returns the type of schema this class belongs to.

See Also
UsdSchemaType
USDPHYSICS_API UsdAttribute CreateGravityDirectionAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetGravityDirectionAttr(), 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.

USDPHYSICS_API UsdAttribute CreateGravityMagnitudeAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetGravityMagnitudeAttr(), 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 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.

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));
*
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
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/time/time.

Declaration float physics:gravityMagnitude = -inf
C++ Type float
Usd Type SdfValueTypeNames->Float
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.

Member Data Documentation

const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped
static

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

See Also
UsdSchemaType

Definition at line 63 of file scene.h.


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