usdrt::DestructionSchemaDestructibleBaseAPI

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

Functions

Variables

class DestructionSchemaDestructibleBaseAPI : public usdrt::UsdAPISchemaBase

Applies destructible attributes to any UsdGeomXformable prim and allows mesh descendants to be used to author destruction.

Public Functions

inline explicit DestructionSchemaDestructibleBaseAPI(const UsdPrim &prim = UsdPrim())

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

inline explicit DestructionSchemaDestructibleBaseAPI(const UsdSchemaBase &schemaObj)

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

inline virtual ~DestructionSchemaDestructibleBaseAPI()

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 UsdAttribute GetSupportDepthAttr() const

Desired chunk depth for support graph representation. Leaves that are shallower than this depth and non-leaves at this depth will be support chunks and may be bonded together using bonds. The setting will make leaf chunks the support chunks.

Declaration

int destruct:supportDepth = 2147483647

C++ Type

int

Usd Type

SdfValueTypeNames->Int

inline UsdAttribute CreateSupportDepthAttr() const

See GetSupportDepthAttr(), 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 GetDefaultBondStrengthAttr() const

Default value to use for all bonds in the destructible. If not authored, use individual bond strength values.

Declaration

float destruct:defaultBondStrength = -1

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateDefaultBondStrengthAttr() const

See GetDefaultBondStrengthAttr(), 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 GetDefaultChunkStrengthAttr() const

Default value to use for all chunks in the destructible. If not authored, use individual chunk strength values.

Declaration

float destruct:defaultChunkStrength = -1

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateDefaultChunkStrengthAttr() const

See GetDefaultChunkStrengthAttr(), 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 DestructionSchemaDestructibleBaseAPI Apply(const UsdPrim &prim)

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