usdrt::PhysxSchemaPhysxConvexHullCollisionAPI

Defined in usdrt/scenegraph/usd/physxSchema/physxConvexHullCollisionAPI.h

Functions

usdrt::PhysxSchemaPhysxConvexHullCollisionAPI::Apply: Applies this single-apply API schema to the given prim . This information is stored by adding "PhysxConvexHullCollisionAPI" to the token-valued, listOp metadata apiSchemas on the prim.
usdrt::PhysxSchemaPhysxConvexHullCollisionAPI::CreateHullVertexLimitAttr: See GetHullVertexLimitAttr() , 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::PhysxSchemaPhysxConvexHullCollisionAPI::CreateMinThicknessAttr: See GetMinThicknessAttr() , 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::PhysxSchemaPhysxConvexHullCollisionAPI::GetHullVertexLimitAttr: Convex hull vertex limit used for convex hull cooking.
usdrt::PhysxSchemaPhysxConvexHullCollisionAPI::GetMinThicknessAttr: Convex hull minimum thickness. Range: [0, inf) Units: distance.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::PhysxSchemaPhysxConvexHullCollisionAPI::PhysxSchemaPhysxConvexHullCollisionAPI: Construct a PhysxSchemaPhysxConvexHullCollisionAPI on the prim held by schemaObj . Should be preferred over PhysxSchemaPhysxConvexHullCollisionAPI (schemaObj.GetPrim()), as it preserves SchemaBase state.
usdrt::PhysxSchemaPhysxConvexHullCollisionAPI::PhysxSchemaPhysxConvexHullCollisionAPI: Construct a PhysxSchemaPhysxConvexHullCollisionAPI on UsdPrim prim . Equivalent to PhysxSchemaPhysxConvexHullCollisionAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim .
usdrt::DestructionSchemaDestructibleBaseAPI::_GetInstanceName: Returns the instance name of the API schema object belonging to a multiple-apply API schema.
usdrt::PhysxSchemaPhysxConvexHullCollisionAPI::operator bool: Boolean operator.
usdrt::PhysxSchemaPhysxConvexHullCollisionAPI::~PhysxSchemaPhysxConvexHullCollisionAPI: Destructor.

Variables

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

class PhysxSchemaPhysxConvexHullCollisionAPI : public usdrt::UsdAPISchemaBase 

PhysX convex hull collision extended parameters.

Public Functions

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

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

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

Convex hull vertex limit used for convex hull cooking.


Declaration	`int physxConvexHullCollision:hullVertexLimit = 64`
C++ Type	int
Usd Type	SdfValueTypeNames->Int

inline UsdAttribute CreateHullVertexLimitAttr() const: See GetHullVertexLimitAttr(), 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 GetMinThicknessAttr() const

Convex hull minimum thickness. Range: [0, inf) Units: distance.


Declaration	`float physxConvexHullCollision:minThickness = 0.001`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateMinThicknessAttr() const: See GetMinThicknessAttr(), 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 PhysxSchemaPhysxConvexHullCollisionAPI Apply(const UsdPrim &prim)

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