usdrt::PhysxSchemaPhysxConvexDecompositionCollisionAPI

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

Functions

Variables

class PhysxSchemaPhysxConvexDecompositionCollisionAPI : public usdrt::UsdAPISchemaBase

PhysX convex decomposition extended parameters.

Public Functions

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

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

inline explicit PhysxSchemaPhysxConvexDecompositionCollisionAPI(const UsdSchemaBase &schemaObj)

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

inline virtual ~PhysxSchemaPhysxConvexDecompositionCollisionAPI()

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 physxConvexDecompositionCollision: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 GetMaxConvexHullsAttr() const

Maximum of convex hulls created during convex decomposition.

Declaration

int physxConvexDecompositionCollision:maxConvexHulls = 32

C++ Type

int

Usd Type

SdfValueTypeNames->Int

inline UsdAttribute CreateMaxConvexHullsAttr() const

See GetMaxConvexHullsAttr(), 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 min thickness. Range: [0, inf) Units: distance.

Declaration

float physxConvexDecompositionCollision: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.

inline UsdAttribute GetVoxelResolutionAttr() const

Voxel resolution used for convex decomposition.

Declaration

int physxConvexDecompositionCollision:voxelResolution = 500000

C++ Type

int

Usd Type

SdfValueTypeNames->Int

inline UsdAttribute CreateVoxelResolutionAttr() const

See GetVoxelResolutionAttr(), 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 GetErrorPercentageAttr() const

Convex decomposition errorPercentage parameter.

Declaration

float physxConvexDecompositionCollision:errorPercentage = 10

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateErrorPercentageAttr() const

See GetErrorPercentageAttr(), 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 GetShrinkWrapAttr() const

Attempts to adjust the convex hull points so that they are projected onto the surface of the original graphics mesh.

Declaration

bool physxConvexDecompositionCollision:shrinkWrap = 0

C++ Type

bool

Usd Type

SdfValueTypeNames->Bool

inline UsdAttribute CreateShrinkWrapAttr() const

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

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