defineCapsule

Fully qualified name: usdex::core::defineCapsule

pxr::UsdGeomCapsule usdex::core::defineCapsule(

pxr::UsdStagePtr stage,

const pxr::SdfPath &path,

const double radius = 1.0,

const double height = 2.0,

const pxr::TfToken axis = pxr::UsdGeomTokens->z,

const std::optional<pxr::GfVec3f> displayColor = std::nullopt,

const std::optional<float> displayOpacity = std::nullopt,

)

Defines a capsule primitive.

Defines a capsule of the specified radius and height at the origin. The height direction can be specified using axis as ‘X’, ‘Y’, or ‘Z’. The total height of the capsule is height + radius + radius.

Parameters:

• stage – The stage on which to define the capsule

• path – The absolute prim path at which to define the capsule

• radius – The radius of the capsule

• height – The height of the capsule shaft, excluding the end caps

• axis – The axis of the capsule

• displayColor – Values to be authored for the display color

• displayOpacity – Values to be authored for the display opacity

Returns:

UsdGeomCapsule schema wrapping the defined UsdPrim