usdrt::PhysxSchemaPhysxSphereFillCollisionAPI

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

Functions

Variables

class PhysxSchemaPhysxSphereFillCollisionAPI : public usdrt::UsdAPISchemaBase

PhysX sphere fill extended parameters For any described attribute Fallback Value or Allowed Values below that are text/tokens, the actual token is published and defined in PhysxSchemaTokens. So to set an attribute to the value “rightHanded”, use PhysxSchemaTokens->rightHanded as the value.

Public Functions

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

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

inline explicit PhysxSchemaPhysxSphereFillCollisionAPI(const UsdSchemaBase &schemaObj)

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

inline virtual ~PhysxSchemaPhysxSphereFillCollisionAPI()

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 GetMaxSpheresAttr() const

Maximum of spheres produced. Range (2, 4000)

Declaration

int physxSphereFillCollision:maxSpheres = 128

C++ Type

int

Usd Type

SdfValueTypeNames->Int

inline UsdAttribute CreateMaxSpheresAttr() const

See GetMaxSpheresAttr(), 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 the algorithm. Range (10 000, 1 000 000)

Declaration

int physxSphereFillCollision:voxelResolution = 50000

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 GetSeedCountAttr() const

Seed count used for the algorithm. Range (16, 4000)

Declaration

int physxSphereFillCollision:seedCount = 1000

C++ Type

int

Usd Type

SdfValueTypeNames->Int

inline UsdAttribute CreateSeedCountAttr() const

See GetSeedCountAttr(), 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 GetFillModeAttr() const

Fill mode for the the algorithm.

Declaration

uniform token physxSphereFillCollision:fillMode = "flood"

C++ Type

TfToken

Usd Type

SdfValueTypeNames->Token

Variability

SdfVariabilityUniform

Allowed Values

flood, raycast, surface

inline UsdAttribute CreateFillModeAttr() const

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

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