All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdPhysicsCollisionAPI Class Reference

#include <collisionAPI.h>

+ Inheritance diagram for UsdPhysicsCollisionAPI:

Public Member Functions

 UsdPhysicsCollisionAPI (const UsdPrim &prim=UsdPrim())
 UsdPhysicsCollisionAPI (const UsdSchemaBase &schemaObj)
virtual USDPHYSICS_API ~UsdPhysicsCollisionAPI ()
 Destructor. More...
USDPHYSICS_API UsdAttribute GetCollisionEnabledAttr () const
USDPHYSICS_API UsdAttribute CreateCollisionEnabledAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDPHYSICS_API UsdRelationship GetSimulationOwnerRel () const
USDPHYSICS_API UsdRelationship CreateSimulationOwnerRel () const
- Public Member Functions inherited from UsdAPISchemaBase
 UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj)
virtual USD_API ~UsdAPISchemaBase ()=0
 Destructor. More...
- Public Member Functions inherited from UsdSchemaBase
bool IsConcrete () const
bool IsTyped () const
bool IsAPISchema () const
 Returns whether this is an API schema or not. More...
bool IsAppliedAPISchema () const
bool IsMultipleApplyAPISchema () const
UsdSchemaKind GetSchemaKind () const
 Returns the kind of schema this class is. More...
USD_API UsdSchemaBase (const UsdPrim &prim=UsdPrim())
 Construct and store prim as the held prim. More...
USD_API UsdSchemaBase (const UsdSchemaBase &otherSchema)
 Construct and store for the same prim held by otherSchema. More...
virtual USD_API ~UsdSchemaBase ()
 Destructor. More...
USD_API operator bool () const
UsdPrim GetPrim () const
 Return this schema object's held prim. More...
SdfPath GetPath () const
 Shorthand for GetPrim()->GetPath(). More...
USD_API const UsdPrimDefinitionGetSchemaClassPrimDefinition () const

Static Public Member Functions

static USDPHYSICS_API const
GetSchemaAttributeNames (bool includeInherited=true)
Get (const UsdStagePtr &stage, const SdfPath &path)
static USDPHYSICS_API bool CanApply (const UsdPrim &prim, std::string *whyNot=nullptr)
Apply (const UsdPrim &prim)
- Static Public Member Functions inherited from UsdAPISchemaBase
static USD_API const
GetSchemaAttributeNames (bool includeInherited=true)
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)

Static Public Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI
- Static Public Attributes inherited from UsdAPISchemaBase
static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractBase
- Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractBase

Protected Member Functions

USDPHYSICS_API UsdSchemaKind _GetSchemaKind () const override
- Protected Member Functions inherited from UsdAPISchemaBase
 UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)
const TfToken_GetInstanceName () const
USD_API bool _IsCompatible () const override
- 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


class UsdSchemaRegistry

Additional Inherited Members

- Static Protected Member Functions inherited from UsdAPISchemaBase
template<typename APISchemaType >
static APISchemaType _ApplyAPISchema (const UsdPrim &prim, const TfToken &apiSchemaName)
template<typename APISchemaType >
static APISchemaType _MultipleApplyAPISchema (const UsdPrim &prim, const TfToken &apiSchemaName, const TfToken &instanceName)

Detailed Description

Applies collision attributes to a UsdGeomXformable prim. If a simulation is running, this geometry will collide with other geometries that have PhysicsCollisionAPI applied. If a prim in the parent hierarchy has the RigidBodyAPI applied, this collider is a part of that body. If there is no body in the parent hierarchy, this collider is considered to be static.

Definition at line 61 of file collisionAPI.h.

Constructor & Destructor Documentation

UsdPhysicsCollisionAPI::UsdPhysicsCollisionAPI ( const UsdPrim prim = UsdPrim())

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

Definition at line 73 of file collisionAPI.h.

UsdPhysicsCollisionAPI::UsdPhysicsCollisionAPI ( const UsdSchemaBase schemaObj)

Construct a UsdPhysicsCollisionAPI on the prim held by schemaObj . Should be preferred over UsdPhysicsCollisionAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 81 of file collisionAPI.h.

virtual USDPHYSICS_API UsdPhysicsCollisionAPI::~UsdPhysicsCollisionAPI ( )


Member Function Documentation

USDPHYSICS_API UsdSchemaKind UsdPhysicsCollisionAPI::_GetSchemaKind ( ) const

Returns the kind of schema this class belongs to.

See Also

Reimplemented from UsdAPISchemaBase.

static USDPHYSICS_API UsdPhysicsCollisionAPI UsdPhysicsCollisionAPI::Apply ( const UsdPrim prim)

Applies this single-apply API schema to the given prim. This information is stored by adding "PhysicsCollisionAPI" to the token-valued, listOp metadata apiSchemas on the prim.

A valid UsdPhysicsCollisionAPI object is returned upon success. An invalid (or empty) UsdPhysicsCollisionAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.
See Also
static USDPHYSICS_API bool UsdPhysicsCollisionAPI::CanApply ( const UsdPrim prim,
std::string whyNot = nullptr 

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
USDPHYSICS_API UsdAttribute UsdPhysicsCollisionAPI::CreateCollisionEnabledAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetCollisionEnabledAttr(), 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 UsdRelationship UsdPhysicsCollisionAPI::CreateSimulationOwnerRel ( ) const

See GetSimulationOwnerRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create

static USDPHYSICS_API UsdPhysicsCollisionAPI UsdPhysicsCollisionAPI::Get ( const UsdStagePtr &  stage,
const SdfPath path 

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

USDPHYSICS_API UsdAttribute UsdPhysicsCollisionAPI::GetCollisionEnabledAttr ( ) const

Determines if the PhysicsCollisionAPI is enabled.

Declaration bool physics:collisionEnabled = 1
C++ Type bool
Usd Type SdfValueTypeNames->Bool
static USDPHYSICS_API const TfTokenVector& UsdPhysicsCollisionAPI::GetSchemaAttributeNames ( bool  includeInherited = true)

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.

USDPHYSICS_API UsdRelationship UsdPhysicsCollisionAPI::GetSimulationOwnerRel ( ) const

Single PhysicsScene that will simulate this collider. By default this object belongs to the first PhysicsScene. Note that if a RigidBodyAPI in the hierarchy above has a different simulationOwner then it has a precedence over this relationship.

Friends And Related Function Documentation

friend class UsdSchemaRegistry

Definition at line 159 of file collisionAPI.h.

Member Data Documentation

const UsdSchemaKind UsdPhysicsCollisionAPI::schemaKind = UsdSchemaKind::SingleApplyAPI

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

See Also

Definition at line 67 of file collisionAPI.h.

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