usdrt::DestructionSchemaDestructibleInstAPI

Defined in usdrt/scenegraph/usd/destructionSchema/destructibleInstAPI.h

Functions

usdrt::DestructionSchemaDestructibleInstAPI::Apply: Applies this single-apply API schema to the given prim . This information is stored by adding "DestructibleInstAPI" to the token-valued, listOp metadata apiSchemas on the prim.
usdrt::DestructionSchemaDestructibleInstAPI::CreateBaseRel: See GetBaseRel() , and also Create vs Get Property Methods for when to use Get vs Create.
usdrt::DestructionSchemaDestructibleInstAPI::DestructionSchemaDestructibleInstAPI: Construct a DestructionSchemaDestructibleInstAPI on the prim held by schemaObj . Should be preferred over DestructionSchemaDestructibleInstAPI (schemaObj.GetPrim()), as it preserves SchemaBase state.
usdrt::DestructionSchemaDestructibleInstAPI::DestructionSchemaDestructibleInstAPI: Construct a DestructionSchemaDestructibleInstAPI on UsdPrim prim . Equivalent to DestructionSchemaDestructibleInstAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim .
usdrt::DestructionSchemaDestructibleInstAPI::GetBaseRel: The referenced destructible base (see DestructibleBaseAPI).
usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::_GetInstanceName: Returns the instance name of the API schema object belonging to a multiple-apply API schema.
usdrt::DestructionSchemaDestructibleInstAPI::operator bool: Boolean operator.
usdrt::DestructionSchemaDestructibleInstAPI::~DestructionSchemaDestructibleInstAPI: Destructor.

Variables

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

class DestructionSchemaDestructibleInstAPI : public usdrt::UsdAPISchemaBase 

When applied to a UsdGeomXformable, it creates a destructible instance based off of the geometry and attributes defined by a referenced DestructibleBaseAPI.

Public Functions

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

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

inline virtual ~DestructionSchemaDestructibleInstAPI(): Destructor.

inline operator bool() const

Boolean operator.

Returns: Return true if the contained prim is has this api schema applied using HasAPI, and false otherwise.

inline UsdRelationship GetBaseRel() const: The referenced destructible base (see DestructibleBaseAPI).

inline UsdRelationship CreateBaseRel() const: See GetBaseRel(), and also Create vs Get Property Methods for when to use Get vs Create.

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 DestructionSchemaDestructibleInstAPI Apply(const UsdPrim &prim)

Applies this single-apply API schema to the given prim. This information is stored by adding “DestructibleInstAPI” 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 DestructionSchemaDestructibleInstAPI object is returned upon success. An invalid (or empty) DestructionSchemaDestructibleInstAPI 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.