usdrt::DestructionSchemaDestructibleChunkAPI

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

Functions

usdrt::DestructionSchemaDestructibleChunkAPI::Apply: Applies this single-apply API schema to the given prim . This information is stored by adding "DestructibleChunkAPI" to the token-valued, listOp metadata apiSchemas on the prim.
usdrt::DestructionSchemaDestructibleChunkAPI::CreateCentroidAttr: See GetCentroidAttr() , 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 .
usdrt::DestructionSchemaDestructibleChunkAPI::CreateParentChunkRel: See GetParentChunkRel() , and also Create vs Get Property Methods for when to use Get vs Create.
usdrt::DestructionSchemaDestructibleChunkAPI::CreateStrengthAttr: See GetStrengthAttr() , 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 .
usdrt::DestructionSchemaDestructibleChunkAPI::CreateVolumeAttr: See GetVolumeAttr() , 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 .
usdrt::DestructionSchemaDestructibleChunkAPI::DestructionSchemaDestructibleChunkAPI: Construct a DestructionSchemaDestructibleChunkAPI on the prim held by schemaObj . Should be preferred over DestructionSchemaDestructibleChunkAPI (schemaObj.GetPrim()), as it preserves SchemaBase state.
usdrt::DestructionSchemaDestructibleChunkAPI::DestructionSchemaDestructibleChunkAPI: Construct a DestructionSchemaDestructibleChunkAPI on UsdPrim prim . Equivalent to DestructionSchemaDestructibleChunkAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim .
usdrt::DestructionSchemaDestructibleChunkAPI::GetCentroidAttr: Optional chunk centroid. If not authored, it will be calculated from the chunk mesh.
usdrt::DestructionSchemaDestructibleChunkAPI::GetParentChunkRel: The parent chunk prim. If empty, this chunk is a root.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::DestructionSchemaDestructibleChunkAPI::GetStrengthAttr: The chunk's strength. Default value = -1.0. If negative, the chunk's volume will be used.
usdrt::DestructionSchemaDestructibleChunkAPI::GetVolumeAttr: Optional chunk volume. If not authored, it will be calculated from the chunk mesh.
usdrt::DestructionSchemaDestructibleBaseAPI::_GetInstanceName: Returns the instance name of the API schema object belonging to a multiple-apply API schema.
usdrt::DestructionSchemaDestructibleChunkAPI::operator bool: Boolean operator.
usdrt::DestructionSchemaDestructibleChunkAPI::~DestructionSchemaDestructibleChunkAPI: Destructor.

Variables

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

class DestructionSchemaDestructibleChunkAPI : public usdrt::UsdAPISchemaBase 

When applied to a UsdGeomMesh descendant of a prim with the DestructibleBaseAPI, this mesh will be considered part of a destructible hierarchy.

Public Functions

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

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

inline virtual ~DestructionSchemaDestructibleChunkAPI(): 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 GetCentroidAttr() const

Optional chunk centroid. If not authored, it will be calculated from the chunk mesh.


Declaration	`point3f destruct:centroid = (-inf, -inf, -inf)`
C++ Type	GfVec3f
Usd Type	SdfValueTypeNames->Point3f

inline UsdAttribute CreateCentroidAttr() const: See GetCentroidAttr(), 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 GetVolumeAttr() const

Optional chunk volume. If not authored, it will be calculated from the chunk mesh.


Declaration	`float destruct:volume = -inf`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateVolumeAttr() const: See GetVolumeAttr(), 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 GetStrengthAttr() const

The chunk’s strength. Default value = -1.0. If negative, the chunk’s volume will be used.


Declaration	`float destruct:strength = -1`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateStrengthAttr() const: See GetStrengthAttr(), 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 UsdRelationship GetParentChunkRel() const: The parent chunk prim. If empty, this chunk is a root.

inline UsdRelationship CreateParentChunkRel() const: See GetParentChunkRel(), 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 DestructionSchemaDestructibleChunkAPI Apply(const UsdPrim &prim)

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